DigitalSpaces::DICEGUIListHeader Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
unsigned int	getColumnCount ()
	Return the number of columns or segments attached to the header.
DICEGUIListHeaderSegment *	getSegmentFromColumn (unsigned int column)
	Return the ListHeaderSegment object for the specified column.
DICEGUIListHeaderSegment *	getSegmentFromID (unsigned int id)
	Return the ListHeaderSegment object with the specified ID.
DICEGUIListHeaderSegment *	getSortSegment ()
	Return the ListHeaderSegment that is marked as being the 'sort key' segment. There must be at least one segment to successfully call this method.
unsigned int	getColumnFromSegment (DICEGUIListHeaderSegment *segment)
	Return the zero based column index of the specified segment.
unsigned int	getColumnFromID (unsigned int id)
	Return the zero based column index of the segment with the specified ID.
unsigned int	getSortColumn ()
	Return the zero based index of the current sort column. There must be at least one segment/column to successfully call this method.
unsigned int	getColumnWithText (const char *text)
	Return the zero based column index of the segment with the specified text.
float	getPixelOffsetToSegment (DICEGUIListHeaderSegment *segment)
	Return the pixel offset to the given ListHeaderSegment.
float	getPixelOffsetToColumn (unsigned int column)
	Return the pixel offset to the ListHeaderSegment at the given zero based column index.
float	getTotalSegmentsPixelExtent ()
	Return the total pixel width of all attached segments.
void	getColumnWidth (unsigned int column, out_Pairf *width)
	Return the width of the specified column.
CEGUIListHeaderSegmentSortDirection	getSortDirection ()
	Return the currently set sort direction.
bool	isSortingEnabled ()
	Return whether user manipulation of the sort column & direction are enabled.
bool	isColumnSizingEnabled ()
	Return whether the user may size column segments.
bool	isColumnDraggingEnabled ()
	Return whether the user may modify the order of the segments.
float	getSegmentOffset ()
	Return the current segment offset value. This value is used to implement scrolling of the header segments within the ListHeader area.
void	setSortingEnabled (bool setting)
	Set whether user manipulation of the sort column and direction is enabled.
void	setSortDirection (CEGUIListHeaderSegmentSortDirection direction)
	Set the current sort direction.
void	setSortSegment (DICEGUIListHeaderSegment *segment)
	Set the column segment to be used as the sort column.
void	setSortColumn (unsigned int column)
	Set the column to be used as the sort column.
void	setSortColumnFromID (unsigned int id)
	Set the column to to be used for sorting via its ID code.
void	setColumnSizingEnabled (bool setting)
	Set whether columns may be sized by the user.
void	setColumnDraggingEnabled (bool setting)
	Set whether columns may be reordered by the user via drag and drop.
void	addColumn (const char *text, unsigned int id, in_Pairf *width)
	Add a new column segment to the end of the header.
void	insertColumn (const char *text, unsigned int id, in_Pairf *width, unsigned int position)
	Insert a new column segment at the specified position.
void	insertColumn (const char *text, unsigned int id, in_Pairf *width, DICEGUIListHeaderSegment *position)
	Insert a new column segment at the specified position.
void	removeColumn (unsigned int column)
	Removes a column segment from the ListHeader.
void	removeSegment (DICEGUIListHeaderSegment *segment)
	Remove the specified segment from the ListHeader.
void	moveColumn (unsigned int column, unsigned int position)
	Moves a column segment into a new position.
void	moveColumn (unsigned int column, DICEGUIListHeaderSegment *position)
	Move a column segment to a new position.
void	moveSegment (DICEGUIListHeaderSegment *segment, unsigned int position)
	Moves a segment into a new position.
void	moveSegment (DICEGUIListHeaderSegment *segment, DICEGUIListHeaderSegment *position)
	Move a segment to a new position.
void	setSegmentOffset (float offset)
	Set the current base segment offset. (This implements scrolling of the header segments within the header area).
