Package RASCAL.ToolboxStringSet

Description	Toolbox StringSet 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
Interfaces.C
RASCAL.OS

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

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
StringSet_Generate_User_Value_Changed		16#1#	constant
Flags
StringSet_Generate_Set_Value_Changed		16#2#	constant
StringSet_Writable		16#4#	constant
StringSet_Generate_About_To_Be_Shown		16#8#	constant
StringSet_No_Display		16#10#	constant
StringSet_Justification		16#60#	constant
StringSet_Justification_Shift		16#5#	constant
StringSet_Justification_Left		16#0#	constant
StringSet_Justification_Right		16#1#	constant
StringSet_Justification_Centred		16#2#	constant
StringSet_Get_Alphanumeric_Field		16#1#	constant
StringSet_Get_Pop_Up_Menu		16#2#	constant
StringSet_Action_Value_Changed		16#8288E#	constant
StringSet_Action_About_To_Be_Shown		16#8288F#	constant
StringSet_Value_Too_Long		16#1#	constant

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
StringSet_Components_Type	(Field, Menu)
Toolbox_StringSet_ValueChanged_Pointer	access Toolbox_StringSet_ValueChanged
Toolbox_StringSet_AboutToBeShown_Pointer	access Toolbox_StringSet_AboutToBeShown

Toolbox_StringSet_ValueChanged	record
This event is raised when the value of the StringSet has changed.
*Component*	*Type*	*Default*
Message	Char_Array (1..216)
Header	Toolbox_Event_Header

ATEL_Toolbox_StringSet_ValueChanged	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_StringSet_ValueChanged, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_StringSet_ValueChanged_Pointer

Toolbox_StringSet_AboutToBeShown	record
This event is raised just before the stringset's menu is to be shown.
*Component*	*Type*	*Default*
Header	Toolbox_Event_Header

ATEL_Toolbox_StringSet_AboutToBeShown	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_StringSet_AboutToBeShown, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_StringSet_AboutToBeShown_Pointer

Pragmas
Convention	(C, Toolbox_StringSet_ValueChanged)
Convention	(C, Toolbox_StringSet_AboutToBeShown)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_Components	function
*Return*	Icon_Handle_Type
Returs the ComponentIDs of the gadgets that make up the StringSet.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Part	StringSet_Components_Type	in

Get_Selected	function
*Return*	String
Returns the name of the string currently in the stringset field.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in

Get_Selected	function
*Return*	integer
Returns the index of the selected item.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in

Set_Allowable	procedure
Sets the list of allowable characters which can be typed into a writable field.

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

Set_Available	procedure
Sets the list of available strings in the stringset.

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

Set_Selected	procedure
Sets which string in the stringset is selected.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Selected	string	in

Set_Selected	procedure
Sets which string in the stringset is selected.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Selected	integer	in