DigitalSpaces::DICEGUIMultiColumnList Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Detailed Description

{7927AD95-33E2-41e6-9C69-B76CD8F21C46}


Public Member Functions
bool	isUserSortControlEnabled ()
	Return whether user manipulation of the sort column and direction are enabled.
bool	isUserColumnSizingEnabled ()
	Return whether the user may size column segments.
bool	isUserColumnDraggingEnabled ()
	Return whether the user may modify the order of the columns.
unsigned int	getColumnCount ()
	Return the number of columns in the multi-column list.
unsigned int	getRowCount ()
	Return the number of rows in the multi-column list.
unsigned int	getSortColumn ()
	Return the zero based index of the current sort column. There must be at least one column to successfully call this method.
unsigned int	getColumnWithID (unsigned int col_id)
	Return the zero based column index of the column with the specified ID.
unsigned int	getColumnWithHeaderText (const char *text)
	Return the zero based index of the column whos header text matches the specified text.
void	getTotalColumnHeadersWidth (out_Pairf *width)
	Return the total width of all column headers.
void	getColumnHeaderWidth (unsigned int col_idx, out_Pairf *width)
	Return the width of the specified column header (and therefore the column itself).
CEGUIListHeaderSegmentSortDirection	getSortDirection ()
	Return the currently set sort direction.
DICEGUIListHeaderSegment *	getHeaderSegmentForColumn (unsigned int col_idx)
	Return the ListHeaderSegment object for the specified column.
unsigned int	getItemRowIndex (DICEGUIListboxItem *item)
	Return the zero based index of the Row that contains item.
unsigned int	getItemColumnIndex (DICEGUIListboxItem *item)
	Return the current zero based index of the column that contains item.
bool	isListboxItemInColumn (DICEGUIListboxItem *item, unsigned int col_idx)
	Return the grid reference for item.
bool	isListboxItemInRow (DICEGUIListboxItem *item, unsigned int row_idx)
	return whether ListboxItem item is attached to the row at index row_idx.
bool	isListboxItemInList (DICEGUIListboxItem *item)
	return whether ListboxItem item is attached to the list box.
DICEGUIListboxItem *	findColumnItemWithText (const char text, unsigned int col_idx, DICEGUIListboxItem start_item)
	Return the ListboxItem in column col_idx that has the text string text.
DICEGUIListboxItem *	findRowItemWithText (const char text, unsigned int row_idx, DICEGUIListboxItem start_item)
	Return the ListboxItem in row row_idx that has the text string text.
DICEGUIListboxItem *	findListItemWithText (const char text, DICEGUIListboxItem start_item)
	Return the ListboxItem that has the text string text.
DICEGUIListboxItem *	getFirstSelectedItem ()
	Return a pointer to the first selected ListboxItem attached to this list box.
DICEGUIListboxItem *	getNextSelected (DICEGUIListboxItem *start_item)
	Return a pointer to the next selected ListboxItem after start_item.
unsigned int	getSelectedCount ()
	Return the number of selected ListboxItems attached to this list box.
unsigned int	getNominatedSelectionColumnID ()
	Return whether the ListboxItem at grid_ref is selected.
unsigned int	getNominatedSelectionColumn ()
	Return the index of the currently set nominated selection column to be used when in one of the NominatedColumn* selection modes.
unsigned int	getNominatedSelectionRow ()
	Return the index of the currently set nominated selection row to be used when in one of the NominatedRow* selection modes.
CEGUIMultiColumnListSelectionMode	getSelectionMode ()
	Return the currently set selection mode.
bool	isVertScrollbarAlwaysShown ()
	Return whether the vertical scroll bar is always shown.
bool	isHorzScrollbarAlwaysShown ()
	Return whether the horizontal scroll bar is always shown.
unsigned int	getColumnID (unsigned int col_idx)
	Return the ID code assigned to the requested column.
unsigned int	getRowID (unsigned int row_idx)
	Return the ID code assigned to the requested row.
unsigned int	getRowWithID (unsigned int row_id)
	Return the zero based row index of the row with the specified ID.
