Package RASCAL.WimpMenu

Description	Menu 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
RASCAL.OS
RASCAL.Memory
System.Unsigned_Types
System

Use clauses
RASCAL.OS
RASCAL.Memory
System.Unsigned_Types
System

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Menu_Type	private
Abstract data type for menu creation/manipulation first item is 0!
Message_MenusDeleted_Pointer	access Message_MenusDeleted
Message_MenuWarning_Pointer	access Message_MenuWarning
Reason_MenuSelection_Pointer	access Reason_MenuSelection
Icon_Data_String	Char_Array (1..12)

Message_MenusDeleted	record
This message is sent when your Menu was closed without a selection having been made.
*Component*	*Type*	*Default*
Menu_Block	Integer
Header	Message_Event_Header

AMEL_Message_MenusDeleted	abstract tagged record
inheritance from	Message_EventListener (Message_Event_MenusDeleted)
*Component*	*Type*	*Default*
Event	Message_MenusDeleted_Pointer

Message_MenuWarning	record
You receive this message when pointer moves over the subMenu arrow in a Menu entry with the 'generate message' bit set. You can use the 'subMenu pointer' and/or the selection list, to decide which window or Menu to open with Wimp_CreateSubMenu. The subMenu you actually open doesn't have to be the same as the one passed to you. However, if you wish the subMenu to be re-opened when the Wimp recreates the Menu you should store the new handle.
*Component*	*Type*	*Default*
SubMenu_20	Integer
SubMenu_19	Integer
SubMenu_18	Integer
SubMenu_17	Integer
SubMenu_16	Integer
SubMenu_15	Integer
SubMenu_14	Integer
SubMenu_13	Integer
SubMenu_12	Integer
SubMenu_11	Integer
SubMenu_10	Integer
SubMenu_09	Integer
SubMenu_08	Integer
SubMenu_07	Integer
SubMenu_06	Integer
SubMenu_05	Integer
SubMenu_04	Integer
SubMenu_03	Integer
SubMenu_02	Integer
SubMenu_01	Integer
Main_Menu	Integer
Y	Integer
X	Integer
Submenu	Integer
Header	Message_Event_Header

AMEL_Message_MenuWarning	abstract tagged record
inheritance from	Message_EventListener (Message_Event_MenuWarning)
*Component*	*Type*	*Default*
Event	Message_MenuWarning_Pointer

Reason_MenuSelection	record
The datastructure contains the path of selection starting with the element selected in the main Menu. If the user clicks with adjust (call Wimp_GetPointerInfo to find out), the Menu should remain on screen. To do this, you have to reopen the Menu after having responded to selection. This is done by calling Wimp_CreateMenu again.
*Component*	*Type*	*Default*
SubMenu_20	Integer
SubMenu_19	Integer
SubMenu_18	Integer
SubMenu_17	Integer
SubMenu_16	Integer
SubMenu_15	Integer
SubMenu_14	Integer
SubMenu_13	Integer
SubMenu_12	Integer
SubMenu_11	Integer
SubMenu_10	Integer
SubMenu_09	Integer
SubMenu_08	Integer
SubMenu_07	Integer
SubMenu_06	Integer
SubMenu_05	Integer
SubMenu_04	Integer
SubMenu_03	Integer
SubMenu_02	Integer
SubMenu_01	Integer
Main_Menu	Integer

AWEL_Reason_MenuSelection	abstract tagged record
inheritance from	Wimp_EventListener (Reason_Event_MenuSelection, -1, -1)
*Component*	*Type*	*Default*
Event	Reason_MenuSelection_Pointer

Exceptions
too_many_menu_items

Pragmas
Convention	(C, Message_MenusDeleted)
Convention	(C, Message_MenuWarning)
Convention	(C, Reason_MenuSelection)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Init	function
*Return*	Menu_Type
Initialises a Menu object (of Type Menu_Type) "items" is the maximum number of allowed Menu entries

*Parameter name*	*Type*	*Mode*	*Default*
Items	Natural	in

