Package RASCAL.ToolboxActionButton

Description	ToolboxActionButton types and methods.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
RASCAL.Utility
RASCAL.Toolbox
RASCAL.OS
System.Unsigned_Types
System

Use clauses
RASCAL.Utility
RASCAL.Toolbox
RASCAL.OS
System.Unsigned_Types
System

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
ActionButton_Is_Default		16#1#	constant
Flags
ActionButton_Is_Cancel		16#2#	constant
ActionButton_Is_Local		16#4#	constant
ActionButton_ClickShowTransient		16#8#	constant
ActionButton_ClickShowCentred		16#10#	constant
ActionButton_ClickShowAtPointer		16#10#	constant
ActionButton_Selected_Adjust		16#1#	constant
ActionButton_Selected_Select		16#4#	constant
ActionButton_Selected_Default		16#8#	constant
ActionButton_Selected_Cancel		16#10#	constant
ActionButton_Selected_Local		16#20#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
ActionButton_Show_Type	(Persistent, Transient)
ActionButton_Click_Type	(Select_Click, Key_Pressed, Adjust_Click)
ActionButton_Button_Type	(Default, Cancel, Local)
Toolbox_ActionButton_Selected_Pointer	access Toolbox_ActionButton_Selected

ActionButtonTemplate	record
*Component*	*Type*	*Default*
Event	System.Unsigned_Types.Unsigned
Click_Show	Address
Max_Text_Length	integer
Text	Address

Toolbox_ActionButton_Selected	record
This toolbox event is raised when the user clicks on an action button, and the client has not specified their own event to be associated with this event.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_ActionButton_Selected	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ActionButton_Selected, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ActionButton_Selected_Pointer

Pragmas
Convention	(C, ActionButtonTemplate)
Convention	(C, Toolbox_ActionButton_Selected)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Click_Show	function
*Return*	Object_ID
Returns the ObjectID of the object shown when the user clicks on the action button.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Event	function
*Return*	ToolBox_Event_Code_Type
Returns the event code which will be executed when the user clicks on the action button.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Text	function
*Return*	String
Returns the text displayed in the action button.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Click_Show	procedure
Allows the client to specify the object to show when the user clicks on the action button.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Object	Object_ID	in
Show_Flags	ActionButton_Show_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Event	procedure
Sets the event code which will be executed when the action button is pressed.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Event	ToolBox_Event_Code_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Text	procedure
Sets the text to be displayed in the action button.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Text	string	in
Flags	System.Unsigned_Types.Unsigned	in	0