Package RASCAL.Toolbox

Description	Toolbox 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
Ada.Strings.Unbounded
System.Unsigned_Types
System
Interfaces.C
Ada.Unchecked_Conversion
System.Address_To_Access_Conversions
RASCAL.Memory
RASCAL.OS

Use clauses
Ada.Strings.Unbounded
System.Unsigned_Types
System
Interfaces.C
RASCAL.Memory
RASCAL.OS

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Toolbox_Null_Component		16#FFFFFFFF#	constant
Flags
Toolbox_Window_Focus		16#FFFFFFFE#	constant
Toolbox_Name_Limit		16#12#	constant
Toolbox_Wimp_Objects		16#0#	constant
Toolbox_All		16#FFFFFFFF#	constant
Toolbox_Object_Create_On_Load		16#1#	constant
Toolbox_Object_Show_On_Create		16#2#	constant
Toolbox_Object_Shared		16#4#	constant
Toolbox_Object_Ancestor		16#8#	constant
Toolbox_Resource_File_Version		16#101#	constant
Toolbox_Relocate_String_Reference		16#1#	constant
Toolbox_Relocate_Msg_Reference		16#2#	constant
Toolbox_Relocate_Sprite_Area_Reference		16#3#	constant
Toolbox_Relocate_Object_Offset		16#4#	constant
Toolbox_Create_Given_Object		16#1#	constant
Toolbox_Delete_No_Recurse		16#1#	constant
Toolbox_Show_As_Menu		16#1#	constant
Toolbox_Show_As_Sub_Menu		16#2#	constant
Toolbox_Info_Showing		16#1#	constant
Toolbox_Register_Event_Filter		16#1#	constant
Toolbox_Register_Message_Filter		16#2#	constant
Toolbox_Register_Action_Filter		16#3#	constant
Toolbox_De_Register_Filter		16#1#	constant
Toolbox_Position_Default		16#0#	constant
Toolbox_Position_Full		16#1#	constant
Toolbox_Position_Top_Left		16#2#	constant
Toolbox_Position_Centred		16#3#	constant
Toolbox_Position_At_Pointer		16#4#	constant
Toolbox_Wimp_Object_Post_Filter		16#0#	constant
Toolbox_Any_post_Filter		16#FFFFFFFF#	constant
Max_Object_Name	Integer	12

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Position_Types	(Top_Left, Full_Spec)
Object_Class	new Integer
Descriptor_Block_Type	new Address
Object_State	(Hidden, Showing)
Toolbox_SysInfo_Type	(Task_Name, Messages_File_Descriptor, Ressource_Directory, Wimp_Task_Handle, Sprite_Area)
Object_ShowType	(Default, FullSpec, TopLeft, Centre, AtPointer)
Creation_Type	(From_Template, From_Memory)
Reason_ToolboxEvent_Pointer	access Reason_ToolboxEvent
Toolbox_Error_Pointer	access Toolbox_Error
Toolbox_ObjectAutoCreated_Pointer	access Toolbox_ObjectAutoCreated
Toolbox_ObjectDeleted_Pointer	access Toolbox_ObjectDeleted

WindowShowObjectBlock	record
*Component*	*Type*	*Default*
Alignment	System.Unsigned_Types.Unsigned
Parent_Window	Wimp_Handle_Type
Window_Flags	System.Unsigned_Types.Unsigned
Behind	Integer
YScroll	Integer
XScroll	Integer
Visible_Area	OS_BBox

Window_Position_Type	record
*Discriminant*	*Type*	*Default*
PT	Position_Types
Variant part	PT
Variant part => Top_Left
*Component*	*Type*	*Default*
Top_Left	OS_Coordinate
Variant part => Full_Spec
*Component*	*Type*	*Default*
Full	WindowShowObjectBlock

Template_Header	record
*Component*	*Type*	*Default*
Body_Size	Integer
Body_Ptr	System.Address
Total_Size	Integer
Name	Char_Array (1..12)
Version	Integer
Flags	Integer
Class	Object_Class

Toolbox_BBox_Type	record
Type used by Window class for window sizing.
*Component*	*Type*	*Default*
ymax	Integer
xmax	Integer
ymin	Integer
xmin	Integer

Toolbox_EventObject_Type	record
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

Toolbox_MessageEvent_Type	record
*Component*	*Type*	*Default*
Event	Toolbox_EventObject_Type
Component	Component_ID
Self	Object_ID

ResourceFile_Header_Type	record
*Component*	*Type*	*Default*
Object_Offset	Integer
Version_Number	Integer
File_ID	Integer

RelocationTable_Type	record
*Component*	*Type*	*Default*
Relocations	Integer
Num_Relocations	Integer

