HGamer3D-CEGUI-Binding-0.1.9: Windows Game Engine for the Haskell Programmer - CEGUI Bindings

Safe HaskellNone

HGamer3D.Bindings.CEGUI.ClassMultiColumnList

Synopsis

Documentation

isUserSortControlEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the user may interactively modify the sort column and direction. false if the user may not modify the sort column and direction (these can still be set programmatically).

Return whether user manipulation of the sort column and direction are enabled.

isUserColumnSizingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the user may interactively modify the width of columns, false if they may not.

Return whether the user may size column segments.

isUserColumnDraggingEnabledSource

Arguments

:: HG3DClass

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

-> IO Bool

return value - true if the user may interactively modify the order of the columns, false if they may not.

Return whether the user may modify the order of the columns.

getColumnCountSource

Arguments

:: HG3DClass

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

-> IO Int

return value - uint value equal to the number of columns in the list.

Return the number of columns in the multi-column list.

getRowCountSource

Arguments

:: HG3DClass

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

-> IO Int

return value - uint value equal to the number of rows currently in the list.

Return the number of rows in the multi-column list.

getSortColumnSource

Arguments

:: HG3DClass

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

-> IO Int

return value - Zero based column index that is the current sort column.

Return the zero based index of the current sort column. There must be at least one column to successfully call this method.

getColumnWithIDSource

Arguments

:: HG3DClass

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

-> Int

col_id - ID code of the column whos index is to be returned.

-> IO Int

return value - Zero based column index of the first column whos ID matches

Return the zero based column index of the column with the specified ID.

getColumnWithHeaderTextSource

Arguments

:: HG3DClass

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

-> String

text - String object containing the text to be searched for.

-> IO Int

return value - Zero based column index of the column whos header has the specified text.

Return the zero based index of the column whos header text matches the specified text.

getSortDirectionSource

Arguments

:: HG3DClass

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

-> IO EnumSortDirection

return value - One of the

Return the currently set sort direction.

getHeaderSegmentForColumnSource

Arguments

:: HG3DClass

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

-> Int

col_idx - zero based index of the column whos ListHeaderSegment is to be returned.

-> IO HG3DClass 

Return the ListHeaderSegment

getItemRowIndexSource

Arguments

:: HG3DClass

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

-> HG3DClass

item - Pointer to the ListboxItem that the row index is to returned for.

-> IO Int

return value - Zero based index of the row that contains

Return the zero based index of the Row that contains item

getItemColumnIndexSource

Arguments

:: HG3DClass

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

-> HG3DClass

item - Pointer to the ListboxItem that the column index is to returned for.

-> IO Int

return value - Zero based index of the column that contains

Return the current zero based index of the column that contains item

isListboxItemInColumnSource

Arguments

:: HG3DClass

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

-> HG3DClass

item - Pointer to the ListboxItem to look for.

-> Int

col_idx - Zero based index of the column that is to be searched.

-> IO Bool 

return whether ListboxItemitemcol_idx

isListboxItemInRowSource

Arguments

:: HG3DClass

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

-> HG3DClass

item - Pointer to the ListboxItem to look for.

-> Int

row_idx - Zero based index of the row that is to be searched.

-> IO Bool 

return whether ListboxItemitemrow_idx

isListboxItemInListSource

Arguments

:: HG3DClass

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

-> HG3DClass

item - Pointer to the ListboxItem to look for.

-> IO Bool 

return whether ListboxItemitem

findColumnItemWithTextSource

Arguments

:: HG3DClass

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

-> String

text - String object containing the text to be searched for.

-> Int

col_idx - Zero based index of the column to be searched.

-> HG3DClass

start_item - Pointer to the ListboxItem where the exclusive search is to start, or NULL to search from the top of the column.

-> IO HG3DClass

return value - Pointer to the first

Return the ListboxItemcol_idxtext

findRowItemWithTextSource

Arguments

:: HG3DClass

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

-> String

text - String object containing the text to be searched for.

-> Int

row_idx - Zero based index of the row to be searched.

-> HG3DClass

start_item - Pointer to the ListboxItem where the exclusive search is to start, or NULL to search from the start of the row.

-> IO HG3DClass

return value - Pointer to the first

Return the ListboxItemrow_idxtext

findListItemWithTextSource

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 - Pointer to the ListboxItem where the exclusive search is to start, or NULL to search the whole list box.

-> IO HG3DClass

return value - Pointer to the first

Return the ListboxItemtext - Details: List box searching progresses across the columns in each row.

getFirstSelectedItemSource

Arguments

:: HG3DClass

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

-> IO HG3DClass

return value - Pointer to the first

Return a pointer to the first selected ListboxItem - Details: List box searching progresses across the columns in each row.

getNextSelectedSource

Arguments

:: HG3DClass

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

-> HG3DClass

start_item - Pointer to the ListboxItem where the exclusive search is to start, or NULL to search the whole list box.

-> IO HG3DClass

return value - Pointer to the first selected

Return a pointer to the next selected ListboxItemstart_item - Details: List box searching progresses across the columns in each row.

getSelectedCountSource

Arguments