void	setColumnWidth (unsigned int column, in_Pairf *width)
	Set the width of the specified column.

---

Member Function Documentation

unsigned int DigitalSpaces::DICEGUIListHeader::getColumnCount

(

)

Return the number of columns or segments attached to the header.

Returns:

unsigned int value equal to the number of columns / segments currently in the header.

DICEGUIListHeaderSegment* DigitalSpaces::DICEGUIListHeader::getSegmentFromColumn

(

unsigned int

column

)

Return the ListHeaderSegment object for the specified column.

Parameters:

column

zero based column index of the ListHeaderSegment to be returned.

Returns:

ListHeaderSegment object at the requested index.

Exceptions:

InvalidRequestException

thrown if column is out of range.

DICEGUIListHeaderSegment* DigitalSpaces::DICEGUIListHeader::getSegmentFromID

(

unsigned int

id

)

Return the ListHeaderSegment object with the specified ID.

Parameters:

id

id code of the ListHeaderSegment to be returned.

Returns:

ListHeaderSegment object with the ID id. If more than one segment has the same ID, only the first one will ever be returned.

Exceptions:

InvalidRequestException

thrown if no segment with the requested ID is attached.

DICEGUIListHeaderSegment* DigitalSpaces::DICEGUIListHeader::getSortSegment

(

)

Return the ListHeaderSegment that is marked as being the 'sort key' segment. There must be at least one segment to successfully call this method.

Returns:

ListHeaderSegment object which is the sort-key segment.

Exceptions:

InvalidRequestException

thrown if no segments are attached to the ListHeader.

unsigned int DigitalSpaces::DICEGUIListHeader::getColumnFromSegment

(

DICEGUIListHeaderSegment *

segment

)

Return the zero based column index of the specified segment.

Parameters:

segment

ListHeaderSegment whos zero based index is to be returned.

Returns:

Zero based column index of the ListHeaderSegment segment.

Exceptions:

InvalidRequestException

thrown if segment is not attached to this ListHeader.

unsigned int DigitalSpaces::DICEGUIListHeader::getColumnFromID

(

unsigned int

id

)

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

Parameters:

id

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

Returns:

Zero based column index of the first ListHeaderSegment whos ID matches id.

Exceptions:

InvalidRequestException

thrown if no attached segment has the requested ID.

unsigned int DigitalSpaces::DICEGUIListHeader::getSortColumn

(

)

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

Returns:

Zero based column index that is the current sort column.

Exceptions:

InvalidRequestException

thrown if there are no segments / columns in this ListHeader.

unsigned int DigitalSpaces::DICEGUIListHeader::getColumnWithText

(

const char *

text

)

Return the zero based column index of the segment with the specified text.

Parameters:

text

String object containing the text to be searched for.

Returns:

Zero based column index of the segment with the specified text.

Exceptions:

InvalidRequestException

thrown if no attached segments have the requested text.

float DigitalSpaces::DICEGUIListHeader::getPixelOffsetToSegment

(

DICEGUIListHeaderSegment *

segment

)

Return the pixel offset to the given ListHeaderSegment.

Parameters:

segment

ListHeaderSegment object that the offset to is to be returned.

Returns:

The number of pixels up-to the begining of the ListHeaderSegment described by segment.

Exceptions:

InvalidRequestException

thrown if segment is not attached to the ListHeader.

float DigitalSpaces::DICEGUIListHeader::getPixelOffsetToColumn

(

unsigned int

column

)

Return the pixel offset to the ListHeaderSegment at the given zero based column index.

Parameters:

column

Zero based column index of the ListHeaderSegment whos pixel offset it to be returned.

Returns:

The number of pixels up-to the begining of the ListHeaderSegment located at zero based column index column.

Exceptions:

InvalidRequestException

thrown if column is out of range.

float DigitalSpaces::DICEGUIListHeader::getTotalSegmentsPixelExtent

(

)

