HGamer3D.Bindings.CEGUI.ClassItemListbox

Documentation

getSelectedCount

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Int

Returns the number of selected items in this ItemListbox

getLastSelectedItem

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO HG3DClass

return value - A pointer to the last selected item, 0 is none.

Returns a pointer to the last selected item.

getFirstSelectedItem

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

start_index - The index where the search should begin. If omitted the search will begin with the first item.

-> IO HG3DClass

return value - A pointer to the first selected item in the listbox. If no item is selected the return value is 0. If

Returns a pointer to the first selected item. - Details: If multiselect is disabled then this does the equivalent of calling getLastSelectedItem. If multiselect is enabled it will search the array starting at start_index

getNextSelectedItem

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO HG3DClass

return value - A pointer to the next seleced item. If there are no further selected items the return value is 0. If multiselect is disabled the return value is 0.

Returns a pointer to the next seleced item relative to a previous call to getFirstSelectedItem or getNextSelectedItem. - Details: This member function will take on from where the last call to getFirstSelectedItem or getNextSelectedItem returned. So be sure to start with a call to getFirstSelectedItem.

getNextSelectedItemAfter

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> HG3DClass

start_item

-> IO HG3DClass

Returns a pointer to the next selected item after the item start_item given. - Details: This member function will search the array from the beginning and will be slow for large lists, it will not advance the internal counter used by getFirstSelectedItem and getNextSelectedItem either.

isMultiSelectEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO Bool

Returns true if multiple selections are allowed. false if not.

isItemSelected

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

index

-> IO Bool

Returns true if the item at the given index is selectable and currently selected.

initialiseComponents

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Set whether or not multiple selections should be allowed.

setMultiSelectEnabled

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Bool

state

-> IO ()

Clears all selections.

clearAllSelections

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Select a range of items.

selectRange

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> Int

a - Start item. (inclusive)

-> Int

z - End item. (inclusive)

-> IO ()

Select all items. Does nothing if multiselect is disabled.

selectAllItems

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Constructor for the ItemListbox

new

Arguments

:: String

type

-> String

name

-> IO HG3DClass

delete

Arguments

:: HG3DClass

classpointer - pointer of Class instance which is going to be deleted.

-> IO ()

Setup size and position for the item widgets attached to this ItemListbox

Destructor for the ItemListbox

layoutItemWidgets

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> IO ()

Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.

testClassNameImpl

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> String

class_name - The class name that is to be checked.

-> IO Bool

return value - true if this window was inherited from

notifyItemClicked

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> HG3DClass

li

-> IO ()

Notify this ItemListbox

Notify this ItemListbox

notifyItemSelectState

Arguments

:: HG3DClass

classpointer - pointer of Class instance from which this methods is called.

-> HG3DClass

li

-> Bool

state

-> IO ()

getSelectedCount'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

getLastSelectedItem'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

getFirstSelectedItem'_ :: HG3DClassPtr -> CInt -> HG3DClassPtr -> IO ()

getNextSelectedItem'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

getNextSelectedItemAfter'_ :: HG3DClassPtr -> HG3DClassPtr -> HG3DClassPtr -> IO ()

isMultiSelectEnabled'_ :: HG3DClassPtr -> Ptr CInt -> IO ()

isItemSelected'_ :: HG3DClassPtr -> CInt -> Ptr CInt -> IO ()

initialiseComponents'_ :: HG3DClassPtr -> IO ()

setMultiSelectEnabled'_ :: HG3DClassPtr -> CInt -> IO ()

clearAllSelections'_ :: HG3DClassPtr -> IO ()

selectRange'_ :: HG3DClassPtr -> CInt -> CInt -> IO ()

selectAllItems'_ :: HG3DClassPtr -> IO ()

new'_ :: Ptr CChar -> Ptr CChar -> HG3DClassPtr -> IO ()

delete'_ :: HG3DClassPtr -> IO ()

layoutItemWidgets'_ :: HG3DClassPtr -> IO ()

testClassNameImpl'_ :: HG3DClassPtr -> Ptr CChar -> Ptr CInt -> IO ()

notifyItemClicked'_ :: HG3DClassPtr -> HG3DClassPtr -> IO ()

notifyItemSelectState'_ :: HG3DClassPtr -> HG3DClassPtr -> CInt -> IO ()