Package RASCAL.WimpWindow

Description	Wimp 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
Interfaces.C
RASCAL.OS
RASCAL.Memory

Use clauses
Interfaces.C
RASCAL.OS
RASCAL.Memory

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Reason_RedrawWindow_Pointer	access Reason_RedrawWindow
Message_Iconize_Pointer	access Message_Iconize
Message_IconizeAt_Pointer	access Message_IconizeAt
Message_WindowClosed_Pointer	access Message_WindowClosed
Message_WindowInfo_Pointer	access Message_WindowInfo
Double_Byte	mod 2 ** 16
Wimp_Icon_Block_Type	array (integer) of Wimp_Icon_Data
Wimp_WindowInfo_Pointer	access Wimp_WindowInfo_Type
Child_List_Type	array (integer) of Wimp_Handle_Type

Reason_RedrawWindow	record
Some of the window is out of date and needs to be redrawn. You should enter a redraw: First call Wimp_RedrawWindow and then call Wimp_GetRectangle until done.
*Component*	*Type*	*Default*
Window	Wimp_Handle_Type

AWEL_Reason_RedrawWindow	abstract tagged record
inheritance from	Wimp_EventListener (Reason_Event_RedrawWindow, -1, -1)
*Component*	*Type*	*Default*
Event	Reason_RedrawWindow_Pointer

Message_Iconize	record
This message is broadcast by the Wimp when a window's close icon is shift clicked. If an iconiser is absent nothing will happen. If one is present it will acknowledge the message, and send Message_WindowInfo to the window.
*Component*	*Type*	*Default*
Title	Char_Array (1..20)
Task_Handle	Integer
Window	Wimp_Handle_Type
Header	Message_Event_Header

AMEL_Message_Iconize	abstract tagged record
inheritance from	Message_EventListener (Message_Event_Iconize)
*Component*	*Type*	*Default*
Event	Message_Iconize_Pointer

Message_IconizeAt	record
In the absence of this message, Pinboard will just position the window icon beneath the window's close button.
*Component*	*Type*	*Default*
Flags	Integer
Y_Coordinate	Integer
X_Coordinate	Integer
Task_Handle	Integer
Window	Wimp_Handle_Type
Header	Message_Event_Header

AMEL_Message_IconizeAt	abstract tagged record
inheritance from	Message_EventListener (Message_Event_IconizeAt)
*Component*	*Type*	*Default*
Event	Message_IconizeAt_Pointer

Message_WindowClosed	record
This message is bradcasted when a window is closed, so that the iconiser can remove the icon.
*Component*	*Type*	*Default*
Window	Wimp_Handle_Type
Header	Message_Event_Header

AMEL_Message_WindowClosed	abstract tagged record
inheritance from	Message_EventListener (Message_Event_WindowClosed)
*Component*	*Type*	*Default*
Event	Message_WindowClosed_Pointer

Message_WindowInfo	record
This message is sent by the iconiser when one of your windows is iconised, to find out which sprite and name to give to the icon.
*Component*	*Type*	*Default*
Title	Char_Array (1..200)
Sprite_Name	Char_Array (1..8)
Reserved	Integer
Window	Wimp_Handle_Type
Header	Message_Event_Header

AMEL_Message_WindowInfo	abstract tagged record
inheritance from	Message_EventListener (Message_Event_WindowInfo)
*Component*	*Type*	*Default*
Event	Message_WindowInfo_Pointer

Wimp_Icon_Data	record
*Component*	*Type*	*Default*
Icon_Data	Char_Array (1..12)
Icon_Flags	Integer
Max_Y	Integer
Max_X	Integer
Min_Y	Integer
Min_X	Integer

Wimp_Title_Data	record
*Component*	*Type*	*Default*
Title_Data	Char_Array (1..12)

Wimp_Window_Block_Type	record
*Component*	*Type*	*Default*
Nr_Of_Icons_Initially	Integer
Title_Data	Wimp_Title_Data
Minimum_Height	Double_Byte
Minimum_Width	Double_Byte
Sprite_Area_Pointer	Integer
Work_Area_Button_Flags	Integer
Title_Bar_Icon_Flags	Integer
Work_Area_Max_Y	Integer
Work_Area_Max_X	Integer
Work_Area_Min_Y	Integer
Work_Area_Min_X	Integer
Extra_Flags	Byte
Title_Input_Focus_Colour	Byte	12
Scrollbar_Inner_Colour	Byte	1
Scrollbar_Outer_Colour	Byte	3
Work_Area_Background	Byte
Work_Area_Foreground	Byte
Title_Background	Byte	2
Title_Foreground	Byte	7
Window_Flags	Integer
Open_Behind	Wimp_Handle_Type	Wimp_Handle_Type (-1)
Scroll_Y_Offset	Integer
Scroll_X_Offset	Integer
Visible_Area_Max_Y	Integer
Visible_Area_Max_X	Integer
Visible_Area_Min_Y	Integer
Visible_Area_Min_X	Integer