Create	procedure
Opens a Menu using the Menu structure at address "MenuPtr" direct wrap to Wimp_CreateMenu

*Parameter name*	*Type*	*Mode*	*Default*
MenuPtr	Integer	in
X	Integer	in
Y	Integer	in

Create_SubMenu	procedure
Opens a submenu using the menu structure at address "MenuPtr" direct wrap to Wimp_CreateSubMenu

*Parameter name*	*Type*	*Mode*	*Default*
MenuPtr	Integer	in
X	Integer	in
Y	Integer	in

Open	procedure
Opens a Menu at the given position

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
X	Integer	in
Y	Integer	in

Reopen	procedure
Reopens the last opened Menu at the last position (necessary if the user clicked with adjust button)

Open_SubMenu	procedure
Opens menu as a submenu at the given position.

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
X	Integer	in
Y	Integer	in

Close	procedure
Closes the active Menu

Current	function
*Return*	Menu_Type
Returns the currently displayed Menu

Set_Title	procedure
Sets the Menu title

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Title	String	in

Get_Title	function
*Return*	String
Gets the Menu title

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in

Get_Item	function
*Return*	String
Gets the Menu title

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Address	in
Item	Natural	in

Add_Last_Item	procedure
Adds a Menu item to the given Menu Menu entries are always added at the end of the Menu - the position can be read via "item" by the caller with specifying "reserve_space", the caller can allocate a defined number of bytes for the text of the Menu item - if it is left at 0, memory is automatically allocated to cope with the length of the given string

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in out
Item	Natural	out
Name	String	in
Reserve_space	Natural	in	0
Tick	Boolean	in	false
Dotted	Boolean	in	false
Writable	Boolean	in	false
Message	Boolean	in	false
SubMenu	Boolean	in	false

Add_Last_Item	procedure
Adds a Menu item to the given Menu Menu entries are always added at the end of the Menu - the position can be read via "item" by the caller. This is the low level version of Add_last_Item, the caller has to supply the contents of the menu entry and allocate memory if necessary.

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in out
Item	Natural	out
Item_Flags	System.Unsigned_Types.Unsigned	in
Icon_Flags	System.Unsigned_Types.Unsigned	in
Icon_Data	Icon_Data_String	in

Get_Item	function
*Return*	String
Gets the text of a given Menu item

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Item	Natural	in

Change_Item	procedure
Changes the text of a given Menu item Be careful! No checks for sufficiently allocated memory is done!

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Item	Natural	in
Name	String	in

Change_ItemCount	procedure
Change item count.

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in out
New_Count	Natural	in

Shade_Item	procedure
Shades the specified Menu item to make it unselectable

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Item	Natural	in
Shade	Boolean	in	true

Tick_Item	procedure
Puts a tick in front of the specified Menu item

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Item	Natural	in
Tick	Boolean	in	true

Attach_Window	procedure
Attaches a subwindow to the specified Menu item

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Item	Natural	in
WH	Wimp_Handle_Type	in

Attach_SubMenu	procedure
Attaches a subwindow to the specified Menu item

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Item	Natural	in
SubMenu	Menu_Type	in

Set_Colours	procedure
Sets the Menu colours

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Title_FG	Integer	in	7
Title_BG	Integer	in	2
Work_Area_FG	Integer	in	7
Work_Area_BG	Integer	in	0

Get_Colours	procedure
Gets the Menu colours

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Title_FG	Integer	out
Title_BG	Integer	out
Work_Area_FG	Integer	out
Work_Area_BG	Integer	out

Set_Parameters	procedure
Sets the Menu parameters

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Width	Integer	in	0
Height	Integer	in	44
Gap	Integer	in	0

Get_Parameters	procedure
Gets the Menu parameters

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in
Width	Integer	out
Height	Integer	out
Gap	Integer	out

Get_Pointer	function
*Return*	Mem_Adr_Type
Returns a pointer to memory block containing the menu.

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Menu_Type	in