Package RASCAL.ToolboxGadget

Description	Generic gadget methods and types.
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
RASCAL.Utility
System.Unsigned_Types
System

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
ActionButton_Base		128	constant
AdjusterArrow_Base		768	constant
Button_Base		960	constant
DisplayField_Base		448	constant
Draggable_Base		640	constant
Label_Base		320	constant
LabelledBox_Base		256	constant
NumberRange_Base		832	constant
OptionButton_Base		192	constant
PopUp_Base		704	constant
RadioButton_Base		384	constant
ScrollList_Base		16410	constant
Slider_Base		576	constant
StringSet_Base		896	constant
TextArea_Base		16408	constant
WritableField_Base		512	constant
TreeView_Base		16#140280#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Gadget_Base_Type	new Integer
Gadget_Type	(ActionButton_Type, AdjusterArrow_Type, Button_Type, DisplayField_Type, Draggable_Type, Label_Type, LabelledBox_Type, NumberRange_Type, OptionButton_Type, PopUp_Type, RadioButton_Type, ScrollList_Type, ScrollBar_Type, Slider_Type, StringSet_Type, WritableField_Type, TextArea_Type, Tabs_Type, TreeView_Type)
Gadgets_Type	array (Natural) of Gadget
Gadgets_Pointer	access Gadgets_Type
Icon_List_Type	array (Natural) of Icon_Handle_Type
Icon_List_Pointer	access Icon_List_Type

ActionButton_Gadget	record
*Component*	*Type*	*Default*
Event	Integer
Click_Show	Address
Max_Text_Length	Integer
Text	Address

OptionButton_Gadget	record
*Component*	*Type*	*Default*
Event	Integer
Max_Label_Length	Integer
Label	Address

LabelledBox_Gadget	record
*Component*	*Type*	*Default*
Label	Address

Label_Gadget	record
*Component*	*Type*	*Default*
Label	Address

RadioButton_Gadget	record
*Component*	*Type*	*Default*
Event	Integer
Max_Label_Length	Integer
Label	Address
Group_Number	Integer

DisplayField_Gadget	record
*Component*	*Type*	*Default*
Max_Text_Length	Integer
Text	Address

WritableField_Gadget	record
*Component*	*Type*	*Default*
After	Component_ID
Before	Component_ID
Allowable_Limit	Integer
Allowable	Address
Text_Limit	Integer
Text	Address

Slider_Gadget	record
*Component*	*Type*	*Default*
Initial_Value	Integer
Step_Size	Integer
Upper_Bound	Integer
Lower_Bound	Integer

Draggable_Gadget	record
*Component*	*Type*	*Default*
Max_Sprite_Length	Integer
Sprite	Address
Max_Text_Length	Integer
Text	Address

PopUp_Gadget	record
*Component*	*Type*	*Default*
Menu	Address

Adjuster_Gadget	record
*Component*	*Type*	*Default*
Dummy	Integer

NumberRange_Gadget	record
*Component*	*Type*	*Default*
Display_Length	Integer
After	Component_ID
Before	Component_ID
Precision	Integer
Initial_Value	Integer
Step_Size	Integer
Upper_Bound	Integer
Lower_Bound	Integer

StringSet_Gadget	record
*Component*	*Type*	*Default*
After	Component_ID
Before	Component_ID
Allowable_Length	Integer
Allowable	Address
InitialValue_Length	Integer
InitialValue	Address
Title	Address
StringSet	Address

Button_Gadget	record
*Component*	*Type*	*Default*
Max_Validation	Integer
Validation	Address
Max_Value	Integer
Value	Address
Button_Flags	System.Unsigned_Types.Unsigned

TextArea_Gadget	record
*Component*	*Type*	*Default*
Background	OS_Colour
Foreground	OS_Colour
Text	Address
Event	Integer
Gadget_Type	Integer

Scrolllist_Gadget	record
*Component*	*Type*	*Default*
Background	OS_Colour
Foreground	OS_Colour
Event	Integer

ScrollBar_Gadget	record
*Component*	*Type*	*Default*
Page_Inc	System.Unsigned_Types.Unsigned
Line_Inc	System.Unsigned_Types.Unsigned
Visible	System.Unsigned_Types.Unsigned
Value	System.Unsigned_Types.Unsigned
Max	System.Unsigned_Types.Unsigned
Min	System.Unsigned_Types.Unsigned
Event	Integer
Gadget_Type	Integer

Tabs_Gadget	record
*Component*	*Type*	*Default*
Text	Address
BackGround	System.Unsigned_Types.Unsigned
ForeGround	System.Unsigned_Types.Unsigned

TreeView_Gadget	record
*Component*	*Type*	*Default*
Background	System.Unsigned_Types.Unsigned
Foreground	System.Unsigned_Types.Unsigned

Gadget_Header_Type	record
*Component*	*Type*	*Default*
Help	Address
Max_Help	integer
Id	Component_ID
BBox	Toolbox_BBox_Type
Gadget_Kind	Gadget_Base_Type
Flags	System.Unsigned_Types.Unsigned

