Component: Button helper (Helpers): Difference between revisions
No edit summary |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/ | 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/ | 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 57: | Line 57: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| Line 68: | Line 72: | ||
===Clear=== | ===Clear=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 82: | Line 86: | ||
===GetState=== | ===GetState=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 96: | Line 100: | ||
===GetStateFor=== | ===GetStateFor=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 115: | Line 119: | ||
===GetTarget=== | ===GetTarget=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 129: | Line 133: | ||
===Register=== | ===Register=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 148: | Line 152: | ||
===SetAutoReset=== | ===SetAutoReset=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 167: | Line 171: | ||
===SetAxis=== | ===SetAxis=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 186: | Line 190: | ||
===SetAxisFor=== | ===SetAxisFor=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 210: | Line 214: | ||
===SetDisabledPos=== | ===SetDisabledPos=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 229: | Line 233: | ||
===SetDisabledPosFor=== | ===SetDisabledPosFor=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 253: | Line 257: | ||
===SetEnabledPos=== | ===SetEnabledPos=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 272: | Line 276: | ||
===SetEnabledPosFor=== | ===SetEnabledPosFor=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 296: | Line 300: | ||
===SetLatching=== | ===SetLatching=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 315: | Line 319: | ||
===SetLatchingFor=== | ===SetLatchingFor=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 339: | Line 343: | ||
===SetMode=== | ===SetMode=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 358: | Line 362: | ||
===SetModeFor=== | ===SetModeFor=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 382: | Line 386: | ||
===SetMovement=== | ===SetMovement=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 401: | Line 405: | ||
===SetMovementFor=== | ===SetMovementFor=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 425: | Line 429: | ||
===SetNotify=== | ===SetNotify=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 449: | Line 453: | ||
===SetPivotPos=== | ===SetPivotPos=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 468: | Line 472: | ||
===SetPivotPosFor=== | ===SetPivotPosFor=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 492: | Line 496: | ||
===Unregister=== | ===Unregister=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 508: | Line 512: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | 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 |