Difference between revisions of "Component: Button helper (Helpers)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_buttonhelper.fcfx FC_Comp_Source_buttonhelper.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_buttonhelper.fcfx FC_Comp_Source_buttonhelper.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_buttonhelper.fcfx FC_Comp_Source_buttonhelper.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_buttonhelper.fcfx FC_Comp_Source_buttonhelper.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 36: Line 38:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 52: Line 56:
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStateFor'''
 +
|-
 +
| colspan="2" | Returns true if the button is depressed, else false 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear'''
 +
|-
 +
| colspan="2" | Clears all objects from the lists This leaves no links for the button helper 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDisabledPos'''
 +
|-
 +
| colspan="2" | Sets the position of the released button  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | PositionHandle
 +
|-
 +
| colspan="2" | A handle to the position of the depressed location 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetEnabledPos'''
 +
|-
 +
| colspan="2" | Sets the position of the depressed button  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | PositionHandle
 +
|-
 +
| colspan="2" | A handle to the position of the depressed location 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAxis'''
 +
|-
 +
| colspan="2" | Sets the movement axis as an Axis_... constant 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Axis
 +
|-
 +
| colspan="2" | Movement axis to set to, default 4 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDisabledPosFor'''
 +
|-
 +
| colspan="2" | Sets the disabled position for an object 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Position
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTarget'''
 +
|-
 +
| colspan="2" | Gets the target handle the property links to 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetState'''
 +
|-
 +
| colspan="2" | Returns true if the button is depressed, else false 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Register'''
 +
|-
 +
| colspan="2" | Adds the object to the list if not already there 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetNotify'''
 +
|-
 +
| colspan="2" | Sets the object to notify when the button is pressed or released  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Handle
 +
|-
 +
| colspan="2" | The handle of the object - 0 to use the caller object 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Ident
 +
|-
 +
| colspan="2" | The identifier to send in the System.Notify message 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLatchingFor'''
 +
|-
 +
| colspan="2" | Sets whether the button is depressed when the mouse is released 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Enabled
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMode'''
 +
|-
 +
| colspan="2" | Sets the animation mode for the button 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Mode
 +
|-
 +
| colspan="2" | 0=User, 1=Up/Down, 2 = Lever 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetEnabledPosFor'''
 +
|-
 +
| colspan="2" | Sets the enabled position for an object 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Position
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPivotPosFor'''
 +
|-
 +
| colspan="2" | Sets the position the lever rotates around for an object 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Position
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetModeFor'''
 +
|-
 +
| colspan="2" | Sets the animation mode for the button 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | The target object, 0 for 'set default' 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Mode
 +
|-
 +
| colspan="2" | 0=User, 1=Up/Down, 2 = Lever 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMovement'''
 +
|-
 +
| colspan="2" | Sets the movement in units or PI/16 steps for the button 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Move
 +
|-
 +
| colspan="2" | Movement to set to - default is 4 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAxisFor'''
 +
|-
 +
| colspan="2" | Sets the movement axis as an Axis_... constant 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Axis
 +
|-
 +
| colspan="2" | Movement axis to set to, default 4 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPivotPos'''
 +
|-
 +
| colspan="2" | Sets the position of the object the lever rotates around  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | PositionHandle
 +
|-
 +
| colspan="2" | A handle to the position of the depressed location 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAutoReset'''
 +
|-
 +
| colspan="2" | 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  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | Set true to reset to off on sim stop, else false to retain state 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLatching'''
 +
|-
 +
| colspan="2" | Sets whether the button is depressed when the mouse is released 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Enabled
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Unregister'''
 +
|-
 +
| colspan="2" | Removes the object to the list if present 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMovementFor'''
 +
|-
 +
| colspan="2" | Sets the movement in units or PI/16 steps for the button 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Move
 +
|-
 +
| colspan="2" | Movement to set to, default 4 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
 +
| width="90%" | Host component
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
 +
| width="90%" | Lever pivot
 +
|-
 +
| colspan="2" |  
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 10:01, 27 January 2023

Author Matrix Ltd
Version 1.1
Category Helpers


Button helper component

A button overlay that allows any object to behave like a button

Component Source Code

Please click here to download the component source project: FC_Comp_Source_buttonhelper.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_buttonhelper.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Macro reference