void	getListRenderArea (out_Vector4f *area)
	Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.
DICEGUIScrollbar *	getVertScrollbar ()
	Return a pointer to the vertical scrollbar component widget for this MultiColumnList.
DICEGUIScrollbar *	getHorzScrollbar ()
	Return a pointer to the horizontal scrollbar component widget for this MultiColumnList.
DICEGUIListHeader *	getListHeader ()
	Return a pointer to the list header component widget for this MultiColumnList.
float	getTotalRowsHeight ()
	Return the sum of all row heights in pixels.
float	getWidestColumnItemWidth (unsigned int col_idx)
	Return the pixel width of the widest item in the given column.
float	getHighestRowItemHeight (unsigned int row_idx)
	Return, in pixels, the height of the highest item in the given row.
void	initialiseComponents ()
	Initialise the Window based object ready for use.
void	resetList ()
	Remove all items from the list.
void	addColumn (const char text, unsigned int col_id, in_Pairf width)
	Add a column to the list box.
void	insertColumn (const char text, unsigned int col_id, in_Pairf width, unsigned int position)
	Insert a new column in the list.
void	removeColumn (unsigned int col_idx)
	Removes a column from the list box. This will cause any ListboxItem using the autoDelete option in the column to be deleted.
void	removeColumnWithID (unsigned int col_id)
	Removes a column from the list box. This will cause any ListboxItem using the autoDelete option in the column to be deleted.
void	moveColumn (unsigned int col_idx, unsigned int position)
	Move the column at index col_idx so it is at index position.
void	moveColumnWithID (unsigned int col_id, unsigned int position)
	Move the column with ID col_id so it is at index position.
unsigned int	addRow ()
	Add an empty row to the list box.
unsigned int	addRow (unsigned int row_id)
unsigned int	addRow (DICEGUIListboxItem *item, unsigned int col_id)
	Add a row to the list box, and set the item in the column with ID col_id to item.
unsigned int	addRow (DICEGUIListboxItem *item, unsigned int col_id, unsigned int row_id)
unsigned int	insertRow (unsigned int row_idx)
	Insert an empty row into the list box.
unsigned int	insertRow (unsigned int row_idx, unsigned int row_id)
unsigned int	insertRow (DICEGUIListboxItem *item, unsigned int col_id, unsigned int row_idx)
	Insert a row into the list box, and set the item in the column with ID col_id to item.
unsigned int	insertRow (DICEGUIListboxItem *item, unsigned int col_id, unsigned int row_idx, unsigned int row_id)
void	removeRow (unsigned int row_idx)
	Remove the list box row with index row_idx. Any ListboxItem in row row_idx using autoDelete mode will be deleted.
void	setItem (DICEGUIListboxItem *item, unsigned int col_id, unsigned int row_idx)
	Set the ListboxItem for grid reference position.
void	setSelectionMode (CEGUIMultiColumnListSelectionMode sel_mode)
	Set the selection mode for the list box.
void	setNominatedSelectionColumnID (unsigned int col_id)
	Set the column to be used for the NominatedColumn* selection modes.
void	setNominatedSelectionColumn (unsigned int col_idx)
	Set the column to be used for the NominatedColumn* selection modes.
void	setNominatedSelectionRow (unsigned int row_idx)
	Set the row to be used for the NominatedRow* selection modes.
void	setSortDirection (CEGUIListHeaderSegmentSortDirection direction)
	Set the sort direction to be used.
void	setSortColumn (unsigned int col_idx)
	Set the column to be used as the sort key.
void	setSortColumnByID (unsigned int col_id)
	Set the column to be used as the sort key.
void	setShowVertScrollbar (bool setting)
	Set whether the vertical scroll bar should always be shown, or just when needed.
void	setShowHorzScrollbar (bool setting)
	Set whether the horizontal scroll bar should always be shown, or just when needed.
void	clearAllSelections ()
	Removed the selected state from any currently selected ListboxItem attached to the list.