Return the total pixel width of all attached segments.

Returns:

Sum of the pixel widths of all attached ListHeaderSegment objects.

void DigitalSpaces::DICEGUIListHeader::getColumnWidth	(	unsigned int	column,
		out_Pairf *	width
	)

Return the width of the specified column.

Parameters:

column

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

Returns:

UDim describing the width of the ListHeaderSegment at the zero based column index specified by column.

Exceptions:

InvalidRequestException

thrown if column is out of range.

CEGUIListHeaderSegmentSortDirection DigitalSpaces::DICEGUIListHeader::getSortDirection

(

)

Return the currently set sort direction.

Returns:

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

bool DigitalSpaces::DICEGUIListHeader::isSortingEnabled

(

)

Return whether user manipulation of the sort column & 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::DICEGUIListHeader::isColumnSizingEnabled

(

)

Return whether the user may size column segments.

Returns:

true if the user may interactively modify the width of column segments, false if they may not.

bool DigitalSpaces::DICEGUIListHeader::isColumnDraggingEnabled

(

)

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

Returns:

true if the user may interactively modify the order of the column segments, false if they may not.

float DigitalSpaces::DICEGUIListHeader::getSegmentOffset

(

)

Return the current segment offset value. This value is used to implement scrolling of the header segments within the ListHeader area.

Returns:

float value specifying the current segment offset value in whatever metrics system is active for the ListHeader.

void DigitalSpaces::DICEGUIListHeader::setSortingEnabled

(

bool

setting

)

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

Parameters:

setting

true to allow interactive user manipulation of the sort column and direction. false to disallow interactive user manipulation of the sort column and direction.

Returns:

Nothing.

void DigitalSpaces::DICEGUIListHeader::setSortDirection

(

CEGUIListHeaderSegmentSortDirection

direction

)

Set the current sort direction.

Parameters:

direction

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

Returns:

Nothing.

void DigitalSpaces::DICEGUIListHeader::setSortSegment

(

DICEGUIListHeaderSegment *

segment

)

Set the column segment to be used as the sort column.

Parameters:

segment

ListHeaderSegment object indicating the column to be sorted.

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if segment is not attached to this ListHeader.

void DigitalSpaces::DICEGUIListHeader::setSortColumn

(

unsigned int

column

)

Set the column to be used as the sort column.

Parameters:

column

Zero based column index indicating the column to be sorted.

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if column is out of range for this ListHeader.

void DigitalSpaces::DICEGUIListHeader::setSortColumnFromID

(

unsigned int

id

)

Set the column to to be used for sorting via its ID code.

Parameters:

id

ID code of the column segment that is to be used as the sort column.

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if no segment with ID id is attached to the ListHeader.

void DigitalSpaces::DICEGUIListHeader::setColumnSizingEnabled

(

bool

setting

)

Set whether columns may be sized by the user.

Parameters:

setting

true to indicate that the user may interactively size segments. false to indicate that the user may not interactively size segments.

Returns:

Nothing.

void DigitalSpaces::DICEGUIListHeader::setColumnDraggingEnabled

(

bool

setting

)

Set whether columns may be reordered by the user via drag and drop.

Parameters:

setting

true to indicate the user may change the order of the column segments via drag and drop. false to indicate the user may not change the column segment order.

Returns:

Nothing.

void DigitalSpaces::DICEGUIListHeader::addColumn	(	const char *	text,
		unsigned int	id,
		in_Pairf *	width
	)

Add a new column segment to the end of the header.

Parameters:

	text	String object holding the initial text for the new segment
	id	Client specified ID code to be assigned to the new segment.
	width	UDim describing the initial width of the new segment.

Returns:

Nothing.

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

Insert a new column segment at the specified position.

Parameters:

	text	String object holding the initial text for the new segment
	id	Client specified ID code to be assigned to the new segment.
	width	UDim describing the initial width of the new segment.
	position	Zero based column index indicating the desired position for the new column. If this is greater than the current number of columns, the new segment is added to the end if the header.

