Package RASCAL.ToolboxButton

Description	Toolbox button 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
RASCAL.Toolbox
RASCAL.OS
System.Unsigned_Types

Use clauses
RASCAL.Toolbox
RASCAL.OS
System.Unsigned_Types

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Button_Task_Sprite_Area		16#1#	constant
Flags
Button_Allow_Menu_Clicks		16#2#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Flags	function
*Return*	System.Unsigned_Types.Unsigned
Returns the flags of the specified button gadget.

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

Get_Validation	function
*Return*	String
Returns the validation string of the button.

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

Get_Value	function
*Return*	String
Returns the value of the button.

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

Set_Flags	procedure
Sets the flags of the specified button gadget.

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

Set_Font	procedure
Makes the button use an anti-aliased font. 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
Font_Height	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Validation	procedure
Sets the validation string of the button.

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

Set_Value	procedure
Sets the value of the button.

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

Get_Foreground	function
*Return*	Wimp_Colour
Returns the Foreground colour of the button.

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

Get_Background	function
*Return*	Wimp_Colour
Returns the background colour of the button.

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

Set_background	procedure
Sets the background colour of the icon.

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

Set_Foreground	procedure
Sets the foreground colour of the icon.

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