void	setItemSelectState (DICEGUIListboxItem *item, bool state)
	Sets or clears the selected state of the given ListboxItem which must be attached to the list.
void	handleUpdatedItemData ()
	Sets or clears the selected state of the ListboxItem at the given grid reference.
void	setColumnHeaderWidth (unsigned int col_idx, in_Pairf *width)
	Set the width of the specified column header (and therefore the column itself).
void	setUserSortControlEnabled (bool setting)
	Set whether user manipulation of the sort column and direction are enabled.
void	setUserColumnSizingEnabled (bool setting)
	Set whether the user may size column segments.
void	setUserColumnDraggingEnabled (bool setting)
	Set whether the user may modify the order of the columns.
void	autoSizeColumnHeader (unsigned int col_idx)
	Automatically determines the "best fit" size for the specified column and sets the column width to the same.
void	setRowID (unsigned int row_idx, unsigned int row_id)
	Set the ID code assigned to a given row.
DICEGUIListboxItem *	createTextItem (const char *text)

Member Function Documentation

bool DigitalSpaces::DICEGUIMultiColumnList::isUserSortControlEnabled ( )

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

Returns:: 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).

bool DigitalSpaces::DICEGUIMultiColumnList::isUserColumnSizingEnabled ( )

Return whether the user may size column segments.

Returns:: true if the user may interactively modify the width of columns, false if they may not.

bool DigitalSpaces::DICEGUIMultiColumnList::isUserColumnDraggingEnabled ( )

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

Returns:: true if the user may interactively modify the order of the columns, false if they may not.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getColumnCount ( )

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

Returns:: unsigned int value equal to the number of columns in the list.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getRowCount ( )

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

Returns:: unsigned int value equal to the number of rows currently in the list.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getSortColumn ( )

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

Returns:: Zero based column index that is the current sort column.

Exceptions:

InvalidRequestException

thrown if there are no columns in this multi column list.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getColumnWithID ( unsigned int col_id )

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

Parameters:

col_id

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

Returns:: Zero based column index of the first column whos ID matches col_id.

Exceptions:

InvalidRequestException

thrown if no attached column has the requested ID.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getColumnWithHeaderText ( const char * text )

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

Parameters:

text

String object containing the text to be searched for.

Returns:: Zero based column index of the column whos header has the specified text.

Exceptions:

InvalidRequestException

thrown if no columns header has the requested text.

void DigitalSpaces::DICEGUIMultiColumnList::getTotalColumnHeadersWidth ( out_Pairf * width )

Return the total width of all column headers.

Returns:: Sum total of all the column header widths as a UDim.

void DigitalSpaces::DICEGUIMultiColumnList::getColumnHeaderWidth	(	unsigned int	col_idx,
		out_Pairf *	width
	)

Return the width of the specified column header (and therefore the column itself).

Parameters:

col_idx

Zero based column index of the column whos width is to be returned.

Returns:: Width of the column header at the zero based column index specified by col_idx, as a UDim

Exceptions:

InvalidRequestException

thrown if column is out of range.

CEGUIListHeaderSegmentSortDirection DigitalSpaces::DICEGUIMultiColumnList::getSortDirection ( )

Return the currently set sort direction.

Returns:: One of the ListHeaderSegment::SortDirection enumerated values specifying the current sort direction.

DICEGUIListHeaderSegment* DigitalSpaces::DICEGUIMultiColumnList::getHeaderSegmentForColumn ( unsigned int col_idx )

Return the ListHeaderSegment object for the specified column.

Parameters:

col_idx

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

Returns:: ListHeaderSegment object for the column at the requested index.

Exceptions:

InvalidRequestException

thrown if col_idx is out of range.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getItemRowIndex ( DICEGUIListboxItem * item )

Return the zero based index of the Row that contains item.

Parameters:

item

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

Returns:: Zero based index of the row that contains ListboxItem item.

Exceptions:

InvalidRequestException

thrown if item is not attached to the list box.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getItemColumnIndex ( DICEGUIListboxItem * item )

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

Parameters:

item

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

