Component: FCD helper (Matrix Tools)

Author	Matrix Ltd
Version	1.0
Category	Matrix Tools

FCD helper component

A helper control to query the current Flowcode definition XML file.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	GetStrListItem
Gets a list item from a string index and a textual name Suitable for writing to a property filter Newline is added
- STRING	Index
- STRING	Name
- STRING	Return

	GetIntListItem
Gets a list item from an integer and a textual name Suitable for writing to a property filter Newline is added
- UINT	Index
- STRING	Name
- STRING	Return

	Register
Registers a property to update when the FCD changes
[[File:]] -	Dest
- STRING	PropName
- STRING	FCDPath
- UINT	INdex
A zero based index of the path to find
- STRING	IxAttr
- STRING	NameAttr
- VOID	Return

	GetPropertyList
Gets a filter list suitable for adding to a property Uses the [u]IxName[/u] as the index into the list Uses the [u]Text[/u] as the line to show in list-boxes
- STRING	FCDPath
- UINT	Index
A zero based index of the path to find
- STRING	IxName
- STRING	Text
- STRING	Return

	SetMarks
Decides on the presentation of the dial
[[File:]] -	Marks
Number of marks on the dial
[[File:]] -	Subs
Number of marks before a 'main' mark - can be zero
[[File:]] -	ShowNumbers
True to show numbers on the dial, else false
[[File:]] -	Return

	SetRange
Sets the min-max range to draw on the dial Used for setting the needle
[[File:]] -	Start
[[File:]] -	End
[[File:]] -	Return

	SetLabel
Sets the label to draw in the center of the dial
- STRING	Hi
- STRING	Lo
Label to draw at the bottom
[[File:]] -	Return

	SetPivotPos
Sets the position of the object the lever rotates around
[[File:]] -	PositionHandle
A handle to the position of the depressed location
- VOID	Return

	SetAutoReset
Sets the state of the auto-reset flag If the flag is true (it is by default) then Button Helper will reset the state of each button on stop
[[File:]] -	State
Set true to reset to off on sim stop, else false to retain state
- VOID	Return

	SetLatching
Sets whether the button is depressed when the mouse is released
[[File:]] -	Enabled
- VOID	Return

	Unregister
Removes the object to the list if present
[[File:]] -	Target
- VOID	Return

	SetMovementFor
Sets the movement in units or PI/16 steps for the button
[[File:]] -	Target
[[File:]] -	Move
Movement to set to, default 4
- VOID	Return

Property reference

	Properties
	Connections
	Simulations