GUI::ListHeader Class Reference

Base class for the multi column list header widget. More...

Inherits GUI::Window.

List of all members.

Public Member Functions
int	getColumnCount ()
	Return the number of columns or segments attached to the header.
ListHeaderSegment	getSegmentFromColumn (int column)
	Return the ListHeaderSegment object for the specified column.
ListHeaderSegment	getSegmentFromID (int id)
	Return the ListHeaderSegment object with the specified ID.
ListHeaderSegment	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.
int	getColumnFromSegment (ListHeaderSegment segment)
	Return the zero based column index of the specified segment.
int	getColumnFromID (int id)
	Return the zero based column index of the segment with the specified ID.
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.
int	getColumnWithText (string text)
	Return the zero based column index of the segment with the specified text.
float	getPixelOffsetToSegment (ListHeaderSegment segment)
	Return the pixel offset to the given ListHeaderSegment.
float	getPixelOffsetToColumn (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.
UDim	getColumnWidth (int column)
	Return the width of the specified column.
int	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 (int direction)
	Set the current sort direction.
void	setSortSegment (ListHeaderSegment segment)
	Set the column segment to be used as the sort column.
void	setSortColumn (int column)
	Set the column to be used as the sort column.
void	setSortColumnFromID (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 (string text, int id, UDim width)
	Add a new column segment to the end of the header.
void	insertColumn (string text, int id, UDim width, int position)
	Insert a new column segment at the specified position.
void	insertColumn (string text, int id, UDim width, ListHeaderSegment position)
	Insert a new column segment at the specified position.
void	removeColumn (int column)
	Removes a column segment from the ListHeader.
void	removeSegment (ListHeaderSegment segment)
	Remove the specified segment from the ListHeader.
void	moveColumn (int column, int position)
	Moves a column segment into a new position.
void	moveColumn (int column, ListHeaderSegment position)
	Move a column segment to a new position.
void	moveSegment (ListHeaderSegment segment, int position)
	Moves a segment into a new position.
void	moveSegment (ListHeaderSegment segment, ListHeaderSegment 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 (int column, UDim width)
	Set the width of the specified column.
Public Member Functions inherited from GUI::Window
string	getType ()
	return a String object holding the type name for this Window.
string	getName ()
	return a String object holding the name of this Window.
bool	isDestroyedByParent ()
	returns whether or not this Window is set to be destroyed when its parent window is destroyed.
bool	isAlwaysOnTop ()
	returns whether or not this Window is an always on top Window. Also known as a top-most window.
bool	isDisabled (bool localOnly=false)
	return whether the Window is currently disabled
bool	isVisible (bool localOnly=false)
	return true if the Window is currently visible.
bool	isActive ()
	return true if this is the active Window. An active window is a window that may receive user inputs.
bool	isClippedByParent ()
	return true if this Window is clipped so that its rendering will not pass outside of its parent Window area.
int	getID ()
	return the ID code currently assigned to this Window by client code.
int	getChildCount ()
	return the number of child Window objects currently attached to this Window.
bool	isChild (string name)
	returns whether a Window with the specified name is currently attached to this Window as a child.
bool	isChild (int ID)
	returns whether at least one window with the given ID code is attached to this Window as a child.
bool	isChildRecursive (int ID)
	returns whether at least one window with the given ID code is attached to this Window or any of it's children as a child.
bool	isChild (Window window)
	return true if the given Window is a child of this window.
Window	getChild (string name)
	return a pointer to the child window with the specified name.
Window	getChild (int ID)
	return a pointer to the first attached child window with the specified ID value.
Window	getChildRecursive (string name)
	return a pointer to the first attached child window with the specified name. Children are traversed recursively.
Window	getChildRecursive (int ID)
	return a pointer to the first attached child window with the specified ID value. Children are traversed recursively.
Window	getChildAtIdx (int idx)
	return a pointer to the child window that is attached to 'this' at the given index.
Window	getActiveChild ()
	return a pointer to the Window that currently has input focus starting with this Window.
bool	isAncestor (string name)
	return true if the specified Window is some ancestor of this Window
bool	isAncestor (int ID)
	return true if any Window with the given ID is some ancestor of this Window.
bool	isAncestor (Window window)
	return true if the specified Window is some ancestor of this Window.
Font	getFont ()
	return the active Font object for the Window.
string	getText ()
	return the current text for the Window
bool	inheritsAlpha ()
	return true if the Window inherits alpha from its parent(s).
float	getAlpha ()
	return the current alpha value set for this Window
float	getEffectiveAlpha ()
	return the effective alpha value that will be used when rendering this window, taking into account inheritance of parent window(s) alpha.
Rect	getPixelRect ()
	return a Rect object describing the Window area in screen space.
Rect	getInnerRect ()
	return a Rect object describing the clipped inner area for this window.
Rect	getUnclippedPixelRect ()
	return a Rect object describing the Window area unclipped, in screen space.
Rect	getUnclippedInnerRect ()
	Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.
Window	getCaptureWindow ()
	return the Window that currently has inputs captured.
bool	isCapturedByThis ()
	return true if this Window has input captured.
bool	isCapturedByAncestor ()
	return true if an ancestor window has captured inputs.
bool	isCapturedByChild (void)
	return true if a child window has captured inputs.
bool	isHit (Vector2 position)
	check if the given pixel position would hit this window.
Window	getChildAtPosition (Vector2 position)
	return the child Window that is hit by the given pixel position
Window	getTargetChildAtPosition (Vector2 position)
	return the child Window that is 'hit' by the given position, and is allowed to handle mouse events.
Window	getParent ()
	return the parent of this Window.
Image	getMouseCursor ()
	Return a pointer to the mouse cursor image to use when the mouse cursor is within this window's area.
bool	restoresOldCapture (void)
	Return whether this window is set to restore old input capture when it loses input capture.
bool	isZOrderingEnabled ()
	Return whether z-order changes are enabled or disabled for this Window.
bool	wantsMultiClickEvents ()
	Return whether this window will receive multi-click events or multiple 'down' events instead.
bool	isMouseAutoRepeatEnabled ()
	Return whether mouse button down event autorepeat is enabled for this window.
float	getAutoRepeatDelay ()
	Return the current auto-repeat delay setting for this window.
float	getAutoRepeatRate ()
	Return the current auto-repeat rate setting for this window.
bool	distributesCapturedInputs ()
	Return whether the window wants inputs passed to its attached child windows when the window has inputs captured.
bool	isUsingDefaultTooltip ()
	Return whether this Window is using the system default Tooltip for its Tooltip window.
Tooltip	getTooltip ()
	Return a pointer to the Tooltip object used by this Window. The value returned may point to the system default Tooltip, a custom Window specific Tooltip, or be NULL.
string	getTooltipType ()
	Return the custom tooltip type.
string	getTooltipText ()
	Return the current tooltip text set for this Window.
bool	inheritsTooltipText ()
	Return whether this window inherits Tooltip text from its parent when its own tooltip text is not set.
bool	isRiseOnClickEnabled ()
	Return whether this window will rise to the top of the z-order when clicked with the left mouse button.
bool	testClassName (string class_name)
	Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
int	getVerticalAlignment ()
	Get the vertical alignment.
int	getHorizontalAlignment ()
	Get the horizontal alignment.
string	getLookNFeel ()
	Get the name of the LookNFeel assigned to this window.
bool	getModalState ()
	Get whether or not this Window is the modal target.
string	getUserString (string name)
	Returns a named user string.
bool	isUserStringDefined (string name)
	Return whether a user string with the specified name exists.
Size	getParentPixelSize ()
	Return the pixel size of the parent element. This always returns a valid object.
float	getParentPixelWidth ()
	Return the pixel Width of the parent element. This always returns a valid number.
float	getParentPixelHeight ()
	Return the pixel Height of the parent element. This always returns a valid number.
bool	isMousePassThroughEnabled ()
	Returns whether this window should ignore mouse event and pass them through to and other windows behind it. In effect making the window transparent to the mouse.
bool	isDragDropTarget ()
	Returns whether this Window object will receive events generated by the drag and drop support in the system.
void	rename (string new_name)
	Renames the window.
void	setDestroyedByParent (bool setting)
	Set whether or not this Window will automatically be destroyed when its parent Window is destroyed.
void	setAlwaysOnTop (bool setting)
	Set whether this window is always on top, or not.
void	setEnabled (bool setting)
	Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering.
void	enable (void)
	enable the Window to allow interaction.
void	disable (void)
	disable the Window to prevent interaction.
void	setVisible (bool setting)
	Set whether the Window is visible or hidden.
void	show (void)
	show the Window.
void	hide (void)
	hide the Window.
void	activate (void)
	Activate the Window giving it input focus and bringing it to the top of all windows with the same always-on-top settig as this Window.
void	deactivate (void)
	Deactivate the window. No further inputs will be received by the window until it is re-activated either programmatically or by the user interacting with the gui.
void	setClippedByParent (bool setting)
	Set whether this Window will be clipped by its parent window(s).
void	setID (int ID)
	Set the current ID for the Window.
void	setText (string text)
	Set the current text string for the Window.
void	insertText (string text, int position)
	Insert the text string text into the current text string for the Window object at the position specified by position.
void	appendText (string text)
	Append the string text to the currect text string for the Window object.
void	setFont (Font font)
	Set the font used by this Window.
void	setFont (string name)
	Set the font used by this Window.
void	addChildWindow (string name)
	Add the named Window as a child of this Window. If the Window name is already attached to a Window, it is detached before being added to this Window.
void	addChildWindow (Window window)
	Add the specified Window as a child of this Window. If the Window window is already attached to a Window, it is detached before being added to this Window.
void	removeChildWindow (string name)
	Remove the named Window from this windows child list.
void	removeChildWindow (Window window)
	Remove the specified Window form this windows child list.
void	removeChildWindow (int ID)
	Remove the first child Window with the specified ID. If there is more than one attached Window objects with the specified ID, only the fist one encountered will be removed.
void	moveToFront ()
	Move the Window to the top of the z order.
void	moveToBack ()
	Move the Window to the bottom of the Z order.
bool	captureInput ()
	Captures input to this window.
void	releaseInput ()
	Releases input capture from this Window. If this Window does not have inputs captured, nothing happens.
void	setRestoreCapture (bool setting)
	Set whether this window will remember and restore the previous window that had inputs captured.
void	setAlpha (float alpha)
	Set the current alpha value for this window.
void	setInheritsAlpha (bool setting)
	Sets whether this Window will inherit alpha from its parent windows.
void	requestRedraw (void)
	Signal the System object to redraw (at least) this Window on the next render cycle.
void	setMouseCursor (string imageset, string image_name)
	Set the mouse cursor image to be used when the mouse enters this window.
void	setZOrderingEnabled (bool setting)
	Set whether z-order changes are enabled or disabled for this Window.
void	setWantsMultiClickEvents (bool setting)
	Set whether this window will receive multi-click events or multiple 'down' events instead.
void	setMouseAutoRepeatEnabled (bool setting)
	Set whether mouse button down event autorepeat is enabled for this window.
void	setAutoRepeatDelay (float delay)
	Set the current auto-repeat delay setting for this window.
void	setAutoRepeatRate (float rate)
	Set the current auto-repeat rate setting for this window.
void	setDistributesCapturedInputs (bool setting)
	Set whether the window wants inputs passed to its attached child windows when the window has inputs captured.
void	notifyDragDropItemEnters (DragContainer item)
	Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
void	notifyDragDropItemLeaves (DragContainer item)
	Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
void	notifyDragDropItemDropped (DragContainer item)
	Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
void	setTooltip (Tooltip tooltip)
	Set the custom Tooltip object for this Window. This value may be 0 to indicate that the Window should use the system default Tooltip object.
void	setTooltipType (string tooltipType)
	Set the custom Tooltip to be used by this Window by specifying a Window type.
void	setTooltipText (string tip)
	Set the tooltip text for this window.
void	setInheritsTooltipText (bool setting)
	Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set.
void	setRiseOnClickEnabled (bool setting)
	Set whether this window will rise to the top of the z-order when clicked with the left mouse button.
void	setVerticalAlignment (int alignment)
	Set the vertical alignment.
void	setHorizontalAlignment (int alignment)
	Set the horizontal alignment.
void	setLookNFeel (string look)
	Set the LookNFeel that shoule be used for this window.
void	setModalState (bool state)
	Set the modal state for this Window.
void	setUserString (string name, string value)
	Sets the value a named user string, creating it as required.
void	setArea (UDim xpos, UDim ypos, UDim width, UDim height)
	Set the window area.
void	setArea (UVector2 pos, UVector2 size)
	Set the window area.
void	setArea (URect area)
	Set the window area.
void	setPosition (UVector2 pos)
	Set the window's position.
void	setXPosition (UDim x)
	Set the window's X position.
void	setYPosition (UDim y)
	Set the window's Y position.
void	setSize (UVector2 size)
	Set the window's size.
void	setWidth (UDim width)
	Set the window's width.
void	setHeight (UDim height)
	Set the window's height.
void	setMaxSize (UVector2 size)
	Set the window's maximum size.
void	setMinSize (UVector2 size)
	Set the window's minimum size.
URect	getArea ()
	Return the windows area.
UVector2	getPosition ()
	Get the window's position.
UDim	getXPosition ()
	Get the window's X position.
UDim	getYPosition ()
	Get the window's Y position.
UVector2	getSize ()
	Get the window's size.
UDim	getWidth ()
	Get the window's width.
UDim	getHeight ()
	Get the window's height.
UVector2	getMaxSize ()
	Get the window's maximum size.
UVector2	getMinSize ()
	Get the window's minimum size.
void	setMousePassThroughEnabled (bool setting)
	Sets whether this window should ignore mouse events and pass them through to any windows behind it. In effect making the window transparent to the mouse.
void	setWindowRenderer (string name)
	Assign the WindowRenderer to specify the Look'N'Feel specification to be used.
string	getWindowRendererName ()
	Get the factory name of the currently assigned WindowRenderer. (Look'N'Feel specification).
void	setDragDropTarget (bool setting)
	Specifies whether this Window object will receive events generated by the drag and drop support in the system.
Public Member Functions inherited from GUI::EventSet
void	addEvent (string name)
	Add a new Event to the EventSet with the given name.
void	removeEvent (string name)
	Removes the Event with the given name. All connections to the event are disconnected.
void	removeAllEvents ()
	Remove all Event objects from the EventSet.
bool	isEventPresent (string name)
	Checks to see if an Event with the given name is present in the EventSet.
EventConnection	subscribeEvent (string name, string subscriber_name)
	Subscribes the named Event to a scripted funtion.
void	fireEvent (string name, EventArgs args, string eventNamespace="")
	Fires the named event passing the given EventArgs object.
bool	isMuted ()
	Return whether the EventSet is muted or not.
void	setMutedState (bool setting)
	Set the mute state for this EventSet.

Additional Inherited Members
Public Attributes inherited from GUI::Window
Property	Property
	Can be used to iterate over the properties currently added to the PropertySet of this Window.

---

Detailed Description

Base class for the multi column list header widget.

---

Member Function Documentation

int GUI::ListHeader::getColumnCount

(

)

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

Returns:

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

ListHeaderSegment GUI::ListHeader::getSegmentFromColumn

(

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.

ListHeaderSegment GUI::ListHeader::getSegmentFromID

(

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.

ListHeaderSegment GUI::ListHeader::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.

int GUI::ListHeader::getColumnFromSegment

(

ListHeaderSegment

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.

int GUI::ListHeader::getColumnFromID

(

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.

int GUI::ListHeader::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.

int GUI::ListHeader::getColumnWithText

(

string

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 GUI::ListHeader::getPixelOffsetToSegment

(

ListHeaderSegment

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 GUI::ListHeader::getPixelOffsetToColumn

(

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 GUI::ListHeader::getTotalSegmentsPixelExtent

(

)

Return the total pixel width of all attached segments.

Returns:

Sum of the pixel widths of all attached ListHeaderSegment objects.

UDim GUI::ListHeader::getColumnWidth

(

int

column

)

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.

int GUI::ListHeader::getSortDirection

(

)

Return the currently set sort direction.

Returns:

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

bool GUI::ListHeader::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 GUI::ListHeader::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 GUI::ListHeader::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 GUI::ListHeader::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 GUI::ListHeader::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 GUI::ListHeader::setSortDirection

(

int

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 GUI::ListHeader::setSortSegment

(

ListHeaderSegment

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 GUI::ListHeader::setSortColumn

(

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 GUI::ListHeader::setSortColumnFromID

(

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 GUI::ListHeader::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 GUI::ListHeader::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 GUI::ListHeader::addColumn	(	string	text,
		int	id,
		UDim	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 GUI::ListHeader::insertColumn	(	string	text,
		int	id,
		UDim	width,
		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 GUI::ListHeader::insertColumn	(	string	text,
		int	id,
		UDim	width,
		ListHeaderSegment	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 GUI::ListHeader::removeColumn

(

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 GUI::ListHeader::removeSegment

(

ListHeaderSegment

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 GUI::ListHeader::moveColumn	(	int	column,
		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 GUI::ListHeader::moveColumn	(	int	column,
		ListHeaderSegment	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 GUI::ListHeader::moveSegment	(	ListHeaderSegment	segment,
		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 GUI::ListHeader::moveSegment	(	ListHeaderSegment	segment,
		ListHeaderSegment	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 GUI::ListHeader::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 GUI::ListHeader::setColumnWidth	(	int	column,
		UDim	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.