Package RASCAL.ToolboxOptionButton

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

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

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

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
OptionButton_Generate_State_Changed		16#1#	constant
Flags
OptionButton_On		16#4#	constant
OptionButton_State_Changed_Adjust		16#1#	constant
OptionButton_State_Changed_Select		16#4#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Button_State_Type	(Off, On)
Toolbox_OptionButton_StateChanged_Pointer	access Toolbox_OptionButton_StateChanged

Toolbox_OptionButton_StateChanged	record
This event is raised when the state of an optionbutton changes.
*Component*	*Type*	*Default*
New_State	Button_State_Type
Header	Toolbox_Event_Header

ATEL_Toolbox_OptionButton_StateChanged	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_OptionButton_StateChanged, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_OptionButton_StateChanged_Pointer

Pragmas
Convention	(C, Toolbox_OptionButton_StateChanged)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Event	function
*Return*	ToolBox_Event_Code_Type
Returns the event that will be raised when the state of the button is changed.

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

Get_Label	function
*Return*	String
Returns the label of the optionbutton.

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

Get_State	function
*Return*	Button_State_Type
Returns the state of the optionbutton.

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

Set_Event	procedure
Sets the event that will be raised when the state of optionbutton is changed.

*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_Font	procedure
Sets the font to be used by the optionbutton. Default is the system font.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Font	String	in
Font_Width	integer	in	12
Font_Height	integer	in	12
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Label	procedure
Sets the label text of the optionbutton.

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

Set_State	procedure
Sets the state of the optionbutton.

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