Issie logo Issie

CatalogueView Module

Nested modules

Modules Description

Constants

Functions and values

Function or value Description

busCompareValueMessage w cVal

Full Usage: busCompareValueMessage w cVal

Parameters:
    w : int32
    cVal : bigint

Returns: ReactElement

two line message giving constant value

w : int32
cVal : bigint
Returns: ReactElement

compareModelsApprox m1 m2

Full Usage: compareModelsApprox m1 m2

Parameters:
Returns: bool
m1 : Model
m2 : Model
Returns: bool

constantValueMessage w cVal

Full Usage: constantValueMessage w cVal

Parameters:
    w : int32
    cVal : bigint

Returns: ReactElement

two line message giving constant value

w : int32
cVal : bigint
Returns: ReactElement

createCompStdLabel comp createParam model dispatch

Full Usage: createCompStdLabel comp createParam model dispatch

Parameters:
comp : ComponentType
createParam : (ComponentId -> Unit) option
model : Model
dispatch : Msg -> unit

createSheetDescriptionPopup model previousDescr sheetName dispatch

Full Usage: createSheetDescriptionPopup model previousDescr sheetName dispatch

Parameters:
    model : Model
    previousDescr : string option
    sheetName : string
    dispatch : Msg -> unit

Returns: Unit
model : Model
previousDescr : string option
sheetName : string
dispatch : Msg -> unit
Returns: Unit

createVerilogPopup model showExtraErrors correctedCode moduleName origin dispatch

Full Usage: createVerilogPopup model showExtraErrors correctedCode moduleName origin dispatch

Parameters:
    model : Model
    showExtraErrors : bool
    correctedCode : string option
    moduleName : string option
    origin : CodeEditorOpen
    dispatch : Msg -> unit

model : Model
showExtraErrors : bool
correctedCode : string option
moduleName : string option
origin : CodeEditorOpen
dispatch : Msg -> unit

libraryRowId libraryName

Full Usage: libraryRowId libraryName

Parameters:
    libraryName : string

Returns: string

The id a library's row in the catalogue carries. The name follows the prefix verbatim rather than being separated out later: a library is a directory, and a directory name may contain whatever the platform allows.

libraryName : string
Returns: string

menuItem styles label onClick

Full Usage: menuItem styles label onClick

Parameters:
Returns: ReactElement
styles : CSSProp list
label : string
onClick : MouseEvent -> unit
Returns: ReactElement

menuItemWithId elementId styles label onClick

Full Usage: menuItemWithId elementId styles label onClick

Parameters:
    elementId : string
    styles : CSSProp list
    label : string
    onClick : MouseEvent -> unit

Returns: ReactElement

As menuItem, carrying an id so that a right-click on the row can be told from a right-click on anything else. The id is what UpdateHelpers.getContextMenu matches on - it is handed the element under the pointer and nothing else, so a row that wants a context menu has to say what it is.

elementId : string
styles : CSSProp list
label : string
onClick : MouseEvent -> unit
Returns: ReactElement

parseBusCompareValue wMax w cText

Full Usage: parseBusCompareValue wMax w cText

Parameters:
    wMax : int
    w : int
    cText : string

Returns: ReactElement * ComponentType option
wMax : int
w : int
cText : string
Returns: ReactElement * ComponentType option

parseConstant wMax w cText

Full Usage: parseConstant wMax w cText

Parameters:
    wMax : int
    w : int
    cText : string

Returns: ReactElement * ComponentType option

check constant parameters and return two react lines with error message or value details.

wMax : int
w : int
cText : string
Returns: ReactElement * ComponentType option

startPlacingCustomComponent loadedComponent model dispatch

Full Usage: startPlacingCustomComponent loadedComponent model dispatch

Parameters:

Start placing an instance of a sheet. A sheet that declares parameters asks for a value for each of them first: placing without asking would silently freeze the sheet's defaults into the instance, which is exactly the stale-chain problem.

loadedComponent : LoadedComponent
model : Model
dispatch : Msg -> unit

viewCatalogue model dispatch

Full Usage: viewCatalogue model dispatch

Parameters:
Returns: ReactElement
model : Model
dispatch : Msg -> Unit
Returns: ReactElement

viewDragGhost model

Full Usage: viewDragGhost model

Parameters:
Returns: ReactElement

The component a catalogue drag is carrying, drawn following the cursor. This is the draw block's own drawing - createNewSymbol and drawComponent, the pair the canvas itself uses - and not a picture of one, so what is being carried cannot fall out of step with what will be placed: a symbol whose look depends on its ports, its size or the theme comes out right here for nothing, and stays right when that drawing changes. It is scaled by the sheet's zoom for the same reason. Nothing is added to any model. The symbol is built, drawn and discarded on each mouse move, which is what lets the popup still stand in front of the component being created. Carried over a component already on the sheet it is drawn red, because there it cannot be dropped - see ghostOverlaps.

model : Model
Returns: ReactElement

Type something to start searching.