Fc9-comp-macro.png GetStateFor
Returns true if the button is depressed, else false 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png Clear
Clears all objects from the lists This leaves no links for the button helper 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisabledPos
Sets the position of the released button  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetEnabledPos
Sets the position of the depressed button  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetAxis
Sets the movement axis as an Axis_... constant 
Fc9-u8-icon.png - BYTE Axis
Movement axis to set to, default 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisabledPosFor
Sets the disabled position for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetTarget
Gets the target handle the property links to 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png GetState
Returns true if the button is depressed, else false 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png Register
Adds the object to the list if not already there 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetNotify
Sets the object to notify when the button is pressed or released  
Fc9-h32-icon.png - HANDLE Handle
The handle of the object - 0 to use the caller object 
Fc9-u32-icon.png - ULONG Ident
The identifier to send in the System.Notify message 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLatchingFor
Sets whether the button is depressed when the mouse is released 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-bool-icon.png - BOOL Enabled
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMode
Sets the animation mode for the button 
Fc9-u8-icon.png - BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetEnabledPosFor
Sets the enabled position for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetPivotPosFor
Sets the position the lever rotates around for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetModeFor
Sets the animation mode for the button 
Fc9-h32-icon.png - HANDLE Target
The target object, 0 for 'set default' 
Fc9-u8-icon.png - BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMovement
Sets the movement in units or PI/16 steps for the button 
Fc9-f32-icon.png - FLOAT Move
Movement to set to - default is 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetAxisFor
Sets the movement axis as an Axis_... constant 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-u8-icon.png - BYTE Axis
Movement axis to set to, default 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetPivotPos
Sets the position of the object the lever rotates around  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-bool-icon.png - BOOL State
Set true to reset to off on sim stop, else false to retain state 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLatching
Sets whether the button is depressed when the mouse is released 
Fc9-bool-icon.png - BOOL Enabled
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Unregister
Removes the object to the list if present 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMovementFor
Sets the movement in units or PI/16 steps for the button 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-f32-icon.png - FLOAT Move
Movement to set to, default 4 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png Host component
 
Fc9-type-17-icon.png Lever pivot
 

==Macro reference==

Fc9-comp-macro.png GetStateFor
Returns true if the button is depressed, else false 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png Clear
Clears all objects from the lists This leaves no links for the button helper 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisabledPos
Sets the position of the released button  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetEnabledPos
Sets the position of the depressed button  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetAxis
Sets the movement axis as an Axis_... constant 
Fc9-u8-icon.png - BYTE Axis
Movement axis to set to, default 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisabledPosFor
Sets the disabled position for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetTarget
Gets the target handle the property links to 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png GetState
Returns true if the button is depressed, else false 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png Register
Adds the object to the list if not already there 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetNotify
Sets the object to notify when the button is pressed or released  
Fc9-h32-icon.png - HANDLE Handle
The handle of the object - 0 to use the caller object 
Fc9-u32-icon.png - ULONG Ident
The identifier to send in the System.Notify message 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLatchingFor
Sets whether the button is depressed when the mouse is released 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-bool-icon.png - BOOL Enabled
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMode
Sets the animation mode for the button 
Fc9-u8-icon.png - BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetEnabledPosFor
Sets the enabled position for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetPivotPosFor
Sets the position the lever rotates around for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetModeFor
Sets the animation mode for the button 
Fc9-h32-icon.png - HANDLE Target
The target object, 0 for 'set default' 
Fc9-u8-icon.png - BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMovement
Sets the movement in units or PI/16 steps for the button 
Fc9-f32-icon.png - FLOAT Move
Movement to set to - default is 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetAxisFor
Sets the movement axis as an Axis_... constant 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-u8-icon.png - BYTE Axis
Movement axis to set to, default 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetPivotPos
Sets the position of the object the lever rotates around  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-bool-icon.png - BOOL State
Set true to reset to off on sim stop, else false to retain state 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLatching
Sets whether the button is depressed when the mouse is released 
Fc9-bool-icon.png - BOOL Enabled
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Unregister
Removes the object to the list if present 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMovementFor
Sets the movement in units or PI/16 steps for the button 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-f32-icon.png - FLOAT Move
Movement to set to, default 4 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png Host component
 
Fc9-type-17-icon.png Lever pivot
 

==Macro reference==

