Package RASCAL.ToolboxColourMenu

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

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Colourmenu_Generate_About_To_Be_Shown		16#1#	constant
Flags
Colourmenu_Generate_Dialogue_Completed		16#2#	constant
Colourmenu_Generate_Has_Been_Hidden		16#2#	constant
Colourmenu_None_Entry		16#4#	constant
Colourmenu_Transparent		16#10#	constant
Colourmenu_None		16#FFFFFFFF#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Colour_Data	array (integer) of integer
Toolbox_ColourMenu_AboutToBeShown_Pointer	access Toolbox_ColourMenu_AboutToBeShown
Toolbox_ColourMenu_HasBeenHidden_Pointer	access Toolbox_ColourMenu_HasBeenHidden
Toolbox_ColourMenu_Selection_Pointer	access Toolbox_ColourMenu_Selection

ColourMenuTemplate	record
*Component*	*Type*	*Default*
Colour	Integer
Max_Title	Integer
Title	Address
Flags	System.Unsigned_Types.Unsigned

Colour_Type	record
*Discriminant*	*Type*	*Default*
Nr	integer
*Component*	*Type*	*Default*
Data	Colour_Data (1..Nr)
Model	integer
Remainder	integer	0
Colour	integer

Colour_Model_Type	record
*Discriminant*	*Type*	*Default*
Nr	integer
*Component*	*Type*	*Default*
Data	Colour_Data (1..Nr)
Model	integer
Remainder	integer	0

Toolbox_ColourMenu_AboutToBeShown	record
Event is raised just before the Colour Menu is displayed.
*Component*	*Type*	*Default*
Position	OS_Coordinate
Show_Type	Integer
Header	Toolbox_Event_Header

ATEL_Toolbox_ColourMenu_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ColourMenu_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ColourMenu_AboutToBeShown_Pointer

Toolbox_ColourMenu_HasBeenHidden	record
Event is raised when the Colour Menu is closed.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_ColourMenu_HasBeenHidden	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ColourMenu_HasBeenHidden, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ColourMenu_HasBeenHidden_Pointer

Toolbox_ColourMenu_Selection	record
Event is raised when the user selects a colour from the menu.
*Component*	*Type*	*Default*
Colour	Toolbox_Colour
Header	Toolbox_Event_Header

ATEL_Toolbox_ColourMenu_Selection	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ColourMenu_Selection, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ColourMenu_Selection_Pointer

Pragmas
Convention	(C, ColourMenuTemplate)
Convention	(C, Toolbox_ColourMenu_AboutToBeShown)
Convention	(C, Toolbox_ColourMenu_HasBeenHidden)
Convention	(C, Toolbox_ColourMenu_Selection)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Colour	function
*Return*	Toolbox_Colour
Returns the currently selected colour in the Colour Menu.

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

Get_Title	function
*Return*	string
Returns the title of the Colour Menu.

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

Get_None_Available	function
*Return*	boolean
Returns whether there is a 'None' entry in the Colour Menu.

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

Set_Colour	procedure
Sets the currently selected colour in the Colour Menu.

*Parameter name*	*Type*	*Mode*	*Default*
ColourMenu	Object_ID	in
Colour	Toolbox_Colour	in
Flags	System.Unsigned_Types.Unsigned	in	0

UnSet_Colour	procedure
Unsets any selection made. (No tick)

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

Set_None_Available	procedure
Sets whether there is a 'None' entry in the Colour Menu.

*Parameter name*	*Type*	*Mode*	*Default*
ColourMenu	Object_ID	in
None_Available	boolean	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Title	procedure
Sets the title in the Colour Menu.

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