Returns:: Zero based index of the column that contains ListboxItem item.

Exceptions:

InvalidRequestException

thrown if item is not attached to the list box.

bool DigitalSpaces::DICEGUIMultiColumnList::isListboxItemInColumn	(	DICEGUIListboxItem *	item,
		unsigned int	col_idx
	)

Return the grid reference for item.

Parameters:

item

Pointer to the ListboxItem whos current grid reference is to be returned.

Returns:: MCLGridRef object describing the current grid reference of ListboxItem item.

Exceptions:

InvalidRequestException

thrown if item is not attached to the list box.

Return a pointer to the ListboxItem at the specified grid reference.

Parameters:

grid_ref

MCLGridRef object that describes the position of the ListboxItem to be returned.

Returns:: Pointer to the ListboxItem at grid reference grid_ref.

Exceptions:

InvalidRequestException

thrown if grid_ref is invalid for this list box.

return whether ListboxItem item is attached to the column at index col_idx.

Parameters:

	item	Pointer to the ListboxItem to look for.
	col_idx	Zero based index of the column that is to be searched.

Returns:

true if item is attached to list box column col_idx.
false if item is not attached to list box column col_idx.

Exceptions:

InvalidRequestException

thrown if col_idx is out of range.

bool DigitalSpaces::DICEGUIMultiColumnList::isListboxItemInRow	(	DICEGUIListboxItem *	item,
		unsigned int	row_idx
	)

return whether ListboxItem item is attached to the row at index row_idx.

Parameters:

	item	Pointer to the ListboxItem to look for.
	row_idx	Zero based index of the row that is to be searched.

Returns:

true if item is attached to list box row row_idx.
false if item is not attached to list box row row_idx.

Exceptions:

InvalidRequestException

thrown if row_idx is out of range.

bool DigitalSpaces::DICEGUIMultiColumnList::isListboxItemInList ( DICEGUIListboxItem * item )

return whether ListboxItem item is attached to the list box.

Parameters:

item

Pointer to the ListboxItem to look for.

Returns:

true if item is attached to list box.
false if item is not attached to list box.

DICEGUIListboxItem* DigitalSpaces::DICEGUIMultiColumnList::findColumnItemWithText	(	const char *	text,
		unsigned int	col_idx,
		DICEGUIListboxItem *	start_item
	)

Return the ListboxItem in column col_idx that has the text string text.

Parameters:

	text	String object containing the text to be searched for.
	col_idx	Zero based index of the column to be searched.
	start_item	Pointer to the ListboxItem where the exclusive search is to start, or NULL to search from the top of the column.

Returns:: Pointer to the first ListboxItem in column col_idx, after start_item, that has the string text.

Exceptions:

InvalidRequestException

thrown if start_item is not attached to the list box, or if col_idx is out of range.

DICEGUIListboxItem* DigitalSpaces::DICEGUIMultiColumnList::findRowItemWithText	(	const char *	text,
		unsigned int	row_idx,
		DICEGUIListboxItem *	start_item
	)

Return the ListboxItem in row row_idx that has the text string text.

Parameters:

	text	String object containing the text to be searched for.
	row_idx	Zero based index of the row to be searched.
	start_item	Pointer to the ListboxItem where the exclusive search is to start, or NULL to search from the start of the row.

Returns:: Pointer to the first ListboxItem in row row_idx, after start_item, that has the string text.

Exceptions:

InvalidRequestException

thrown if start_item is not attached to the list box, or if row_idx is out of range.

DICEGUIListboxItem* DigitalSpaces::DICEGUIMultiColumnList::findListItemWithText	(	const char *	text,
		DICEGUIListboxItem *	start_item
	)

Return the ListboxItem that has the text string text.

Note:: List box searching progresses across the columns in each row.

Parameters:

	text	String object containing the text to be searched for.
	start_item	Pointer to the ListboxItem where the exclusive search is to start, or NULL to search the whole list box.

Returns:: Pointer to the first ListboxItem, after start_item, that has the string text.

Exceptions:

InvalidRequestException