Wimp_WindowInfo_Type	record
*Discriminant*	*Type*	*Default*
Icon_Nr	Integer
*Component*	*Type*	*Default*
Icon_Block	Wimp_Icon_Block_Type (0..Icon_Nr)
Nr_Of_Icons_Initially	Integer
Title_Data	Wimp_Title_Data
Minimum_Height	Double_Byte
Minimum_Width	Double_Byte
Sprite_Area_Pointer	Integer
Work_Area_Button_Flags	Integer
Title_Bar_Icon_Flags	Integer
Work_Area_Max_Y	Integer
Work_Area_Max_X	Integer
Work_Area_Min_Y	Integer
Work_Area_Min_X	Integer
Extra_Flags	Byte
Title_Input_Focus_Colour	Byte	12
Scrollbar_Inner_Colour	Byte	1
Scrollbar_Outer_Colour	Byte	3
Work_Area_Background	Byte
Work_Area_Foreground	Byte
Title_Background	Byte	2
Title_Foreground	Byte	7
Window_Flags	Integer
Open_Behind	Wimp_Handle_Type	Wimp_Handle_Type (-1)
Scroll_Y_Offset	Integer
Scroll_X_Offset	Integer
Visible_Area_Max_Y	Integer
Visible_Area_Max_X	Integer
Visible_Area_Min_Y	Integer
Visible_Area_Min_X	Integer
Window	Wimp_Handle_Type

Wimp_WindowState_Type	record
*Component*	*Type*	*Default*
Window_Flags	Integer
Open_Behind	Wimp_Handle_Type	Wimp_Handle_Type (-1)
Scroll_Y_Offset	Integer
Scroll_X_Offset	Integer
Visible_Area_Max_Y	Integer
Visible_Area_Max_X	Integer
Visible_Area_Min_Y	Integer
Visible_Area_Min_X	Integer
Window	Wimp_Handle_Type

Wimp_WindowOutline_Type	record
*Component*	*Type*	*Default*
Max_Y	Integer
Max_X	Integer
Min_Y	Integer
Min_X	Integer
Window	Wimp_Handle_Type

Wimp_RedrawInfo_Type	record
*Component*	*Type*	*Default*
Redraw_Max_Y	Integer
Redraw_Max_X	Integer
Redraw_Min_Y	Integer
Redraw_Min_X	Integer
Scroll_Y_Offset	Integer
Scroll_X_Offset	Integer
Visible_Area_Max_Y	Integer
Visible_Area_Max_X	Integer
Visible_Area_Min_Y	Integer
Visible_Area_Min_X	Integer
Window	Wimp_Handle_Type

Wimp_WindowExtent_Type	record
type Wimp_OpenWindow_Type is record Window : Wimp_Handle_Type; Visible_Area_Min_X : Integer; Visible_Area_Min_Y : Integer; Visible_Area_Max_X : Integer; Visible_Area_Max_Y : Integer; Scroll_X_Offset : Integer; Scroll_Y_Offset : Integer; Open_Behind : Wimp_Handle_Type := Wimp_Handle_Type(-1); end record; pragma Convention (C, Wimp_OpenWindow_Type);
*Component*	*Type*	*Default*
Work_Area_Max_Y	Integer
Work_Area_Max_X	Integer
Work_Area_Min_Y	Integer
Work_Area_Min_X	Integer

Wimp_External_WindowInfo_Type	record
*Component*	*Type*	*Default*
HLeft_Gap	Integer
LeftArrow_Width	Integer
HWell_Width	Integer
RightArrow_Width	Integer
HRight_Gap	Integer
Adjust_Width	Integer
Adjust_Height	Integer
VLower_Gap	Integer
DownArrow_Height	Integer
VWell_Height	Integer
UpArrow_Height	Integer
VUpper_Gap	Integer
Toggle_Height	Integer
Toggle_Width	Integer
Iconise_Width	Integer
Reserved_2	Integer
Title_Width	Integer
Reserved_1	Integer
Close_Width	Integer
Back_Width	Integer
Top_Border	Integer
Right_Border	Integer
Bottom_Border	Integer
Left_Border	Integer
Window	Wimp_Handle_Type

Pragmas
Convention	(C, Reason_RedrawWindow)
Convention	(C, Message_Iconize)
Convention	(C, Message_IconizeAt)
Convention	(C, Message_WindowClosed)
Convention	(C, Message_WindowInfo)
Convention	(C, Wimp_Icon_Data)
Convention	(C, Wimp_Title_Data)
Convention	(C, Wimp_Window_Block_Type)
Convention	(C, Wimp_Icon_Block_Type)
Convention	(C, Wimp_WindowInfo_Type)
Convention	(C, Wimp_WindowState_Type)
Convention	(C, Wimp_WindowOutline_Type)
Convention	(C, Wimp_RedrawInfo_Type)
Convention	(C, Wimp_External_WindowInfo_Type)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Close_Window	procedure
Closes the window.

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