Relocation_Type	record
*Component*	*Type*	*Default*
Directive	Integer
Word_To_Relocate	Integer

Event_Interest_Type	record
*Component*	*Type*	*Default*
Class	Object_Class
Code	Integer

ResourceFileObject_TemplateHeader_Type	record
*Component*	*Type*	*Default*
Header	Template_Header
Relocation_Table_Offset	Integer
Message_Table_Offset	Integer
String_Table_Offset	Integer

Reason_ToolboxEvent	null record
A Toolbox Event.

AWEL_Reason_ToolboxEvent	abstract tagged record
inheritance from	Wimp_EventListener (Reason_Event_ToolboxEvent, -1, -1)
*Component*	*Type*	*Default*
Event	Reason_ToolboxEvent_Pointer

Toolbox_Error	record
Raised if the Toolbox detects an error when it is not processing a Toolbox SWI.
*Component*	*Type*	*Default*
Message	Char_Array (1..256 - 20 - (Toolbox_Event_Header'Size / CHAR_BIT) - (Object_ID'Size / CHAR_BIT) - (Component_ID'Size / CHAR_BIT) - (Integer'Size / CHAR_BIT))
Number	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_Error	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Error, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Error_Pointer

Toolbox_ObjectAutoCreated	record
Raised after the Toolbox creates objects that have their auto-created attribute set.
*Component*	*Type*	*Default*
Template_Name	Char_Array (1..256 - 20 - (Toolbox_Event_Header'Size / CHAR_BIT) - (Object_ID'Size / CHAR_BIT) - (Component_ID'Size / CHAR_BIT))
Header	Toolbox_Event_Header

ATEL_Toolbox_ObjectAutoCreated	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ObjectAutoCreated, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ObjectAutoCreated_Pointer

Toolbox_ObjectDeleted	record
Raised after the Toolbox deletes an object.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_ObjectDeleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ObjectDeleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ObjectDeleted_Pointer

Pragmas
Convention	(C, WindowShowObjectBlock)
Convention	(C, Window_Position_Type)
pragma Unchecked_Union (Window_Position_Type);
Convention	(C, Template_Header)
Convention	(C, Toolbox_BBox_Type)
Convention	(C, Toolbox_EventObject_Type)
Convention	(C, Toolbox_MessageEvent_Type)
Convention	(C, ResourceFile_Header_Type)
Convention	(C, RelocationTable_Type)
Convention	(C, Relocation_Type)
Convention	(C, Event_Interest_Type)
Convention	(C, ResourceFileObject_TemplateHeader_Type)
Convention	(C, Reason_ToolboxEvent)
Convention	(C, Toolbox_Error)
Convention	(C, Toolbox_ObjectAutoCreated)
Convention	(C, Toolbox_ObjectDeleted)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Create_Object	function
*Return*	Object_ID
Creates an object from a named template in a res file.

*Parameter name*	*Type*	*Mode*	*Default*
Template	string	in

Create_Object	function
*Return*	Object_ID
Creates an object from a template description block in memory.

*Parameter name*	*Type*	*Mode*	*Default*
Template	Address	in

Delete_Object	procedure
Deletes a given object. By default objects attached to this object are also deleted.

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

Get_Ancestor	procedure
Returns the id of the Ancestor of the given object.

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

Get_Client	function
*Return*	Object_ID
Returns the value of the client handle for this object.

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

Get_Class	function
*Return*	Object_Class
Returns the class of the object.

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

Get_State	function
*Return*	Object_State
Returns information regarding the state of an object.

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

Get_Parent	procedure
Returns the parent of the object.

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

Get_Template_Name	function
*Return*	string
Returns the name of the template used to create the object.

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

Hide_Object	procedure
Hides the object.

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

Load_Resources	procedure
Loads the given resource file, and creates any objects which have the auto-create flag set.

*Parameter name*	*Type*	*Mode*	*Default*
Filename	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Client_Handle	procedure

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

Show_Object_At	procedure
Shows the given object on screen at specific coordinates.

*Parameter name*	*Type*	*Mode*	*Default*
Object	Object_ID	in
X	Integer	in
Y	Integer	in
Parent_Object	Object_ID	in
Parent_Component	Component_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Show_Object	procedure
Shows the given object on screen.

*Parameter name*	*Type*	*Mode*	*Default*
Object	Object_ID	in
Parent_Object	Object_ID	in	0
Parent_Component	Component_ID	in	0
Show	Object_ShowType	in	Default
Flags	System.Unsigned_Types.Unsigned	in	0

Template_Lookup	function
*Return*	Address
Returns a pointer to a block suitable to pass to Create_Object.

*Parameter name*	*Type*	*Mode*	*Default*
Template_Name	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Raise_Event	procedure
Raises toolbox event.

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