thrown if start_item is not attached to the list box.

DICEGUIListboxItem* DigitalSpaces::DICEGUIMultiColumnList::getFirstSelectedItem ( )

Return a pointer to the first selected ListboxItem attached to this list box.

Note:: List box searching progresses across the columns in each row.

Returns:: Pointer to the first ListboxItem attached to this list box that is selected, or NULL if no item is selected.

DICEGUIListboxItem* DigitalSpaces::DICEGUIMultiColumnList::getNextSelected ( DICEGUIListboxItem * start_item )

Return a pointer to the next selected ListboxItem after start_item.

Note:: List box searching progresses across the columns in each row.

Parameters:

start_item

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

Returns:: Pointer to the first selected ListboxItem attached to this list box, after start_item, or NULL if no item is selected.

Exceptions:

InvalidRequestException

thrown if start_item is not attached to the list box.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getSelectedCount ( )

Return the number of selected ListboxItems attached to this list box.

return unsigned int value equal to the number of ListboxItems attached to this list box that are currently selected.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getNominatedSelectionColumnID ( )

Return whether the ListboxItem at grid_ref is selected.

Parameters:

grid_ref

MCLGridRef object describing the grid reference that is to be examined.

Returns:

true if there is a ListboxItem at grid_ref and it is selected.
false if there is no ListboxItem at grid_ref, or if the item is not selected.

Exceptions:

InvalidRequestException

thrown if grid_ref contains an invalid grid position.

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

Note:: You should only ever call this when getColumnCount() returns > 0.

Returns:: ID code of the nominated selection column.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getNominatedSelectionColumn ( )

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

Returns:: Zero based index of the nominated selection column.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getNominatedSelectionRow ( )

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

Returns:: Zero based index of the nominated selection column.

CEGUIMultiColumnListSelectionMode DigitalSpaces::DICEGUIMultiColumnList::getSelectionMode ( )

Return the currently set selection mode.

Returns:: One of the MultiColumnList::SelectionMode enumerated values specifying the current selection mode.

bool DigitalSpaces::DICEGUIMultiColumnList::isVertScrollbarAlwaysShown ( )

Return whether the vertical scroll bar is always shown.

Returns:

true if the scroll bar will always be shown even if it is not required.
false if the scroll bar will only be shown when it is required.

bool DigitalSpaces::DICEGUIMultiColumnList::isHorzScrollbarAlwaysShown ( )

Return whether the horizontal scroll bar is always shown.

Returns:

true if the scroll bar will always be shown even if it is not required.
false if the scroll bar will only be shown when it is required.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getColumnID ( unsigned int col_idx )

Return the ID code assigned to the requested column.

Parameters:

col_idx

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

Returns:: Current ID code assigned to the column at the requested index.

Exceptions:

InvalidRequestException

thrown if col_idx is out of range

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getRowID ( unsigned int row_idx )

Return the ID code assigned to the requested row.

Parameters:

row_idx

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

Returns:: Current ID code assigned to the row at the requested index.

Exceptions:

InvalidRequestException

thrown if row_idx is out of range

unsigned int DigitalSpaces::DICEGUIMultiColumnList::getRowWithID ( unsigned int row_id )

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

Parameters:

row_id

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

Returns:: Zero based row index of the first row who's ID matches row_id.

Exceptions:

InvalidRequestException

thrown if no row has the requested ID.

void DigitalSpaces::DICEGUIMultiColumnList::getListRenderArea ( out_Vector4f * area )

Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.

Returns:: Rect object describing the area of the Window to be used for rendering list box items.

DICEGUIScrollbar* DigitalSpaces::DICEGUIMultiColumnList::getVertScrollbar ( )

Return a pointer to the vertical scrollbar component widget for this MultiColumnList.

Returns:: Pointer to a Scrollbar object.

Exceptions:

UnknownObjectException

Thrown if the vertical Scrollbar component does not exist.

DICEGUIScrollbar* DigitalSpaces::DICEGUIMultiColumnList::getHorzScrollbar ( )

