Component: Button helper (Advanced)
| Author | Matrix Ltd |
| Version | 1.1 (Release) |
| Category | Advanced |
Contents
- 1 Button helper component
- 2 Examples
- 3 Downloadable macro reference
- 4 Simulation macro reference
- 4.1 GetStateFor
- 4.2 Clear
- 4.3 SetDisabledPos
- 4.4 SetEnabledPos
- 4.5 SetAxis
- 4.6 SetDisabledPosFor
- 4.7 GetTarget
- 4.8 GetState
- 4.9 Register
- 4.10 SetNotify
- 4.11 SetLatchingFor
- 4.12 SetMode
- 4.13 SetEnabledPosFor
- 4.14 SetPivotPosFor
- 4.15 SetModeFor
- 4.16 SetMovement
- 4.17 SetAxisFor
- 4.18 SetPivotPos
- 4.19 SetAutoReset
- 4.20 SetLatching
- 4.21 Unregister
- 4.22 SetMovementFor
- 5 Property reference
Button helper component
A button overlay that allows any object to behave like a button
Examples
No additional examples
Downloadable macro reference
This component does not contain any downloadable macros
Simulation macro reference
GetStateFor
Returns true if the button is depressed, else false
Parameters
- HANDLE Target
Return value
- BOOL : Returns true if the operation is a success, else false
Clear
Clears all objects from the lists
This leaves no links for the button helper
Parameters
- This macro has no parameters
Return value
- This call does not return a value
SetDisabledPos
Sets the position of the released button
Parameters
- HANDLE PositionHandle
- A handle to the position of the depressed location
Return value
- This call does not return a value
SetEnabledPos
Sets the position of the depressed button
Parameters
- HANDLE PositionHandle
- A handle to the position of the depressed location
Return value
- This call does not return a value
SetAxis
Sets the movement axis as an Axis_... constant
Parameters
- BYTE Axis
- Movement axis to set to, default 4
Return value
- This call does not return a value
SetDisabledPosFor
Sets the disabled position for an object
Parameters
- HANDLE Target
- HANDLE Position
Return value
- This call does not return a value
GetTarget
Gets the target handle the property links to
Parameters
- This macro has no parameters
Return value
- HANDLE : The component linked to the control by property
GetState
Returns true if the button is depressed, else false
Parameters
- This macro has no parameters
Return value
- BOOL : Returns true if the operation is a success, else false
Register
Adds the object to the list if not already there
Parameters
- HANDLE Target
Return value
- This call does not return a value
SetNotify
Sets the object to notify when the button is pressed or released
Parameters
- HANDLE Handle
- The handle of the object - 0 to use the caller object
- ULONG Ident
- The identifier to send in the System.Notify message
Return value
- This call does not return a value
SetLatchingFor
Sets whether the button is depressed when the mouse is released
Parameters
- HANDLE Target
- BOOL Enabled
Return value
- This call does not return a value
SetMode
Sets the animation mode for the button
Parameters
- BYTE Mode
- 0=User, 1=Up/Down, 2 = Lever
Return value
- This call does not return a value
SetEnabledPosFor
Sets the enabled position for an object
Parameters
- HANDLE Target
- HANDLE Position
Return value
- This call does not return a value
SetPivotPosFor
Sets the position the lever rotates around for an object
Parameters
- HANDLE Target
- HANDLE Position
Return value
- This call does not return a value
SetModeFor
Sets the animation mode for the button
Parameters
- HANDLE Target
- The target object, 0 for 'set default'
- BYTE Mode
- 0=User, 1=Up/Down, 2 = Lever
Return value
- This call does not return a value
SetMovement
Sets the movement in units or PI/16 steps for the button
Parameters
- FLOAT Move
- Movement to set to - default is 4
Return value
- This call does not return a value
SetAxisFor
Sets the movement axis as an Axis_... constant
Parameters
- HANDLE Target
- BYTE Axis
- Movement axis to set to, default 4
Return value
- This call does not return a value
SetPivotPos
Sets the position of the object the lever rotates around
Parameters
- HANDLE PositionHandle
- A handle to the position of the depressed location
Return value
- This call does not return a value
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
Parameters
- BOOL State
- Set true to reset to off on sim stop, else false to retain state
Return value
- This call does not return a value
SetLatching
Sets whether the button is depressed when the mouse is released
Parameters
- BOOL Enabled
Return value
- This call does not return a value
Unregister
Removes the object to the list if present
Parameters
- HANDLE Target
Return value
- This call does not return a value
SetMovementFor
Sets the movement in units or PI/16 steps for the button
Parameters
- HANDLE Target
- FLOAT Move
- Movement to set to, default 4
Return value
- This call does not return a value
Property reference
Host component
This property is of type Panel object and can be referenced with the variable name Target.
No additional information
Lever pivot
This property is of type Panel object and can be referenced with the variable name Pivot.
No additional information
