Jump to content

Component: Button helper (Helpers): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,393 edits
m Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;" align="center"" to "width="10%" align="center" class="mtx-class-macrohead""
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(One intermediate revision by the same user not shown)
Line 75: Line 75:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''Clear'''
|-
|-
| colspan="2" | Clears all objects from the lists This leaves no links for the button helper 
| colspan="2" | Clears all objects from the lists This leaves no links for the button helper 
Line 89: Line 89:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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;" | '''GetState'''
| width="90%" class="mtx-class-macrohead" | '''GetState'''
|-
|-
| colspan="2" | Returns true if the button is depressed, else false 
| colspan="2" | Returns true if the button is depressed, else false 
Line 103: Line 103:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''GetStateFor'''
|-
|-
| colspan="2" | Returns true if the button is depressed, else false 
| colspan="2" | Returns true if the button is depressed, else false 
Line 122: Line 122:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''GetTarget'''
|-
|-
| colspan="2" | Gets the target handle the property links to 
| colspan="2" | Gets the target handle the property links to 
Line 136: Line 136:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''Register'''
|-
|-
| colspan="2" | Adds the object to the list if not already there 
| colspan="2" | Adds the object to the list if not already there 
Line 155: Line 155:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''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  
| 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  
Line 174: Line 174:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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 193: Line 193:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetAxisFor'''
|-
|-
| colspan="2" | Sets the movement axis as an Axis_... constant 
| colspan="2" | Sets the movement axis as an Axis_... constant 
Line 217: Line 217:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetDisabledPos'''
|-
|-
| colspan="2" | Sets the position of the released button  
| colspan="2" | Sets the position of the released button  
Line 236: Line 236:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetDisabledPosFor'''
|-
|-
| colspan="2" | Sets the disabled position for an object 
| colspan="2" | Sets the disabled position for an object 
Line 260: Line 260:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetEnabledPos'''
|-
|-
| colspan="2" | Sets the position of the depressed button  
| colspan="2" | Sets the position of the depressed button  
Line 279: Line 279:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetEnabledPosFor'''
|-
|-
| colspan="2" | Sets the enabled position for an object 
| colspan="2" | Sets the enabled position for an object 
Line 303: Line 303:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetLatching'''
|-
|-
| colspan="2" | Sets whether the button is depressed when the mouse is released 
| colspan="2" | Sets whether the button is depressed when the mouse is released 
Line 322: Line 322:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetLatchingFor'''
|-
|-
| colspan="2" | Sets whether the button is depressed when the mouse is released 
| colspan="2" | Sets whether the button is depressed when the mouse is released 
Line 346: Line 346:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetMode'''
|-
|-
| colspan="2" | Sets the animation mode for the button 
| colspan="2" | Sets the animation mode for the button 
Line 365: Line 365:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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 389: Line 389:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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 408: Line 408:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetMovementFor'''
|-
|-
| 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 432: Line 432:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetNotify'''
|-
|-
| colspan="2" | Sets the object to notify when the button is pressed or released  
| colspan="2" | Sets the object to notify when the button is pressed or released  
Line 456: Line 456:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetPivotPos'''
|-
|-
| colspan="2" | Sets the position of the object the lever rotates around  
| colspan="2" | Sets the position of the object the lever rotates around  
Line 475: Line 475:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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" | '''SetPivotPosFor'''
|-
|-
| colspan="2" | Sets the position the lever rotates around for an object 
| colspan="2" | Sets the position the lever rotates around for an object 
Line 499: Line 499:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[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;" | '''Unregister'''
| width="90%" class="mtx-class-macrohead" | '''Unregister'''
|-
|-
| colspan="2" | Removes the object to the list if present 
| colspan="2" | Removes the object to the list if present 
Line 518: Line 518:
{| class="mtx-class-macrotable wikitable"
{| 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"