Return a pointer to the horizontal scrollbar component widget for this MultiColumnList.

Returns:: Pointer to a Scrollbar object.

Exceptions:

UnknownObjectException

Thrown if the horizontal Scrollbar component does not exist.

DICEGUIListHeader* DigitalSpaces::DICEGUIMultiColumnList::getListHeader ( )

Return a pointer to the list header component widget for this MultiColumnList.

Returns:: Pointer to a ListHeader object.

Exceptions:

UnknownObjectException

Thrown if the list header component does not exist.

float DigitalSpaces::DICEGUIMultiColumnList::getTotalRowsHeight ( )

Return the sum of all row heights in pixels.

float DigitalSpaces::DICEGUIMultiColumnList::getWidestColumnItemWidth ( unsigned int col_idx )

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

float DigitalSpaces::DICEGUIMultiColumnList::getHighestRowItemHeight ( unsigned int row_idx )

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

void DigitalSpaces::DICEGUIMultiColumnList::initialiseComponents ( )

Initialise the Window based object ready for use.

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

Returns:: Nothing

void DigitalSpaces::DICEGUIMultiColumnList::resetList ( )

Remove all items from the list.

Note that this will cause 'AutoDelete' items to be deleted.

void DigitalSpaces::DICEGUIMultiColumnList::addColumn	(	const char *	text,
		unsigned int	col_id,
		in_Pairf *	width
	)

Add a column to the list box.

Parameters:

	text	String object containing the text label for the column header.
	col_id	ID code to be assigned to the column header.
	width	UDim describing the initial width to be set for the column.

Returns:: Nothing.

void DigitalSpaces::DICEGUIMultiColumnList::insertColumn	(	const char *	text,
		unsigned int	col_id,
		in_Pairf *	width,
		unsigned int	position
	)

Insert a new column in the list.

Parameters:

	text	String object containing the text label for the column header.
	col_id	ID code to be assigned to the column header.
	width	UDim describing the initial width to be set for the column.
	position	Zero based index where the column is to be inserted. If this is greater than the current number of columns, the new column is inserted at the end.

Returns:: Nothing.

void DigitalSpaces::DICEGUIMultiColumnList::removeColumn ( unsigned int col_idx )

Removes a column from the list box. This will cause any ListboxItem using the autoDelete option in the column to be deleted.

Parameters:

col_idx

Zero based index of the column to be removed.

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if col_idx is invalid.

void DigitalSpaces::DICEGUIMultiColumnList::removeColumnWithID ( unsigned int col_id )

Removes a column from the list box. This will cause any ListboxItem using the autoDelete option in the column to be deleted.

Parameters:

col_id

ID code of the column to be deleted.

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if no column with col_id is available on this list box.

void DigitalSpaces::DICEGUIMultiColumnList::moveColumn	(	unsigned int	col_idx,
		unsigned int	position
	)

Move the column at index col_idx so it is at index position.

Parameters:

	col_idx	Zero based index of the column to be moved.
	position	Zero based index of the new position for the column.

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if col_idx is invalid.

void DigitalSpaces::DICEGUIMultiColumnList::moveColumnWithID	(	unsigned int	col_id,
		unsigned int	position
	)

Move the column with ID col_id so it is at index position.

Parameters:

	col_id	ID code of the column to be moved.
	position	Zero based index of the new position for the column.

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if no column with col_id is available on this list box.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::addRow ( )

Add an empty row to the list box.

Parameters:

row_id

ID code to be assigned to the new row.

Note:: 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.

Returns:: Initial zero based index of the new row.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::addRow ( unsigned int row_id )

unsigned int DigitalSpaces::DICEGUIMultiColumnList::addRow	(	DICEGUIListboxItem *	item,
		unsigned int	col_id
	)

Add a row to the list box, and set the item in the column with ID col_id to item.

Note:: 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.

Parameters:

	item	Pointer to a ListboxItem to be used as the initial contents for the column with ID col_id.
	col_id	ID code of the column whos initial item is to be set to item.
	row_id	ID code to be assigned to the new row.

