Package RASCAL.ToolboxMenu

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

Use clauses
System
System.Unsigned_Types
RASCAL.Toolbox
RASCAL.OS
RASCAL.Utility

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
menu_Generate_About_To_Be_Shown		16#1#	constant
Flags
menu_Generate_Dialogue_Completed		16#2#	constant
menu_Generate_Has_Been_Hidden		16#2#	constant
menu_Entry_Ticked		16#1#	constant
menu_Entry_Separate		16#2#	constant
menu_Entry_Faded		16#100#	constant
menu_Entry_Is_Sprite		16#200#	constant
menu_Entry_Sub_Menu		16#400#	constant
menu_Entry_Generate_Sub_Menu_Action		16#800#	constant
menu_Entry_Is_Menu		16#1000#	constant
menu_Show_Persistent		16#0#	constant
menu_Show_Transient		16#1#	constant
menu_Add_Before		16#1#	constant
menu_Add_At_Start		16#FFFFFFFF#	constant
menu_Add_At_End		16#FFFFFFFE#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Menu_Show_Type	(Persistent, Transient)
Menu_Fade_Type	(Unfaded, Faded)
Menu_Tick_Type	(Unticked, Ticked)
MenuTemplate_Entry_Pointer	access MenuTemplate_Entry_Type
Toolbox_Menu_AboutToBeShown_Pointer	access Toolbox_Menu_AboutToBeShown
Toolbox_Menu_HasBeenHidden_Pointer	access Toolbox_Menu_HasBeenHidden
Toolbox_Menu_SubMenu_Pointer	access Toolbox_Menu_SubMenu
Toolbox_Menu_Selection_Pointer	access Toolbox_Menu_Selection

MenuTemplate_Entry_Type	record
*Component*	*Type*	*Default*
Max_Entry_Help	integer
Help_Message	Address
Click_Event	integer
Submenu_Event	integer
Submenu_Show	Object_ID
Click_Show	Object_ID
Max_Text	integer
Name	Address
ComponentID	Component_ID
Flags	integer	0

MenuTemplate_Header	record
*Component*	*Type*	*Default*
Entries	Integer
Hide_Event	Integer
Show_Event	Integer
Max_Help	Integer
Help	Address
Max_Title	Integer
Title	Address
Flags	System.Unsigned_Types.Unsigned

MenuTemplate	record
*Component*	*Type*	*Default*
Header	MenuTemplate_Header

Toolbox_Menu_AboutToBeShown	record
Event is raised due to a call to {fcode}Toolbox_ShowObject{f} on a menu.
*Component*	*Type*	*Default*
Position	OS_Coordinate
Show_Type	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_Menu_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Menu_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Menu_AboutToBeShown_Pointer

Toolbox_Menu_HasBeenHidden	record
Event is raised due to a call to {fcode}Toolbox_HideObject{f} on a menu.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Menu_HasBeenHidden	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Menu_HasBeenHidden, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Menu_HasBeenHidden_Pointer

Toolbox_Menu_SubMenu	record
Event is raised when the user moves the mouse over a sub-menu's arrow icon.
*Component*	*Type*	*Default*
Position	OS_Coordinate
Header	Toolbox_Event_Header

ATEL_Toolbox_Menu_SubMenu	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Menu_SubMenu, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Menu_SubMenu_Pointer

Toolbox_Menu_Selection	record
Event is raised when the user makes a selection in a menu object.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Menu_Selection	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Menu_Selection, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Menu_Selection_Pointer

Pragmas
Convention	(C, MenuTemplate_Entry_Type)
Convention	(C, MenuTemplate_Header)
Convention	(C, MenuTemplate_Header)
Convention	(C, Toolbox_Menu_AboutToBeShown)
Convention	(C, Toolbox_Menu_HasBeenHidden)
Convention	(C, Toolbox_Menu_SubMenu)
Convention	(C, Toolbox_Menu_Selection)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Set_Available	procedure
Defines a menu content using a string like the stringset gadget.

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Object_ID	in
Available	String	in
Items	Natural	in out
Event	Integer	in	16#828C3#
Flags	System.Unsigned_Types.Unsigned	in	0

