Component: Button helper (Helpers)
From Flowcode Help
Jump to navigationJump to searchAuthor | Matrix Ltd |
Version | 1.1 |
Category | Helpers |
Contents
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
GetStateFor | |
Returns true if the button is depressed, else false | |
- HANDLE | Target |
- BOOL | Return |
Clear | |
Clears all objects from the lists This leaves no links for the button helper | |
- VOID | Return |
SetDisabledPos | |
Sets the position of the released button | |
- HANDLE | PositionHandle |
A handle to the position of the depressed location | |
- VOID | Return |
SetEnabledPos | |
Sets the position of the depressed button | |
- HANDLE | PositionHandle |
A handle to the position of the depressed location | |
- VOID | Return |
SetAxis | |
Sets the movement axis as an Axis_... constant | |
- BYTE | Axis |
Movement axis to set to, default 4 | |
- VOID | Return |
SetDisabledPosFor | |
Sets the disabled position for an object | |
- HANDLE | Target |
- HANDLE | Position |
- VOID | Return |
GetTarget | |
Gets the target handle the property links to | |
- HANDLE | Return |
GetState | |
Returns true if the button is depressed, else false | |
- BOOL | Return |
Register | |
Adds the object to the list if not already there | |
- HANDLE | Target |
- VOID | Return |
SetLatchingFor | |
Sets whether the button is depressed when the mouse is released | |
- HANDLE | Target |
- BOOL | Enabled |
- VOID | Return |
SetMode | |
Sets the animation mode for the button | |
- BYTE | Mode |
0=User, 1=Up/Down, 2 = Lever | |
- VOID | Return |
SetEnabledPosFor | |
Sets the enabled position for an object | |
- HANDLE | Target |
- HANDLE | Position |
- VOID | Return |
SetPivotPosFor | |
Sets the position the lever rotates around for an object | |
- HANDLE | Target |
- HANDLE | Position |
- VOID | Return |
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 | |
Sets the movement in units or PI/16 steps for the button | |
- FLOAT | Move |
Movement to set to - default is 4 | |
- VOID | Return |
SetAxisFor | |
Sets the movement axis as an Axis_... constant | |
- HANDLE | Target |
- BYTE | Axis |
Movement axis to set to, default 4 | |
- VOID | Return |
SetPivotPos | |
Sets the position of the object the lever rotates around | |
- HANDLE | PositionHandle |
A handle to the position of the depressed location | |
- VOID | Return |
SetLatching | |
Sets whether the button is depressed when the mouse is released | |
- BOOL | Enabled |
- VOID | Return |
Unregister | |
Removes the object to the list if present | |
- HANDLE | Target |
- VOID | Return |
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 |
Property reference
Properties | |
Host component | |
Lever pivot | |