Returns:: Initial zero based index of the new row.

Exceptions:

InvalidRequestException

thrown if no column with the specified ID is attached to the list box.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::addRow	(	DICEGUIListboxItem *	item,
		unsigned int	col_id,
		unsigned int	row_id
	)

unsigned int DigitalSpaces::DICEGUIMultiColumnList::insertRow ( unsigned int row_idx )

Insert an empty row into the list box.

Note:: 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.

Parameters:

	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.
	row_id	ID code to be assigned to the new row.

Returns:: Zero based index where the row was actually inserted.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::insertRow	(	unsigned int	row_idx,
		unsigned int	row_id
	)

unsigned int DigitalSpaces::DICEGUIMultiColumnList::insertRow	(	DICEGUIListboxItem *	item,
		unsigned int	col_id,
		unsigned int	row_idx
	)

Insert a row into the list box, and set the item in the column with ID col_id to item.

Note:: 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.

Parameters:

	item	Pointer to a ListboxItem to be used as the initial contents for the column with ID col_id.
	col_id	ID code of the column whos initial item is to be set to item.
	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.
	row_id	ID code to be assigned to the new row.

Returns:: Zero based index where the row was actually inserted.

Exceptions:

InvalidRequestException

thrown if no column with the specified ID is attached to the list box.

unsigned int DigitalSpaces::DICEGUIMultiColumnList::insertRow	(	DICEGUIListboxItem *	item,
		unsigned int	col_id,
		unsigned int	row_idx,
		unsigned int	row_id
	)

void DigitalSpaces::DICEGUIMultiColumnList::removeRow ( unsigned int row_idx )

Remove the list box row with index row_idx. Any ListboxItem in row row_idx using autoDelete mode will be deleted.

Parameters:

row_idx

Zero based index of the row to be removed.

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if row_idx is invalid.

void DigitalSpaces::DICEGUIMultiColumnList::setItem	(	DICEGUIListboxItem *	item,
		unsigned int	col_id,
		unsigned int	row_idx
	)

Set the ListboxItem for grid reference position.

Parameters:

	item	Pointer to the ListboxItem to be set at position.
	position	MCLGridRef describing the grid reference of the item to be set.

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if position contains an invalid grid reference.

Set the ListboxItem for the column with ID col_id in row row_idx.

Parameters:

	item	Pointer to the ListboxItem to be set into the list.
	col_id	ID code of the column to receive item.
	row_idx	Zero based index of the row to receive item.

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if no column with ID col_id exists, or of row_idx is out of range.

void DigitalSpaces::DICEGUIMultiColumnList::setSelectionMode ( CEGUIMultiColumnListSelectionMode sel_mode )

Set the selection mode for the list box.

Parameters:

sel_mode

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

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if the value specified for sel_mode is invalid.

void DigitalSpaces::DICEGUIMultiColumnList::setNominatedSelectionColumnID ( unsigned int col_id )

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

Parameters:

col_id

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

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if no column has ID code col_id.

void DigitalSpaces::DICEGUIMultiColumnList::setNominatedSelectionColumn ( unsigned int col_idx )

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

Parameters:

col_idx

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

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if col_idx is out of range.

void DigitalSpaces::DICEGUIMultiColumnList::setNominatedSelectionRow ( unsigned int row_idx )

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

Parameters:

row_idx

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

Returns:: Nothing.

Exceptions:

InvalidRequestException

thrown if row_idx is out of range.

void DigitalSpaces::DICEGUIMultiColumnList::setSortDirection ( CEGUIListHeaderSegmentSortDirection direction )

Set the sort direction to be used.

Parameters:

direction

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

Returns:: Nothing.

void DigitalSpaces::DICEGUIMultiColumnList::setSortColumn ( unsigned int

DigitalSpaces::DICEGUIMultiColumnList Struct Reference [CEGUI]

Detailed Description

Public Member Functions

Member Function Documentation

DigitalSpaces::DICEGUIMultiColumnList Struct Reference
[CEGUI]