Add_Last_Entry	procedure
Adds a new menu entry.

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Object_ID	in
Name	String	in
Id	Component_ID	in
Help	String	in	""
Click_Show	Object_ID	in	Object_ID'Val (0)
Submenu_Show	Object_ID	in	Object_ID'Val (0)
Click_Event	integer	in	16#828C3#
Submenu_Event	integer	in	16#828C2#

Add_After_Entry	procedure
Adds a new menu entry.

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Object_ID	in
Name	String	in
Id	Component_ID	in
Next_ID	Component_ID	in
Help	String	in	""
Click_Show	Object_ID	in	Object_ID'Val (0)
Submenu_Show	Object_ID	in	Object_ID'Val (0)
Click_Event	integer	in	16#828C3#
Submenu_Event	integer	in	16#828C2#
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Click_Event	function
*Return*	Toolbox_Event_Code_Type
Returns the Toolbox event to be raised when the user selects the given menu entry.

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

Get_Click_Show	function
*Return*	Object_ID
Returns the ObjectID of the object to be shown when the user selects the menu event.

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

Get_Click_Show_Type	function
*Return*	Menu_Show_Type

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

Get_Entry_Help	function
*Return*	string
Returns the interactive help message for that menu entry.

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

Get_Entry_Sprite	function
*Return*	string
Returns the sprite which is to be used in the menu entry.

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

Get_Entry_Text	function
*Return*	String
Returns the text which is to be used in the menu entry.

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

Get_Fade	function
*Return*	Menu_Fade_Type
Returns the fade state of the menu.

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

Get_Height	function
*Return*	integer
Returns the height of work area of the given menu.

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

Get_Help	function
*Return*	string
Returns the interactive help message for the menu.

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

Get_Sub_Menu_Event	function
*Return*	Toolbox_Event_Code_Type
Returns the event to be raised when the user moves the mouse over a submenu arrow.

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

Get_Sub_Menu_Show	function
*Return*	Object_ID
Returns the objectid of the object that will be shown when the user enters a submenu.

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

Get_Tick	function
*Return*	Menu_Tick_Type
Returns the tick state of the menu entry.

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

Get_Title	function
*Return*	string
Returns the title of the menu.

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

Get_Width	function
*Return*	integer
Returns the width of the workarea of the menu.

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

Remove_Entry	procedure
Removes an entry from the menu.

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

Remove_Entries	procedure
Removes a range of entries from the menu.

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Object_ID	in
Nr	integer	in
Start	integer	in	0
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Click_Event	procedure
Specifies a Toolbox event to be raised when the user selects the given menu.

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

Set_Click_Show	procedure
Specifies the objectid of the object to be shown when the user selects the menu entry.

*Parameter name*	*Type*	*Mode*	*Default*
Menu	Object_ID	in
Component	Component_ID	in
Object	Object_ID	in
Show	Menu_Show_Type	in	Persistent
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Entry_Help	procedure
Specifies the interactive help message for the menu entry.

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

Set_Entry_Sprite	procedure
Sets the sprite which is to be used in the menu entry

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

Set_Entry_Text	procedure
Sets the text for the named menu entry.

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

Set_Fade	procedure
Sets the fade state of the menu entry.

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

Set_Help	procedure
Sets the interactive help message for the menu.

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

Set_Sub_Menu_Event	procedure
Specifies an event to be raised when the user moves the mouse over a submenu arrow.

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

Set_Sub_Menu_Show	procedure
Specifies the objectid of the object to show when the user moves over the submenu arrow.

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

Set_Tick	procedure
Sets the tick state of the menu entry.

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

Set_Title	procedure
Sets the title of the menu.

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