Returns:

Nothing.

void DigitalSpaces::DICEGUIListHeader::insertColumn	(	const char *	text,
		unsigned int	id,
		in_Pairf *	width,
		DICEGUIListHeaderSegment *	position
	)

Insert a new column segment at the specified position.

Parameters:

	text	String object holding the initial text for the new segment
	id	Client specified ID code to be assigned to the new segment.
	width	UDim describing the initial width of the new segment.
	position	ListHeaderSegment object indicating the insert position for the new segment. The new segment will be inserted before the segment indicated by position.

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if ListHeaderSegment position is not attached to the ListHeader.

void DigitalSpaces::DICEGUIListHeader::removeColumn

(

unsigned int

column

)

Removes a column segment from the ListHeader.

Parameters:

column

Zero based column index indicating the segment to be removed.

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if column is out of range.

void DigitalSpaces::DICEGUIListHeader::removeSegment

(

DICEGUIListHeaderSegment *

segment

)

Remove the specified segment from the ListHeader.

Parameters:

segment

ListHeaderSegment object that is to be removed from the ListHeader.

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if segment is not attached to this ListHeader.

void DigitalSpaces::DICEGUIListHeader::moveColumn	(	unsigned int	column,
		unsigned int	position
	)

Moves a column segment into a new position.

Parameters:

	column	Zero based column index indicating the column segment to be moved.
	position	Zero based column index indicating the new position for the segment. If this is greater than the current number of segments, the segment is moved to the end of the header.

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if column is out of range for this ListHeader.

void DigitalSpaces::DICEGUIListHeader::moveColumn	(	unsigned int	column,
		DICEGUIListHeaderSegment *	position
	)

Move a column segment to a new position.

Parameters:

	column	Zero based column index indicating the column segment to be moved.
	position	ListHeaderSegment object indicating the new position for the segment. The segment at column will be moved behind segment position (that is, segment column will appear to the right of segment position).

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if column is out of range for this ListHeader, or if position is not attached to this ListHeader.

void DigitalSpaces::DICEGUIListHeader::moveSegment	(	DICEGUIListHeaderSegment *	segment,
		unsigned int	position
	)

Moves a segment into a new position.

Parameters:

	segment	ListHeaderSegment object that is to be moved.
	position	Zero based column index indicating the new position for the segment. If this is greater than the current number of segments, the segment is moved to the end of the header.

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if segment is not attached to this ListHeader.

void DigitalSpaces::DICEGUIListHeader::moveSegment	(	DICEGUIListHeaderSegment *	segment,
		DICEGUIListHeaderSegment *	position
	)

Move a segment to a new position.

Parameters:

	segment	ListHeaderSegment object that is to be moved.
	position	ListHeaderSegment object indicating the new position for the segment. The segment segment will be moved behind segment position (that is, segment segment will appear to the right of segment position).

Returns:

Nothing.

Exceptions:

InvalidRequestException

thrown if either segment or position are not attached to this ListHeader.

void DigitalSpaces::DICEGUIListHeader::setSegmentOffset

(

float

offset

)

Set the current base segment offset. (This implements scrolling of the header segments within the header area).

Parameters:

offset

New base offset for the first segment. The segments will of offset to the left by the amount specified. offset should be specified using the active metrics system for the ListHeader.

Returns:

Nothing.

void DigitalSpaces::DICEGUIListHeader::setColumnWidth	(	unsigned int	column,
		in_Pairf *	width
	)

Set the width of the specified column.

Parameters:

	column	Zero based column index of the segment whose width is to be set.
	width	UDim value specifying the new width to set for the ListHeaderSegment at the zero based column index specified by column.

Returns:

Nothing

Exceptions:

InvalidRequestException

thrown if column is out of range.

---

The documentation for this struct was generated from the following file:

• CEGUIInterfaces/CEGUIInterfaces.h