:: HG3DClass

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

-> IO Int 

Return the number of selected ListboxItems attached to this list box. - Details: return uint value equal to the number of ListboxItems attached to this list box that are currently selected.

getNominatedSelectionColumnIDSource

Arguments

:: HG3DClass

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

-> IO Int

return value - ID code of the nominated selection column.

Return the ID of the currently set nominated selection column to be used when in one of the NominatedColumn* selection modes. There must be at least one column to successfully call this method. - Details: You should only ever call this when getColumnCount()

getNominatedSelectionColumnSource

Arguments

:: HG3DClass

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

-> IO Int

return value - Zero based index of the nominated selection column.

Return the index of the currently set nominated selection column to be used when in one of the NominatedColumn* selection modes.

getNominatedSelectionRowSource

Arguments

:: HG3DClass

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

-> IO Int

return value - Zero based index of the nominated selection column.

Return the index of the currently set nominated selection row to be used when in one of the NominatedRow* selection modes.

getSelectionModeSource

Arguments

:: HG3DClass

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

-> IO EnumSelectionMode

return value - One of the

Return the currently set selection mode.

isVertScrollbarAlwaysShownSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether the vertical scroll bar is always shown.

isHorzScrollbarAlwaysShownSource

Arguments

:: HG3DClass

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

-> IO Bool 

Return whether the horizontal scroll bar is always shown.

getColumnIDSource

Arguments

:: HG3DClass

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

-> Int

col_idx - Zero based index of the column whos ID code is to be returned.

-> IO Int

return value - Current ID code assigned to the column at the requested index.

Return the ID code assigned to the requested column.

getRowIDSource

Arguments

:: HG3DClass

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

-> Int

row_idx - Zero based index of the row who's ID code is to be returned.

-> IO Int

return value - Current ID code assigned to the row at the requested index.

Return the ID code assigned to the requested row.

getRowWithIDSource

Arguments

:: HG3DClass

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

-> Int

row_id - ID code of the row who's index is to be returned.

-> IO Int

return value - Zero based row index of the first row who's ID matches

Return the zero based row index of the row with the specified ID.

getVertScrollbarSource

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 vertical scrollbar component widget for this MultiColumnList

getHorzScrollbarSource

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 horizontal scrollbar component widget for this MultiColumnList

getListHeaderSource

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 list header component widget for this MultiColumnList

getTotalRowsHeightSource

Arguments

:: HG3DClass

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

-> IO Float 

Return the sum of all row heights in pixels.

getWidestColumnItemWidthSource

Arguments

:: HG3DClass

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

-> Int

col_idx

-> IO Float 

Return the pixel width of the widest item in the given column.

getHighestRowItemHeightSource

Arguments

:: HG3DClass

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

-> Int

row_idx

-> IO Float 

Return, in pixels, the height of the highest item in the given row.

initialiseComponentsSource

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

resetListSource

Arguments

:: HG3DClass

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

-> IO () 

Removes a column from the list box. This will cause any ListboxItem

removeColumnSource

Arguments

:: HG3DClass

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

-> Int

col_idx - Zero based index of the column to be removed.

-> IO ()

return value - Nothing.

Removes a column from the list box. This will cause any ListboxItem

removeColumnWithIDSource

Arguments

:: HG3DClass

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

-> Int

col_id - ID code of the column to be deleted.

-> IO ()

return value - Nothing.

Move the column at index col_idxposition

moveColumnSource

Arguments

:: HG3DClass

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

-> Int

col_idx - Zero based index of the column to be moved.

-> Int

position - Zero based index of the new position for the column.

-> IO ()

return value - Nothing.

Move the column with ID col_idposition

moveColumnWithIDSource

Arguments

:: HG3DClass

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

-> Int

col_id - ID code of the column to be moved.

-> Int

position - Zero based index of the new position for the column.

-> IO ()

return value - Nothing.

Add an empty row to the list box. - Details: If the list is being sorted, the new row will appear at an appropriate position according to the sorting being applied. If no sorting is being done, the new row will appear at the bottom of the list.

addRowSource

Arguments

:: HG3DClass

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

-> Int

row_id - ID code to be assigned to the new row.

-> IO Int

return value - Initial zero based index of the new row.

addRow2Source

Arguments

:: HG3DClass

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

-> HG3DClass

item - Pointer to a ListboxItem to be used as the initial contents for the column with ID col_id.

-> Int

col_id - ID code of the column whos initial item is to be set to item.

-> Int

row_id - ID code to be assigned to the new row.

-> IO Int

return value - Initial zero based index of the new row.

Add a row to the list box, and set the item in the column with ID col_iditem - Details: If the list is being sorted, the new row will appear at an appropriate position according to the sorting being applied. If no sorting is being done, the new row will appear at the bottom of the list.

insertRowSource

Arguments

:: HG3DClass

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

-> Int

row_idx - Zero based index where the row should be inserted. If this is greater than the current number of rows, the row is appended to the list.

-> Int

row_id - ID code to be assigned to the new row.

-> IO Int

return value - Zero based index where the row was actually inserted.

