Package RASCAL.ToolboxWindow

Description	Toolbox Window 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.Unsigned_Types
System
RASCAL.Utility
RASCAL.ToolboxKeyboardShortcut
RASCAL.Toolbox
RASCAL.ToolboxGadget
RASCAL.OS
RASCAL.WimpWindow

Use clauses
System.Unsigned_Types
System
RASCAL.Utility
RASCAL.ToolboxKeyboardShortcut
RASCAL.Toolbox
RASCAL.ToolboxGadget
RASCAL.OS
RASCAL.WimpWindow

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Window_Generate_About_To_Be_Shown		16#1#	constant
Flags
Window_Auto_Open		16#2#	constant
Window_Auto_Close		16#4#	constant
Window_Generate_Dialogue_Completed		16#8#	constant
Window_Is_Tool_Bar		16#10#	constant
Window_No_Focus		16#1#	constant
Window_Set_Focus_To_Window		16#2#	constant
Action_Window_About_To_Be_Shown		16#82880#	constant
Action_Window_Dialogue_Completed		16#82890#	constant
Window_Tool_Bar_Ibl		16#1#	constant
Window_Tool_Bar_Itl		16#2#	constant
Window_Tool_Bar_Ebl		16#4#	constant
Window_Tool_Bar_Etl		16#8#	constant
Window_Click_Adjust		16#1#	constant
Window_Click_Menu		16#2#	constant
Window_Click_Select		16#4#	constant
Window_Click_Not_Toolbox		16#100#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Toolbox_Toolbar_Type	(Internal_Bottom_Left, Internal_Top_Left, External_Bottom_Left, External_Top_Left)
Gadget_List_Type	array (integer) of Component_ID
Gadget_List_Pointer	access Gadget_List_Type
Toolbox_Window_AboutToBeShown_Pointer	access Toolbox_Window_AboutToBeShown
Toolbox_Window_HasBeenHidden_Pointer	access Toolbox_Window_HasBeenHidden
Toolbox_Window_GadgetLostFocus_Pointer	access Toolbox_Window_GadgetLostFocus

WindowTemplate	record
*Component*	*Type*	*Default*
Window	Wimp_Window_Block_Type
toolbar_etl	Address
toolbar_ebl	Address
toolbar_itl	Address
toolbar_ibl	Address
Hide_Event	Integer
Show_Event	Integer
Default_Focus	Component_ID
Gadget	Gadgets_Pointer
Num_Gadgets	Integer
KeyboardShortcut	Shortcutlist_Pointer
Num_Keyboard_Shortcuts	Integer
Menu	Address
Pointer_Y_Hot	Integer
Pointer_X_Hot	Integer
Max_Pointer_Shape	Integer
Pointer_Shape	Address
Max_Help	Integer
Help_Message	Address
Flags	System.Unsigned_Types.Unsigned

Toolbox_Window_AboutToBeShown	record
This event is raised just before the Window object is shown. Type lacks union.
*Component*	*Type*	*Default*
Info	Window_Position_Type (Full_Spec)
Show_Type	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_Window_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Window_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Window_AboutToBeShown_Pointer

Toolbox_Window_HasBeenHidden	record
This event is raised after the Window object has been hidden.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Window_HasBeenHidden	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Window_HasBeenHidden, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Window_HasBeenHidden_Pointer

Toolbox_Window_GadgetLostFocus	record
This event is raised when the gadget looses the input focus.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Window_GadgetLostFocus	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Window_GadgetLostFocus, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Window_GadgetLostFocus_Pointer

Exceptions
No_Toolbox_Window
Enumeration_Buffer_Overrun
Too_Many_Gadgets

Pragmas
Convention	(C, WindowTemplate)
Convention	(C, Toolbox_Window_AboutToBeShown)
Convention	(C, Toolbox_Window_HasBeenHidden)
Convention	(C, Toolbox_Window_GadgetLostFocus)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Extract_GadgetInfo	procedure
Returns a pointer to a block of memory suitable for use with Window_AddGadget.

*Parameter name*	*Type*	*Mode*	*Default*
Template	Address	in
Gadget	Component_ID	in
Block	Address	out
BlockSize	Integer	out
Flags	System.Unsigned_Types.Unsigned	in	0