Open_WindowMax	procedure
Open window at maksimum size.

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

Open_WindowCentered	procedure
Open the window at the center of the screen.

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

Open_WindowAt	procedure
Open window at a specific position.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
X	Integer	in
Y	Integer	in

Open_Window	procedure
This opens a window.

*Parameter name*	*Type*	*Mode*	*Default*
Block	Wimp_WindowState_Type	in

Redraw_Window	procedure
This is called in response to a RedrawWindow request.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Block	Wimp_RedrawInfo_Type	in out
More	Boolean	out

Get_Rectangle	function
*Return*	Boolean
Updates block with info for the next rectangle to be redrawn. Returns true until there is no more to be redrawn.

*Parameter name*	*Type*	*Mode*	*Default*
Block	Wimp_RedrawInfo_Type	in

Get_WindowOutline	function
*Return*	Wimp_WindowOutline_Type
Returns the coordinates of a rectangle which completely covers the window, borders and all.

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

Get_WindowInfo	function
*Return*	Wimp_WindowInfo_Type
Returns the complete details of the given window's state.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Icons	Boolean	in	true

Get_External_WindowInfo	function
*Return*	Wimp_External_WindowInfo_Type
Returns extensive external (toolicons etc.) information about the window. Requires RISC OS 4.

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

Get_Generic_WindowInfo	function
*Return*	Wimp_External_WindowInfo_Type
Returns extensive external (toolicons etc.) information about windows with line borders enabled. Requires RISC OS 4.

Get_WindowState	function
*Return*	Wimp_WindowState_Type
Reads a window's visible state.

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

Get_ParentWindow	function
*Return*	Wimp_Handle_Type
Returns the parent of a child in a nested window. Returns '-1' if the window has no parent. Requires the nested windowmanager.

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

Get_AncestorWindow	function
*Return*	Wimp_Handle_Type
Returns the Wimp handle of the top level window in a nested window. Requires the nested windowmanager.

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

Get_WindowPosition	procedure
Return Top_left coordinates of window in OS units.

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

Is_Open	function
*Return*	Boolean
Is the window open ?

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

Work_To_Screen	procedure
Converts a set of work coordinates of the given window into screen coordinates.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Work_X	Integer	in
Work_Y	Integer	in
Screen_X	Integer	out
Screen_Y	Integer	out

Screen_To_Work	procedure
Converts a set of screen coordinates into work coordinates of the given window.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Screen_X	Integer	in
Screen_Y	Integer	in
Work_X	Integer	out
Work_Y	Integer	out

Force_Redraw	procedure
Forces the WIMP to redraw a special set of coordinates.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Min_X	Integer	in
Min_Y	Integer	in
Max_X	Integer	in
Max_Y	Integer	in

Force_RedrawAll	procedure
Force a redraw of the entire screen.

Force_WindowRedraw	procedure
Forces the WIMP to do a redraw of the whole visible area of a given window.

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

Get_WindowTitle	function
*Return*	String
Reads window title.

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

Get_Extent	function
*Return*	Wimp_WindowExtent_Type
Returns window extent - window workspace size.

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

Set_Extent	procedure
Set window extent, visible workarea must be wholly within new workarea extent.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Wimp_Handle_Type	in
Min_X	Integer	in
Min_Y	Integer	in
Max_X	Integer	in
Max_Y	Integer	in

Delete_Window	procedure
Closes the window and deletes window definition from memory.

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

Get_Parent	function
*Return*	Wimp_Handle_Type
Return parent window handle. Returns '-1' for none. Requires the nested WIMP (3.8).

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

Get_Top_ChildWindow	function
*Return*	Wimp_Handle_Type
Returns window handle of top child window. Returns '-1' for none. Requires the nested WIMP (3.8).

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

Get_Bottom_ChildWindow	function
*Return*	Wimp_Handle_Type
Returns window handle of bottom child window. Returns '-1' for none. Requires the nested WIMP (3.8).

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

Get_Sibling_Below	function
*Return*	Wimp_Handle_Type
Returns window handle of sibling window below. Returns '-1' if none. Requires the nested WIMP (3.8).

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

Get_Sibling_Above	function
*Return*	Wimp_Handle_Type
Returns window handle of sibling window above. Returns '-1' if none. Requires the nested WIMP (3.8).

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

Count_Children	function
*Return*	Natural
Returns the nr of child windows the window has.

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

Get_Children	function
*Return*	Child_List_Type
Returns an array of the windows child windows.

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