Jump to content

Component: Button helper (Helpers): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,393 edits
No edit summary
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(12 intermediate revisions by 2 users not shown)
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here for the component source code: [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]


==Detailed description==
==Detailed description==




Line 28: Line 40:


==Examples==
==Examples==




Line 37: Line 59:




==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===Clear===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetStateFor'''
| width="90%" class="mtx-class-macrohead" | '''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''
|}
 
 
===GetState===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}
 
 
===GetStateFor===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''GetStateFor'''
|-
|-
| colspan="2" | Returns true if the button is depressed, else false 
| colspan="2" | Returns true if the button is depressed, else false 
Line 57: Line 118:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetTarget===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear'''
| width="90%" class="mtx-class-macrohead" | '''GetTarget'''
|-
|-
| colspan="2" | Clears all objects from the lists This leaves no links for the button helper 
| colspan="2" | Gets the target handle the property links to 
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Register===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDisabledPos'''
| width="90%" class="mtx-class-macrohead" | '''Register'''
|-
|-
| colspan="2" | Sets the position of the released button  
| colspan="2" | Adds the object to the list if not already there 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | PositionHandle
| width="90%" | Target
|-
|-
| colspan="2" | A handle to the position of the depressed location 
| colspan="2" |  
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 88: Line 151:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetAutoReset===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetEnabledPos'''
| width="90%" class="mtx-class-macrohead" | '''SetAutoReset'''
|-
|-
| colspan="2" | Sets the position of the depressed button  
| 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-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | PositionHandle
| width="90%" | State
|-
|-
| colspan="2" | A handle to the position of the depressed location 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 106: Line 170:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetAxis===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAxis'''
| width="90%" class="mtx-class-macrohead" | '''SetAxis'''
|-
|-
| colspan="2" | Sets the movement axis as an Axis_... constant 
| colspan="2" | Sets the movement axis as an Axis_... constant 
Line 124: Line 189:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetAxisFor===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDisabledPosFor'''
| width="90%" class="mtx-class-macrohead" | '''SetAxisFor'''
|-
|-
| colspan="2" | Sets the disabled position for an object 
| colspan="2" | Sets the movement axis as an Axis_... constant 
|-
|-
|-
|-
Line 137: Line 203:
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Position
| width="90%" | Axis
|-
|-
| colspan="2" |  
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 147: Line 213:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetDisabledPos===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTarget'''
| width="90%" class="mtx-class-macrohead" | '''SetDisabledPos'''
|-
|-
| colspan="2" | Gets the target handle the property links to 
| colspan="2" | Sets the position of the released button  
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | PositionHandle
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| colspan="2" | A handle to the position of the depressed location 
| 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-void-icon.png]] - VOID
|-
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetDisabledPosFor===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Register'''
| width="90%" class="mtx-class-macrohead" | '''SetDisabledPosFor'''
|-
|-
| colspan="2" | Adds the object to the list if not already there 
| colspan="2" | Sets the disabled position for an object 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Target
| width="90%" | Target
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Position
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 191: Line 256:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetEnabledPos===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetNotify'''
| width="90%" class="mtx-class-macrohead" | '''SetEnabledPos'''
|-
|-
| colspan="2" | Sets the object to notify when the button is pressed or released  
| colspan="2" | Sets the position of the depressed button  
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Handle
| width="90%" | PositionHandle
|-
|-
| colspan="2" | The handle of the object - 0 to use the caller object 
| colspan="2" | A handle to the position of the depressed location 
|-
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 214: Line 275:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetEnabledPosFor===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLatchingFor'''
| width="90%" class="mtx-class-macrohead" | '''SetEnabledPosFor'''
|-
|-
| colspan="2" | Sets whether the button is depressed when the mouse is released 
| colspan="2" | Sets the enabled position for an object 
|-
|-
|-
|-
Line 227: Line 289:
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Enabled
| width="90%" | Position
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 237: Line 299:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetLatching===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMode'''
| width="90%" class="mtx-class-macrohead" | '''SetLatching'''
|-
|-
| colspan="2" | Sets the animation mode for the button 
| colspan="2" | Sets whether the button is depressed when the mouse is released 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Mode
| width="90%" | Enabled
|-
|-
| colspan="2" | 0=User, 1=Up/Down, 2 = Lever 
| colspan="2" |  
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 255: Line 318:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetLatchingFor===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetEnabledPosFor'''
| width="90%" class="mtx-class-macrohead" | '''SetLatchingFor'''
|-
|-
| colspan="2" | Sets the enabled position for an object 
| colspan="2" | Sets whether the button is depressed when the mouse is released 
|-
|-
|-
|-
Line 268: Line 332:
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Position
| width="90%" | Enabled
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 278: Line 342:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetMode===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPivotPosFor'''
| width="90%" class="mtx-class-macrohead" | '''SetMode'''
|-
|-
| colspan="2" | Sets the position the lever rotates around for an object 
| colspan="2" | Sets the animation mode for the button 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Target
| width="90%" | Mode
|-
|-
| colspan="2" |  
| colspan="2" | 0=User, 1=Up/Down, 2 = Lever 
|-
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 301: Line 361:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetModeFor===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetModeFor'''
| width="90%" class="mtx-class-macrohead" | '''SetModeFor'''
|-
|-
| colspan="2" | Sets the animation mode for the button 
| colspan="2" | Sets the animation mode for the button 
Line 324: Line 385:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetMovement===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMovement'''
| width="90%" class="mtx-class-macrohead" | '''SetMovement'''
|-
|-
| colspan="2" | Sets the movement in units or PI/16 steps for the button 
| colspan="2" | Sets the movement in units or PI/16 steps for the button 
Line 342: Line 404:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetMovementFor===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAxisFor'''
| width="90%" class="mtx-class-macrohead" | '''SetMovementFor'''
|-
|-
| colspan="2" | Sets the movement axis as an Axis_... constant 
| colspan="2" | Sets the movement in units or PI/16 steps for the button 
|-
|-
|-
|-
Line 355: Line 418:
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Axis
| width="90%" | Move
|-
|-
| colspan="2" | Movement axis to set to, default 4 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 365: Line 428:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetNotify===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPivotPos'''
| width="90%" class="mtx-class-macrohead" | '''SetNotify'''
|-
|-
| colspan="2" | Sets the position of the object the lever rotates around  
| 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="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | PositionHandle
| 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" | A handle to the position of the depressed location 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 383: Line 452:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetPivotPos===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAutoReset'''
| width="90%" class="mtx-class-macrohead" | '''SetPivotPos'''
|-
|-
| 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  
| colspan="2" | Sets the position of the object the lever rotates around  
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | State
| width="90%" | PositionHandle
|-
|-
| colspan="2" | Set true to reset to off on sim stop, else false to retain state 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 401: Line 471:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetPivotPosFor===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLatching'''
| width="90%" class="mtx-class-macrohead" | '''SetPivotPosFor'''
|-
|-
| colspan="2" | Sets whether the button is depressed when the mouse is released 
| colspan="2" | Sets the position the lever rotates around for an object 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Enabled
| width="90%" | Target
|-
|-
| colspan="2" |  
| 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="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Target
| width="90%" | Position
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 437: Line 495:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Unregister===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMovementFor'''
| width="90%" class="mtx-class-macrohead" | '''Unregister'''
|-
|-
| colspan="2" | Sets the movement in units or PI/16 steps for the button 
| colspan="2" | Removes the object to the list if present 
|-
|-
|-
|-
Line 449: Line 508:
|-
|-
| colspan="2" |  
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-

