Package RASCAL.ToolboxScrollList

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

Use clauses
RASCAL.Toolbox
RASCAL.ToolboxGadget
RASCAL.Font
RASCAL.Sprite
RASCAL.OS
RASCAL.Utility
System
System.Unsigned_Types

Basic Objects

Quick access : Clauses - Generics - Definitions - Subprograms

Basic Objects
*Name*	*Type*	*Default*
Action_Scroll_List_Selection		16#140181#	constant
Flags
Scrolllist_State_Allow_Multiple_Selections		16#1#	constant
Scrolllist_Add_Item_Sprite_Info		16#3#	constant
Scrolllist_Add_Item_Sprite_Info_Shift		16#0#	constant
Scrolllist_Add_Item_Sprite_Info_System_Sprite_Name		16#0#	constant
Scrolllist_Add_Item_Sprite_Info_User_Sprite_Name		16#1#	constant
Scrolllist_Add_Item_Sprite_Info_User_Sprite_Pointer		16#2#	constant
Scrolllist_Add_Item_Plot_Sprite_Half_Size		16#4#	constant
Scrolllist_Select_Item_Unique		16#1#	constant
Scrolllist_Set_Colour_Desktop		16#1#	constant
ScrollList_MultipleSelections		16#1#	constant
Flags

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Toolbox_ScrollList_Selection_Pointer	access Toolbox_ScrollList_Selection
Item_List_Type	array (natural) of UString
An array of string items.
Item_List_Pointer	access Item_List_Type
ItemNumber_List_Type	array (natural) of Integer
ItemNumber_List_Pointer	access ItemNumber_List_Type

Scrolllist_Gadget	record
*Component*	*Type*	*Default*
Background	System.Unsigned_Types.Unsigned	0
Foreground	System.Unsigned_Types.Unsigned	7
Event	integer	16#222#
Max_Help	Integer	0
Help	Integer	0
Gadget_Id	Component_ID	0
ymax	Integer	0
xmax	Integer	0
ymin	Integer	0
xmin	Integer	0
Gadget_Type	Integer	16410
Flags	System.Unsigned_Types.Unsigned	0

Toolbox_ScrollList_Selection	record
This event is raised when the user has clicked on an item in a scrolllist. Item contains the nr of the item that was selected or deselected.
*Component*	*Type*	*Default*
Item	Integer
Flags	System.Unsigned_Types.Unsigned
Header	Toolbox_Event_Header

ATEL_Toolbox_ScrollList_Selection	abstract tagged record
inheritance from	Toolbox_EventListener (Toolbox_Event_ScrollList_Selection, -1, -1)
*Component*	*Type*	*Default*
Event	Toolbox_ScrollList_Selection_Pointer

Pragmas
Convention	(C, Scrolllist_Gadget)
Convention	(C, Toolbox_ScrollList_Selection)

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_State	function
*Return*	System.Unsigned_Types.Unsigned
Returns the state of the scrolllist.

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

Set_State	procedure
Sets the state of the scrolllist.

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

Add_Item	procedure
Adds an item to the scrolllist.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Text	String	in
Index	integer	in	-1
Flags	System.Unsigned_Types.Unsigned	in	0

Add_Item	procedure
Adds an item to the scrolllist.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Text	String	in
SpriteArea	Address	in
SpriteID	Integer	in
Index	Integer	in	-1
Flags	System.Unsigned_Types.Unsigned	in	0

Add_Item	procedure
Adds an item to the scrolllist.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Text	String	in
SpriteArea	Sprite_Area_Type	in
SpriteID	Integer	in
Index	Integer	in	-1
Flags	System.Unsigned_Types.Unsigned	in	0

Add_Last_Item	procedure
Adds an item to the end of the scrolllist.

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

Delete_Items	procedure
Removes an item from the scrolllist.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Start_Index	integer	in	0
End_Index	integer	in	-1
Flags	System.Unsigned_Types.Unsigned	in	0

Delete_All	procedure
Removes all items from the scrolllist.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Start_Index	Integer	in	0

Select_Item	procedure
Selects an item from the scrolllist.

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

Select_Items	procedure
Select 'Items' in the scrolllist.

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

Select_All	procedure
Selects all items in the scrolllist with index numbers from 'Start' to ('Start' + number of items).

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Start	Natural	in	1
Flags	System.Unsigned_Types.Unsigned	in	0

DeSelect_Item	procedure
Deselects an item from the scrolllist.

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

DeSelect_Items	procedure
DeSelect 'Items' in the scrolllist.

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

DeSelect_All	procedure
Deselects all items in the scrolllist.

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

Get_Selected	function
*Return*	integer
Returns selected item from the scrolllist. '-1' if no item is selected.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Offset	Integer	in	-1
Flags	System.Unsigned_Types.Unsigned	in	0

Count_Selections	function
*Return*	Natural
Returns nr of selected items.

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

Get_Selections	function
*Return*	Item_List_Type
Returns array of selected items - as itemtext.

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

Get_SelectionNumbers	function
*Return*	ItemNumber_List_Type
Returns array of selected items - as index number.

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

Is_Selected	function
*Return*	Boolean
Returns true if the item is selected.

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

Count_Items	function
*Return*	Integer
Returns the nr of items in the scrolllist.

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

Get_Items	function
*Return*	Item_List_Type
Returns array of items in scrolllist.

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

Get_Column	function
*Return*	Item_List_Type
Returns a array of strings containing only the part of the items belonging to a specific column.

*Parameter name*	*Type*	*Mode*	*Default*
Items	Item_List_Type	in
Column_Nr	Positive	in	1

Make_Visible	procedure
If the item is outside the visible area of the ScrollList, then it will be displayed at the top of the visible area.

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

Set_Colour	procedure
Sets the foreground and background colours for the specified ScrollList. Do not use this as it is NOT style guide compliant.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Foreground	Toolbox_Colour	in	7
Background	Toolbox_Colour	in	0

Set_Colour	procedure
Sets the foreground and background colours for the specified ScrollList. Do not use this as it is NOT style guide compliant.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Foreground	OS_Colour	in
Background	OS_Colour	in

Get_Colour	procedure
Returns the foreground and background colours for the specified ScrollList.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Foreground	OS_Colour	out
Background	OS_Colour	out
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Font	procedure
Sets the font for the ScrollList.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Font_Handle	Font_Handle_Type	in
Font_Height	integer	in	12
Font_Width	integer	in	12
Flags	System.Unsigned_Types.Unsigned	in	0

Get_ItemText	function
*Return*	String
Returns the text of the item in the ScrollList.

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

Set_ItemText	procedure
Set the text of the item.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Index	Integer	in
Text	String	in
Flags	System.Unsigned_Types.Unsigned	in	0

Set_Heading	procedure
Sets the heading of a scrolllist.

*Parameter name*	*Type*	*Mode*	*Default*
Window	Object_ID	in
Component	Component_ID	in
Index	integer	in
Text	String	in
Flags	System.Unsigned_Types.Unsigned	in	0