Package RASCAL.ToolboxColourDbox

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

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
ColourDBox_Dialogue_Completed_Colour_Choice		16#1#	constant
Flags
Colourdbox_Generate_About_To_Be_Shown		16#1#	constant
Colourdbox_Generate_Dialogue_Completed		16#2#	constant
Colourdbox_Include_None_Button		16#4#	constant
Colourdbox_Select_None_button		16#8#	constant
Colourdbox_Colour_Transparent		16#1#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Colour_Data	array (System.Unsigned_Types.Unsigned) of System.Unsigned_Types.Unsigned
Toolbox_ColourDbox_AboutToBeShown_Pointer	access Toolbox_ColourDbox_AboutToBeShown
Toolbox_ColourDbox_ColourSelected_Pointer	access Toolbox_ColourDbox_ColourSelected
Toolbox_ColourDbox_DialogueCompleted_Pointer	access Toolbox_ColourDbox_DialogueCompleted

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

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

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

Toolbox_ColourDbox_AboutToBeShown	record
Event is raised just before the Colour Dialogue Box is displayed. Event type is not fully specified as it contains a union.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_ColourDbox_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ColourDbox_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ColourDbox_AboutToBeShown_Pointer

Toolbox_ColourDbox_ColourSelected	record
Event is raised when the user clicks OK in the dialogue box.
*Component*	*Type*	*Default*
Colour_Block	System.Unsigned_Types.Unsigned
Header	Toolbox_Event_Header

ATEL_Toolbox_ColourDbox_ColourSelected	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ColourDbox_ColourSelected, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ColourDbox_ColourSelected_Pointer

Toolbox_ColourDbox_DialogueCompleted	record
Event is raised after the Colour Dialogue Box is hidden.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_ColourDbox_DialogueCompleted	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ColourDbox_DialogueCompleted, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ColourDbox_DialogueCompleted_Pointer

Pragmas
Convention	(C, ColourDBoxTemplate)
Convention	(C, Toolbox_ColourDbox_AboutToBeShown)
Convention	(C, Toolbox_ColourDbox_ColourSelected)
Convention	(C, Toolbox_ColourDbox_DialogueCompleted)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Colour	function
*Return*	Colour_Type
Returns the colour displayed in the Colour Dialogue.

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

Get_ColourModel	function
*Return*	Colour_Model_Type
Returnt the colour model currently used in the Colour Dialogue.

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

Get_DialogueHandle	function
*Return*	Wimp_Handle_Type
Returns the handle of the dialogue box used by the Colour Picker module.

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

Get_NoneAvailable	function
*Return*	boolean
Is the 'None' option available in the Colour Dialogue ?

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

Get_WimpHandle	function
*Return*	Wimp_Handle_Type
Returns the Wimp window handle of the window used by the Colour Picker module.

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

Set_Colour	procedure
Sets the colour displayed in the Colour Dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
ColourDbox	Object_ID	in
Colour	Colour_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_ColourModel	procedure
Sets the colour model currently used in the Colour Dialogue.

*Parameter name*	*Type*	*Mode*	*Default*
ColourDbox	Object_ID	in
Model	Colour_Model_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_NoneAvailable	procedure
Sets whether a 'None' option is available in the Colour Dialogue.

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