Package RASCAL.ToolboxIconbar

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

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
iconbar_Generate_Select_About_To_Be_Shown		16#1#	constant
Flags
iconbar_Generate_Adjust_About_To_Be_Shown		16#2#	constant
iconbar_Select_Is_Menu		16#4#	constant
iconbar_Adjust_Is_Menu		16#8#	constant
iconbar_Has_Text		16#10#	constant
iconbar_Generate_Select_Clicked		16#20#	constant
iconbar_Generate_Adjust_Clicked		16#40#	constant
iconbar_Select		16#1#	constant
iconbar_Adjust		16#2#	constant
iconbar_Clicked_Adjust		16#1#	constant
iconbar_Clicked_Select		16#4#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Iconbar_Button_Type	(Select_Button, Adjust_Button)
Toolbox_Iconbar_AdjustAboutToBeShown_Pointer	access Toolbox_Iconbar_AdjustAboutToBeShown
Toolbox_Iconbar_Clicked_Pointer	access Toolbox_Iconbar_Clicked
Toolbox_Iconbar_SelectAboutToBeShown_Pointer	access Toolbox_Iconbar_SelectAboutToBeShown

IconbarTemplate	record
*Component*	*Type*	*Default*
Max_Help	Integer
Help_Message	Address
Adjust_Show	Address
Select_Show	Address
Adjust_Event	Integer
Select_Event	Integer
Menu	Address
Max_Text	Integer
Text	Address
Max_Sprite	Integer
Sprite	Address
Priority	Integer
Position	Integer
Flags	System.Unsigned_Types.Unsigned

Toolbox_Iconbar_AdjustAboutToBeShown	record
Event is raised before {fcode}Toolbox_ShowObject{f} is executed on an ADJUST click on the iconbar icon.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Iconbar_AdjustAboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Iconbar_AdjustAboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Iconbar_AdjustAboutToBeShown_Pointer

Toolbox_Iconbar_Clicked	record
Event is raised when a click is performed on the iconbar icon.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Iconbar_Clicked	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Iconbar_Clicked, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Iconbar_Clicked_Pointer

Toolbox_Iconbar_SelectAboutToBeShown	record
Event is raised before {fcode}Toolbox_ShowObject{f} is executed on a SELECT click on the iconbar icon.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_Iconbar_SelectAboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_Iconbar_SelectAboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_Iconbar_SelectAboutToBeShown_Pointer

Pragmas
Convention	(C, IconbarTemplate)
Convention	(C, Toolbox_Iconbar_AdjustAboutToBeShown)
Convention	(C, Toolbox_Iconbar_Clicked)
Convention	(C, Toolbox_Iconbar_SelectAboutToBeShown)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Event	function
*Return*	Toolbox_Event_Code_Type
Returns the Toolbox event to be raised when select is clicked on the iconbar icon.

*Parameter name*	*Type*	*Mode*	*Default*
Iconbar	Object_ID	in
Button	Iconbar_Button_Type	in

Get_Help_Message	function
*Return*	String
Returns the standard help message to be shown for the iconbar icon.

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

Get_IconHandle	function
*Return*	Component_ID
Returns the handle of the underlying Wimp icon of the iconbar icon.

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

Get_Menu	function
*Return*	Object_ID
Returns the menu to be used on the iconbar icon.

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

Get_Show	function
*Return*	Object_ID
Returns the objects to be shown when SELECT/ADJUST is clicked on the iconbar.

*Parameter name*	*Type*	*Mode*	*Default*
Iconbar	Object_ID	in
Button	Iconbar_Button_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Get_Sprite	function
*Return*	String
Returns the sprite being used for the iconbar icon.

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

Get_Text	function
*Return*	String
Returns the text being used for iconbar icontext.

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

Set_Event	procedure
Sets the Toolbox event to be raised when SELECT is clicked on the iconbar icon.

*Parameter name*	*Type*	*Mode*	*Default*
Iconbar	Object_ID	in
Button	Iconbar_Button_Type	in
Event	Toolbox_Event_Code_Type	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_HelpMessage	procedure
Sets the standard help message to be shown for the iconbar icon.

*Parameter name*	*Type*	*Mode*	*Default*
Iconbar	Object_ID	in
Message	string	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Menu	procedure
Sets the menu to be used for iconbar icon.

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

Set_Show	procedure
Sets the objects to be shown when SELECT/ADJUST is clicked on the iconbar icon.

*Parameter name*	*Type*	*Mode*	*Default*
Iconbar	Object_ID	in
Button	Iconbar_Button_Type	in
Object	Object_ID	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Sprite	procedure
Sets the sprite to be used as iconbar icon.

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

Set_Text	procedure
Sets the text to be used with the iconbar icon.

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