Insert an empty row into the list box. - Details: If the list is being sorted, the new row will appear at an appropriate position according to the sorting being applied. If no sorting is being done, the new row will appear at the specified index.

insertRow2Source

Arguments

:: HG3DClass

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

-> HG3DClass

item - Pointer to a ListboxItem to be used as the initial contents for the column with ID col_id.

-> Int

col_id - ID code of the column whos initial item is to be set to item.

-> Int

row_idx - Zero based index where the row should be inserted. If this is greater than the current number of rows, the row is appended to the list.

-> Int

row_id - ID code to be assigned to the new row.

-> IO Int

return value - Zero based index where the row was actually inserted.

Insert a row into the list box, and set the item in the column with ID col_iditem - Details: If the list is being sorted, the new row will appear at an appropriate position according to the sorting being applied. If no sorting is being done, the new row will appear at the specified index.

removeRowSource

Arguments

:: HG3DClass

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

-> Int

row_idx - Zero based index of the row to be removed.

-> IO ()

return value - Nothing.

Set the ListboxItemcol_idrow_idx

Remove the list box row with index row_idxListboxItemrow_idx

setItem2Source

Arguments

:: HG3DClass

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

-> HG3DClass

item - Pointer to the ListboxItem to be set into the list.

-> Int

col_id - ID code of the column to receive item.

-> Int

row_idx - Zero based index of the row to receive item.

-> IO ()

return value - Nothing.

Set the selection mode for the list box.

setSelectionModeSource

Arguments

:: HG3DClass

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

-> EnumSelectionMode

sel_mode - One of the MultiColumnList::SelectionMode enumerated values specifying the selection mode to be used.

-> IO ()

return value - Nothing.

Set the column to be used for the NominatedColumn* selection modes.

setNominatedSelectionColumnIDSource

Arguments

:: HG3DClass

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

-> Int

col_id - ID code of the column to be used in NominatedColumn* selection modes.

-> IO ()

return value - Nothing.

Set the column to be used for the NominatedColumn* selection modes.

setNominatedSelectionColumnSource

Arguments

:: HG3DClass

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

-> Int

col_idx - zero based index of the column to be used in NominatedColumn* selection modes.

-> IO ()

return value - Nothing.

Set the row to be used for the NominatedRow* selection modes.

setNominatedSelectionRowSource

Arguments

:: HG3DClass

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

-> Int

row_idx - zero based index of the row to be used in NominatedRow* selection modes.

-> IO ()

return value - Nothing.

Set the sort direction to be used.

setSortDirectionSource

Arguments

:: HG3DClass

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

-> EnumSortDirection

direction - One of the ListHeaderSegment::SortDirection enumerated values specifying the sort direction to be used.

-> IO ()

return value - Nothing.

Set the column to be used as the sort key.

setSortColumnSource

Arguments

:: HG3DClass

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

-> Int

col_idx - Zero based index of the column to use as the key when sorting the list items.

-> IO ()

return value - Nothing.

Set the column to be used as the sort key.

setSortColumnByIDSource

Arguments

:: HG3DClass

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

-> Int

col_id - ID code of the column to use as the key when sorting the list items.

-> IO ()

return value - Nothing.

Set whether the vertical scroll bar should always be shown, or just when needed.

setShowVertScrollbarSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set whether the horizontal scroll bar should always be shown, or just when needed.

setShowHorzScrollbarSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Removed the selected state from any currently selected ListboxItem

clearAllSelectionsSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing.

Sets or clears the selected state of the given ListboxItem - Details: Depending upon the current selection mode, this may cause other items to be selected, other items to be deselected, or for nothing to actually happen at all.

setItemSelectStateSource

Arguments

:: HG3DClass

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

-> HG3DClass

item - Pointer to the attached ListboxItem to be affected.

-> Bool

state -

-> IO ()

return value - Nothing.

Inform the list box that one or more attached ListboxItems have been externally modified, and the list should re-sync its internal state and refresh the display as needed.

handleUpdatedItemDataSource

Arguments

:: HG3DClass

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

-> IO ()

return value - Nothing.

Set whether user manipulation of the sort column and direction are enabled.

setUserSortControlEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set whether the user may size column segments.

setUserColumnSizingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO ()

return value - Nothing.

Set whether the user may modify the order of the columns.

setUserColumnDraggingEnabledSource

Arguments

:: HG3DClass

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

-> Bool

setting -

-> IO () 

Automatically determines the best fit size for the specified column and sets the column width to the same.

autoSizeColumnHeaderSource

Arguments

:: HG3DClass

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

-> Int

col_idx - Zero based index of the column to be sized.

-> IO ()

return value - Nothing.

Set the ID code assigned to a given row.

setRowIDSource

Arguments

:: HG3DClass

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

-> Int

row_idx - Zero based index of the row who's ID code is to be set.

-> Int

row_id - ID code to be assigned to the row at the requested index.

-> IO ()

return value - Nothing.

Constructor for the Multi-column list base class.

newSource

Arguments

:: String

type

-> String

name

-> IO HG3DClass 

deleteSource

Arguments

:: HG3DClass

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

-> IO () 

Destructor for the multi-column list base class.