Latest revision as of 14:22, 13 July 2026

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

Clear

Clear
Clears all objects from the lists This leaves no links for the button helper 
- VOID Return


GetState

GetState
Returns true if the button is depressed, else false 
- BOOL Return


GetStateFor

GetStateFor
Returns true if the button is depressed, else false 
- HANDLE Target
 
- BOOL Return


GetTarget

GetTarget
Gets the target handle the property links to 
- HANDLE Return


Register

Register
Adds the object to the list if not already there 
- HANDLE Target
 
- VOID Return


SetAutoReset

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  
- BOOL State
Set true to reset to off on sim stop, else false to retain state 
- VOID Return


SetAxis

SetAxis
Sets the movement axis as an Axis_... constant 
- BYTE Axis
Movement axis to set to, default 4 
- VOID Return


SetAxisFor

SetAxisFor
Sets the movement axis as an Axis_... constant 
- HANDLE Target
 
- BYTE Axis
Movement axis to set to, default 4 
- VOID Return


SetDisabledPos

SetDisabledPos
Sets the position of the released button  
- HANDLE PositionHandle
A handle to the position of the depressed location 
- VOID Return


SetDisabledPosFor

SetDisabledPosFor
Sets the disabled position for an object 
- HANDLE Target
 
- HANDLE Position
 
- VOID Return


SetEnabledPos

SetEnabledPos
Sets the position of the depressed button  
- HANDLE PositionHandle
A handle to the position of the depressed location 
- VOID Return


SetEnabledPosFor

SetEnabledPosFor
Sets the enabled position for an object 
- HANDLE Target
 
- HANDLE Position
 
- VOID Return


SetLatching

SetLatching
Sets whether the button is depressed when the mouse is released 
- BOOL Enabled
 
- VOID Return


SetLatchingFor

SetLatchingFor
Sets whether the button is depressed when the mouse is released 
- HANDLE Target
 
- BOOL Enabled
 
- VOID Return


SetMode

SetMode
Sets the animation mode for the button 
- BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
- VOID Return


SetModeFor

SetModeFor
Sets the animation mode for the button 
- HANDLE Target
The target object, 0 for 'set default' 
- BYTE Mode
0=User, 1=Up/Down, 2 = Lever 
- VOID Return


SetMovement

SetMovement
Sets the movement in units or PI/16 steps for the button 
- FLOAT Move
Movement to set to - default is 4 
- VOID Return


SetMovementFor

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


SetNotify

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


SetPivotPos

SetPivotPos
Sets the position of the object the lever rotates around  
- HANDLE PositionHandle
A handle to the position of the depressed location 
- VOID Return


SetPivotPosFor

SetPivotPosFor
Sets the position the lever rotates around for an object 
- HANDLE Target
 
- HANDLE Position
 
- VOID Return


Unregister

Unregister
Removes the object to the list if present 
- HANDLE Target
 
- VOID Return


Property reference

Properties
Host component
 
Lever pivot
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Button_helper_(Helpers)&oldid=46258"