Fc9-comp-macro.png GetStateFor
Returns true if the button is depressed, else false 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png Clear
Clears all objects from the lists This leaves no links for the button helper 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisabledPos
Sets the position of the released button  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetEnabledPos
Sets the position of the depressed button  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetAxis
Sets the movement axis as an Axis_... constant 
Fc9-u8-icon.png - BYTE Axis
Movement axis to set to, default 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisabledPosFor
Sets the disabled position for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetTarget
Gets the target handle the property links to 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png GetState
Returns true if the button is depressed, else false 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png Register
Adds the object to the list if not already there 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetNotify
Sets the object to notify when the button is pressed or released  
Fc9-h32-icon.png - HANDLE Handle
The handle of the object - 0 to use the caller object 
Fc9-u32-icon.png - ULONG Ident
The identifier to send in the System.Notify message 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLatchingFor
Sets whether the button is depressed when the mouse is released 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-bool-icon.png - BOOL Enabled
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMode
Sets the animation mode for the button 
Fc9-u8-icon.png - BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetEnabledPosFor
Sets the enabled position for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetPivotPosFor
Sets the position the lever rotates around for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetModeFor
Sets the animation mode for the button 
Fc9-h32-icon.png - HANDLE Target
The target object, 0 for 'set default' 
Fc9-u8-icon.png - BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMovement
Sets the movement in units or PI/16 steps for the button 
Fc9-f32-icon.png - FLOAT Move
Movement to set to - default is 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetAxisFor
Sets the movement axis as an Axis_... constant 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-u8-icon.png - BYTE Axis
Movement axis to set to, default 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetPivotPos
Sets the position of the object the lever rotates around  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-bool-icon.png - BOOL State
Set true to reset to off on sim stop, else false to retain state 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLatching
Sets whether the button is depressed when the mouse is released 
Fc9-bool-icon.png - BOOL Enabled
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Unregister
Removes the object to the list if present 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMovementFor
Sets the movement in units or PI/16 steps for the button 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-f32-icon.png - FLOAT Move
Movement to set to, default 4 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png Host component
 
Fc9-type-17-icon.png Lever pivot
 

==Macro reference==

Fc9-comp-macro.png GetStateFor
Returns true if the button is depressed, else false 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png Clear
Clears all objects from the lists This leaves no links for the button helper 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisabledPos
Sets the position of the released button  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetEnabledPos
Sets the position of the depressed button  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetAxis
Sets the movement axis as an Axis_... constant 
Fc9-u8-icon.png - BYTE Axis
Movement axis to set to, default 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisabledPosFor
Sets the disabled position for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetTarget
Gets the target handle the property links to 
Fc9-h32-icon.png - HANDLE Return


Fc9-comp-macro.png GetState
Returns true if the button is depressed, else false 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png Register
Adds the object to the list if not already there 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetNotify
Sets the object to notify when the button is pressed or released  
Fc9-h32-icon.png - HANDLE Handle
The handle of the object - 0 to use the caller object 
Fc9-u32-icon.png - ULONG Ident
The identifier to send in the System.Notify message 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLatchingFor
Sets whether the button is depressed when the mouse is released 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-bool-icon.png - BOOL Enabled
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMode
Sets the animation mode for the button 
Fc9-u8-icon.png - BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetEnabledPosFor
Sets the enabled position for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetPivotPosFor
Sets the position the lever rotates around for an object 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-h32-icon.png - HANDLE Position
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetModeFor
Sets the animation mode for the button 
Fc9-h32-icon.png - HANDLE Target
The target object, 0 for 'set default' 
Fc9-u8-icon.png - BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMovement
Sets the movement in units or PI/16 steps for the button 
Fc9-f32-icon.png - FLOAT Move
Movement to set to - default is 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetAxisFor
Sets the movement axis as an Axis_... constant 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-u8-icon.png - BYTE Axis
Movement axis to set to, default 4 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetPivotPos
Sets the position of the object the lever rotates around  
Fc9-h32-icon.png - HANDLE PositionHandle
A handle to the position of the depressed location 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-bool-icon.png - BOOL State
Set true to reset to off on sim stop, else false to retain state 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetLatching
Sets whether the button is depressed when the mouse is released 
Fc9-bool-icon.png - BOOL Enabled
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Unregister
Removes the object to the list if present 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetMovementFor
Sets the movement in units or PI/16 steps for the button 
Fc9-h32-icon.png - HANDLE Target
 
Fc9-f32-icon.png - FLOAT Move
Movement to set to, default 4 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png Host component
 
Fc9-type-17-icon.png Lever pivot
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Button_helper_(Helpers)&oldid=34636"