Enumerate_Gadgets	function
*Return*	Gadget_List_Type
Provides the icon numbers for all Toolbox components and sub icons of one component.

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

Plot_Gadget	procedure
Plots a gadget in a redraw loop.

*Parameter name*	*Type*	*Mode*	*Default*
Gadget	Address	in
Flags	System.Unsigned_Types.Unsigned	in	0

Add_Gadget	procedure
Adds the gadget to the window.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Gadget	Address	in
Flags	System.Unsigned_Types.Unsigned	in	0

Remove_Gadget	procedure
Removes the gadget from the window.

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

Set_Menu	procedure
Sets the objectId of the Menu that will be displayed when MENU is pressed over the window.

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

Get_Menu	function
*Return*	Object_ID
Returns the objectId of the Menu that will be displayed when MENU is pressed over the window.

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

Set_Pointer	procedure
Sets the name of the pointer sprite to be used in the specified window.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
SpriteName	string	in
X_Hotspot	integer	in
Y_Hotspot	integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Pointer	procedure
Returns the name of the pointer sprite to be used in the specified window.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
SpriteName	UString	out
X_Hotspot	integer	out
Y_Hotspot	integer	out
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Help	procedure
Sets the interactive help message of the specified window object.

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

Get_Help	function
*Return*	String
Returns the interactive help message of the specified window object.

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

Set_Title	procedure
Sets the title of the window.

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

Get_Title	function
*Return*	String
Returns the title of the window.

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

Set_DefaultFocus	procedure
Set the ComponentID of the gadget which the cursor appears in when the specified window is opened.

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

Get_DefaultFocus	function
*Return*	Component_ID
Returns the ComponentID of the gadget which the cursor appears in when the specified window is opened.

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

Set_Extent	procedure
Sets the size of the specified window.

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

Get_Extent	function
*Return*	Toolbox_BBox_Type
Returns the size of the specified window.

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

Force_Redraw	procedure
Forces a redraw of the area of the window given by the bounding box.

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

Set_Toolbars	procedure
Sets the ObjectIDs of the toolbars that are attached to the specified window.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Toolbar	Object_ID	in
Bar_Type	Toolbox_Toolbar_Type	in

Get_Toolbars	function
*Return*	Object_ID
Returns the ObjectIDs of the toolbars that are attached to the specified window.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Bar_Type	Toolbox_Toolbar_Type	in

Is_Open	function
*Return*	Boolean
Returns true if the window is open.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in

Get_PointerInfo	procedure
Returns the ObjectID and ComponentId if the pointer is over a Toolbox window.

*Parameter name*	*Type*	*Mode*	*Default*
Flags	System.Unsigned_Types.Unsigned	in	0
X_Pos	Integer	out
Y_Pos	Integer	out
State	Integer	out
Object	Integer	out
Gadget	Integer	out

Get_Position	procedure
Return Top_left coordinates of window in OS units.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
X_Pos	Integer	out
Y_Pos	Integer	out

Get_WimpHandle	function
*Return*	Wimp_Handle_Type
Returns the WIMP handle of the toolbox window.

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

Wimp_To_Toolbox	procedure
Returns the ObjectID and ComponentID of the object that contains the icon specified.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icon	Icon_Handle_Type	in
Object	Object_ID	out
Component	Component_ID	out
Flags	System.Unsigned_Types.Unsigned	in	0

Add_KeyboardShortcuts	procedure
Adds keyboard shortcuts to the window object.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Shortcuts	KeyboardShortcutList_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Remove_KeyboardShortcuts	procedure
Removes keyboard shortcuts from window object.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Shortcuts	KeyboardShortcutList_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Register_External	procedure
Registers a new gadget type with the window module.

*Parameter name*	*Type*	*Mode*	*Default*
Gadget_Type	Integer	in
Handler_SWI	Integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

DeRegister_External	procedure
Deregisters a gadget type from the window module.

*Parameter name*	*Type*	*Mode*	*Default*
Gadget_Type	Integer	in
Handler_SWI	Integer	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_UnusedGadget	function
*Return*	Component_ID
Returns an unused gadgetid.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in