GuiListBoxCtrl Class Reference

#include <guiListBoxCtrl_ScriptBinding.h>

Inherits GuiControl.

Inherited by GuiTreeViewCtrl.

Public Member Functions
void	addItem (string text, [color red/green/blue/[alpha]])"
void	clearItems ()"
void	clearSelection ()"
Integer	findItemID (int ID)"
Integer	findItemText (string itemText, bool caseSensitive)"
Boolean	getItemActive (int index)"
Integer	getItemCount ()"
Integer	getItemID (int index)"
void	getMultiSelection ()"
Integer	getSelCount ()"
Integer	getSelectedItem ()"
String	getSelectedItems ()"
void	setCurSel (S32 index)"
void	setCurSelRange (S32 start, [S32 stop])"
void	setItemActive (int index)"
void	setItemID (int index, int ID)"
void	setItemInactive (int index)"
void	setMultiSelection (bool allowMultiSelection)"
void	setSelected (int index, [bool isSelected])"
Public Member Functions inherited from GuiControl
void	addGuiControl (int controlId)
Integer	findHitControl (int x, int y)
String	getCenter ()
String	getExtent (...)
String	getGlobalCenter ()
String	getGlobalPosition ()
String	getMinExtent ()
Integer	getParent ()
String	getPosition ()
String	getText ()
Boolean	getTextExtend ()
Boolean	getTextWrap ()
String	getValue ()
Boolean	isActive ()
Boolean	isAwake ()
Boolean	isVisible ()
void	makeFirstResponder (isFirst)
void	performClick ()
Boolean	pointInControl (int x, int y)
void	reorderChild (child1, child2)
void	resize (int x, int y, int w, int h)
void	setActive (isActive)
void	setCanSave (bool canSave)
void	setCenter (int x, int y)
void	setExtent (int width, int height)
void	setFirstResponder ()
void	setPosition (int x, int y)
void	setPositionGlobal (int x, int y)
void	setProfile (GuiControlProfile p)
void	setText (text)
void	setTextExtend (setting)
void	setTextID (id)
void	setTextWrap (setting)
void	setValue (value)
void	setVisible (isVisible)

Member Function Documentation

addItem()

void addItem	(	string	text,
		[color red / green / blue / [alpha] ]
	)

Adds an item to the end of the list with an optional color bullet.

Parameters

text	The text of the new item.
color	The optional color of a color bullet that will appear to the left of the text. Values range between 0 and 255.

Returns

No return value.

clearItems()

void clearItems

(

)

Removes all items from the listbox.

Returns

No return value.

clearSelection()

void clearSelection

(

)

Unselects any items that have been selected.

Returns

No return value.

findItemID()

Integer findItemID

(

int

ID

)

Finds the first item with the given ID.

Parameters

ID	The item ID to search for.

Returns

The first matching item index or -1 if no item is found.

findItemText()

Integer findItemText	(	string	itemText,
		bool	caseSensitive
	)

Finds all items with the given text.

Parameters

itemText	The text to search for.
caseSensitive	If true, a case-sensitive search will be performed.

Returns

A space-delimited list of matching item indexes or -1 if no items are found.

getItemActive()

Boolean getItemActive

(

int

index

)

Returns if an item is active or not using an index.

Parameters

index

The zero-based index of the item.

Returns

True if the item is active and false otherwise.

getItemCount()

Integer getItemCount

(

)

Returns the number of items in the list.

Returns

The number of items.

getItemID()

Integer getItemID

(

int

index

)

Returns an item's ID using an index.

Parameters

index

The zero-based index of the item with the needed ID.

Returns

The ID of the item.

getMultiSelection()

void getMultiSelection

(

)

Reports if multi-selection is enabled.

Returns

Returns true if multi-selection is enabled. False otherwise.

getSelCount()

Integer getSelCount

(

)

Returns the number of selected items in the list.

Returns

The number of items currently selected.

getSelectedItem()

Integer getSelectedItem

(

)

Returns the index of the first selected item.

Returns

The index of the first selected item or -1 if no item is selected.

getSelectedItems()

String getSelectedItems

(

)

Returns a list of selected item indexes.

Returns

A space-delimited list of selected item indexes or -1 if no items are selected.

setCurSel()

void setCurSel

(

S32

index

)

Selects the item at the given index.

Parameters

index

The zero-based index of the item that should be selected. Passing a -1 clears the selection.

Returns

No return value.

setCurSelRange()

void setCurSelRange

(

S32

start

)

Selects a range of items from a start index to the end or an ending index.

Parameters

start	The zero-based index of the start of the selected range.
stop	The optional, zero-based index of the end of the selected range. If no stop is given, the selection will go to the end of the list.

Returns

No return value.

setItemActive()

void setItemActive

(

int

index

)

Sets an item active using an index.

Parameters

index

The zero-based index of the item that should be active.

Returns

No return value.

setItemID()

void setItemID	(	int	index,
		int	ID
	)

Sets an item's ID using an index.

Parameters

index	The zero-based index of the item that should have the ID.
ID	An interger value that numerically represents this item.

Returns

No return value.

setItemInactive()

void setItemInactive

(

int

index

)

Disables an item using an index.

Parameters

index

The zero-based index of the item that should be inactive.

Returns

No return value.

setMultiSelection()

void setMultiSelection

(

bool

allowMultiSelection

)

If true, allows the user to select multiple items.

Parameters

allowMultiSelection

True to allow multi-selection. False to allow single selection.

Returns

No return value.

setSelected()

void setSelected

(

int

index

)

Sets an item to selected or unselected using an index.

Parameters

index	The zero-based index of the item that should be selected.
isSelected	If true, the item is selected. If false, it is unselected. If omitted, will default to true.

Returns

No return value.