Package RASCAL.ToolboxTask

Description	Toolbox Task 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
Interfaces.C
System.Storage_Elements
Ada.Strings.Unbounded
Ada.Strings
Ada.Strings.Fixed
Ada.Strings.Maps
Ada.Strings.Maps.Constants
Ada.Characters.Handling
Kernel
RASCAL.OS
RASCAL.Error
RASCAL.Toolbox
RASCAL.Utility

Use clauses
Interfaces.C
System.Storage_Elements
Ada.Strings.Unbounded
Ada.Strings
Ada.Strings.Fixed
Ada.Strings.Maps
Ada.Strings.Maps.Constants
Ada.Characters.Handling
Kernel
RASCAL.OS
RASCAL.Error
RASCAL.Toolbox
RASCAL.Utility

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
ToolBox_Task_Type	private
ToolBox_Task_Pointer	access all ToolBox_Task_Type
Task_Status_Type	new boolean
Task_Handle_Type	new integer
Wimp_Version_Type	new integer
Poll_Mask_Type	unsigned
Message_Pointer	Event_Pointer

Exceptions
Unknown_Deleted_Event
Is_Toolbox_Event
No_Toolbox_Res_Path
After_Task_Init

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Initialise	procedure
Initilise Toolbox task.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Poll	procedure
Start multitasking / polling.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Single_Poll	procedure
Make a single poll to ensure multitasking during calculations.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
Mask	Integer	in	0

Add_Listener	procedure
Add a toolbox event listener.

*Parameter name*	*Type*	*Mode*	*Default*
The	ToolBox_Task_Pointer	in
Listener	Event_Pointer	in

Remove_Listener	procedure
Remove event listener, only wimp and message events.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
Listener	Event_Pointer	in

Get_Wimp_Version	function
*Return*	Wimp_Version_Type
Returns Wimp version.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Task_Handle	function
*Return*	Task_Handle_Type
Returns Task handle.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Name	function
*Return*	String
Returns task name.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Wimp_Block	function
*Return*	Wimp_Block_Pointer
Returns Wimp block.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Status	function
*Return*	Task_Status_Type
Returns task status.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Poll_Mask	function
*Return*	Poll_Mask_Type
Returns the poll mask.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_WakeUp_Time	function
*Return*	Integer
Gets the return time for Wimp_Poll_Idle

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Messages	function
*Return*	Messages_List_Pointer
Returns list of messages.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Message_Block	function
*Return*	Messages_Handle_Type
Returns message block.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Error	function
*Return*	Error.Error_Pointer
Returns error block.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Resources_Path	function
*Return*	String
Returns the path of the toolbox resource file.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Self_Id	function
*Return*	Object_ID

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Self_Component	function
*Return*	Component_ID

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Parent_Id	function
*Return*	Object_ID

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Parent_Component	function
*Return*	Component_ID

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Ancestor_Id	function
*Return*	Object_ID

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Ancestor_Component	function
*Return*	Component_ID

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Get_Sprite_Area	function
*Return*	System_Sprite_Pointer
Returns the spritearea of the toolbox task.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in

Set_Wimp_Version	procedure
Sets the required Wimp version.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
Nr	Wimp_Version_Type	in

Set_Task_Handle	procedure
Sets the task handle.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
Handle	Task_Handle_Type	in

Set_Name	procedure
Sets the task name.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
Name	String	in

Set_Status	procedure
Sets the task status.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
Status	Task_Status_Type	in

Set_Poll_Mask	procedure
Sets the poll mask.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
Poll_Mask	Poll_Mask_Type	in

Change_Mask	procedure
Changes the poll mask.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
Value	unsigned	in
Set	Boolean	in	true

Set_WakeUp_Time	procedure
Sets the return time for Wimp_Poll_Idle

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
Time	Integer	in

Set_Error	procedure
Sets the error block.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in
E	Error_Pointer	in

Set_Resources_Path	procedure
Defines the path of the toolbox resource file.

*Parameter name*	*Type*	*Mode*	*Default*
The	ToolBox_Task_Pointer	in
Path	String	in

Set_Sprite_Area	procedure
Sets the spritearea for the toolbox task.

*Parameter name*	*Type*	*Mode*	*Default*
The	ToolBox_Task_Pointer	in
Area	System_Sprite_Pointer	in

Report_ID_Block	procedure
Writes the contents of the ID block to 'Reporter'.

*Parameter name*	*Type*	*Mode*	*Default*
The	Toolbox_Task_Pointer	in