Safe Haskell	None

HGamer3D.Bindings.CEGUI.ClassListbox

Synopsis

Documentation

getItemCount Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Int	return value - the number of items currently attached to this list box.

Return number of items attached to the list box.

getSelectedCount Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Int	return value - Total number of attached items that are in the selected state.

Return the number of selected items in the list box.

getFirstSelectedItem Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to a

Return a pointer to the first selected item.

getNextSelected Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	start_item - Pointer to the ListboxItem where the search for the next selected item is to begin. If this parameter is NULL, the search will begin with the first item in the list box.
-> IO HG3DClass	return value - Pointer to a

Return a pointer to the next selected item after item start_item

getListboxItemFromIndex Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Int	index - Zero based index of the item to be returned.
-> IO HG3DClass	return value - Pointer to the

Return the item at index position index

getItemIndex Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	item - Pointer to a ListboxItem whos zero based index is to be returned.
-> IO Int	return value - Zero based index indicating the position of

Return the index of ListboxItemitem

isSortEnabled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool	return value - true if the list is sorted, false if the list is not sorted

return whether list sorting is enabled

isMultiselectEnabled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool	return value - true if multi-select is enabled, false if multi-select is not enabled.

return whether multi-select is enabled

isItemTooltipsEnabled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

isItemSelected Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Int	index - Zero based index of the item to be examined.
-> IO Bool	return value - true if the item at

return whether the string at index position index

findItemWithText Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> String	text - String object containing the text to be searched for.
-> HG3DClass	start_item - ListboxItem where the search is to begin, the search will not include item. If item is NULL, the search will begin from the first item in the list.
-> IO HG3DClass	return value - Pointer to the first

Search the list for an item with the specified text.

isListboxItemInList Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	item
-> IO Bool	return value - true if

Return whether the specified ListboxItem

isVertScrollbarAlwaysShown Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

Return whether the vertical scroll bar is always shown.

isHorzScrollbarAlwaysShown Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Bool

Return whether the horizontal scroll bar is always shown.

initialiseComponents Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO ()	return value - Nothing

Remove all items from the list. - Details: Note that this will cause AutoDelete items to be deleted.

Initialise the Window - Details: This must be called for every window created. Normally this is handled automatically by the WindowFactory for each Window

resetList Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO ()

Add the given ListboxItem

addItem Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	item - Pointer to the ListboxItem to be added to the list. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens.
-> IO ()	return value - Nothing.

Insert an item into the list box before a specified item already in the list. - Details: Note that if the list is sorted, the item may not end up in the requested position.

insertItem Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	item
-> HG3DClass	position
-> IO ()

Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted.

removeItem Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	item - Pointer to the ListboxItem that is to be removed. If item is not attached to this list box then nothing will happen.
-> IO ()	return value - Nothing.

Clear the selected state for all items.

clearAllSelections Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO ()	return value - Nothing.

Set whether the list should be sorted.

setSortingEnabled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	setting - true if the list should be sorted, false if the list should not be sorted.
-> IO ()	return value - Nothing.

Set whether the list should allow multiple selections or just a single selection.

setMultiselectEnabled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	setting - true if the widget should allow multiple items to be selected, false if the widget should only allow a single selection.
-> IO ()	return value - Nothing.

Set whether the vertical scroll bar should always be shown.

setShowVertScrollbar Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	setting - true if the vertical scroll bar should be shown even when it is not required. false if the vertical scroll bar should only be shown when it is required.
-> IO ()	return value - Nothing.

Set whether the horizontal scroll bar should always be shown.

setShowHorzScrollbar Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	setting - true if the horizontal scroll bar should be shown even when it is not required. false if the horizontal scroll bar should only be shown when it is required.
-> IO ()	return value - Nothing.

setItemTooltipsEnabled Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Bool	setting
-> IO ()

Set the select state of an attached ListboxItem - Details: This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on ListboxItems directly, but that approach does not respect the settings of the list box.

setItemSelectState Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	item
-> Bool	state
-> IO ()

Set the select state of an attached ListboxItem - Details: This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on ListboxItems directly, but that approach does not respect the settings of the list box.

setItemSelectState2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Int	item_index
-> Bool	state
-> IO ()

Causes the list box to update it's internal state after changes have been made to one or more attached ListboxItem - Details: Client code must call this whenever it has made any changes to ListboxItem objects already attached to the list box. If you are just adding items, or removed items to update them prior to re-adding them, there is no need to call this method.

handleUpdatedItemData Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO ()

Ensure the item at the specified index is visible within the list box.

ensureItemIsVisible Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Int	item_index - Zero based index of the item to be made visible in the list box. If this value is out of range, the list is always scrolled to the bottom.
-> IO ()	return value - Nothing.

Ensure the item at the specified index is visible within the list box.

ensureItemIsVisible2 Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	item - Pointer to the ListboxItem to be made visible in the list box.
-> IO ()	return value - Nothing.

Return a pointer to the vertical scrollbar component widget for this Listbox

getVertScrollbar Source

Arguments