Component: Button helper (Helpers)

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

GetStateFor

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

Clear

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

SetDisabledPos

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

SetEnabledPos

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

SetAxis

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

SetDisabledPosFor

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

GetTarget

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

GetState

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

Register

	Register
Adds the object to the list if not already there
- HANDLE	Target
- 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

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

SetEnabledPosFor

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

SetPivotPosFor

	SetPivotPosFor
Sets the position the lever rotates around for an object
- HANDLE	Target
- HANDLE	Position
- 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

SetAxisFor

	SetAxisFor
Sets the movement axis as an Axis_... constant
- HANDLE	Target
- BYTE	Axis
Movement axis to set to, default 4
- 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

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

SetLatching

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

Unregister

	Unregister
Removes the object to the list if present
- HANDLE	Target
- 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

Property reference

	Properties
	Host component
	Lever pivot