Gadget_Data	record
*Discriminant*	*Type*	*Default*
Gadget	Gadget_Type
Variant part	Gadget
Variant part => ActionButton_Type
*Component*	*Type*	*Default*
ActionButton	ActionButton_Gadget
Variant part => AdjusterArrow_Type
*Component*	*Type*	*Default*
AdjusterArrow	Adjuster_Gadget
Variant part => Button_Type
*Component*	*Type*	*Default*
Button	Button_Gadget
Variant part => DisplayField_Type
*Component*	*Type*	*Default*
DisplayField	DisplayField_Gadget
Variant part => Draggable_Type
*Component*	*Type*	*Default*
Draggable	Draggable_Gadget
Variant part => Label_Type
*Component*	*Type*	*Default*
Label	Label_Gadget
Variant part => LabelledBox_Type
*Component*	*Type*	*Default*
LabelledBox	LabelledBox_Gadget
Variant part => NumberRange_Type
*Component*	*Type*	*Default*
NumberRange	NumberRange_Gadget
Variant part => OptionButton_Type
*Component*	*Type*	*Default*
OptionButton	OptionButton_Gadget
Variant part => PopUp_Type
*Component*	*Type*	*Default*
PopUp	PopUp_Gadget
Variant part => RadioButton_Type
*Component*	*Type*	*Default*
RadioButton	RadioButton_Gadget
Variant part => ScrollList_Type
*Component*	*Type*	*Default*
ScrollList	ScrollList_Gadget
Variant part => ScrollBar_Type
*Component*	*Type*	*Default*
ScrollBar	ScrollBar_Gadget
Variant part => Slider_Type
*Component*	*Type*	*Default*
Slider	Slider_Gadget
Variant part => StringSet_Type
*Component*	*Type*	*Default*
StringSet	StringSet_Gadget
Variant part => WritableField_Type
*Component*	*Type*	*Default*
WritableField	WritableField_Gadget
Variant part => TextArea_Type
*Component*	*Type*	*Default*
TextArea	TextArea_Gadget
Variant part => TreeView_Type
*Component*	*Type*	*Default*
TreeView	TreeView_Gadget
Variant part => Tabs_Type
*Component*	*Type*	*Default*
Tabs	Tabs_Gadget

Gadget	record
*Component*	*Type*	*Default*
Data	Gadget_Data (Button_Type)
Header	Gadget_Header_Type

Exceptions
Gadget_Type_Incompatible_With_Set_Value

Pragmas
Convention	(C, ActionButton_Gadget)
Convention	(C, OptionButton_Gadget)
Convention	(C, LabelledBox_Gadget)
Convention	(C, Label_Gadget)
Convention	(C, RadioButton_Gadget)
Convention	(C, DisplayField_Gadget)
Convention	(C, WritableField_Gadget)
Convention	(C, Slider_Gadget)
Convention	(C, Draggable_Gadget)
Convention	(C, PopUp_Gadget)
Convention	(C, Adjuster_Gadget)
Convention	(C, NumberRange_Gadget)
Convention	(C, StringSet_Gadget)
Convention	(C, Button_Gadget)
Convention	(C, TextArea_Gadget)
Convention	(C, Scrolllist_Gadget)
Convention	(C, ScrollBar_Gadget)
Convention	(C, Tabs_Gadget)
Convention	(C, TreeView_Gadget)
Convention	(C, Gadget_Header_Type)
Convention	(C, Gadget_Data)
pragma Unchecked_Union(Gadget_Data);
Convention	(C, Gadget)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_BufferSize	function
*Return*	Integer
Returns the size of the gadget's text buffer.

*Parameter name*	*Type*	*Mode*	*Default*
Object	Object_ID	in
Component	Component_ID	in

Get_Value	function
*Return*	String
Generic method to read the text value of a gadget. (WritableField,DisplayField,ActionButton,OptionButton,RadioButton).

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

Get_Value	function
*Return*	Integer
Generic method to read the integer value of a gadget. (number range, slider).

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

Set_Value	procedure
Generic method to set the text value of a gadget. (WritableField,DisplayField,ActionButton,OptionButton,RadioButton).

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

Set_Value	procedure
Generic method to set the integer value of a gadget. (number range, slider).

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

Set_TruncatedValue	procedure
Generic method to set the text value of a gadget. (WritableField,DisplayField,ActionButton,OptionButton,RadioButton). The text is truncated to the size of the gadget and an ellipsis is added.

*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_BBox	function
*Return*	Toolbox_BBox_Type
Returns the bounding box of the gadget.

*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 gadget.

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

Get_Flags	function
*Return*	integer
Returns the flags of the specified gadget.

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

Get_Type	function
*Return*	Gadget_Base_Type
Returns the type of the gadget.

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

Get_Help	function
*Return*	String
Returns the interactive help message of the gadget.

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

Set_Help	procedure
Sets the interactive help message of the gadget.

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

Get_IconList	function
*Return*	Icon_List_Type
Returns the list if Wimp icons making up the gadget.

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

Fade	procedure
Fade gadget.

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

UnFade	procedure
Unfade gadget.

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

Set_Focus	procedure
Sets the gadget which will receive the inout focus when the window gets it.

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

Move	procedure
Moves an already created gadget to another location.

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