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

Inheritance diagram for CEGUI::ListHeader:

Collaboration diagram for CEGUI::ListHeader:

Public Member Functions
uint	getColumnCount (void) const
	Return the number of columns or segments attached to the header. More...

ListHeaderSegment &	getSegmentFromColumn (uint column) const
	Return the ListHeaderSegment object for the specified column. More...

ListHeaderSegment &	getSegmentFromID (uint id) const
	Return the ListHeaderSegment object with the specified ID. More...

ListHeaderSegment &	getSortSegment (void) const
	Return the ListHeaderSegment that is marked as being the 'sort key' segment. There must be at least one segment to successfully call this method. More...

uint	getColumnFromSegment (const ListHeaderSegment &segment) const
	Return the zero based column index of the specified segment. More...

uint	getColumnFromID (uint id) const
	Return the zero based column index of the segment with the specified ID. More...

uint	getSortColumn (void) const
	Return the zero based index of the current sort column. There must be at least one segment/column to successfully call this method. More...

uint	getColumnWithText (const String &text) const
	Return the zero based column index of the segment with the specified text. More...

float	getPixelOffsetToSegment (const ListHeaderSegment &segment) const
	Return the pixel offset to the given ListHeaderSegment. More...

float	getPixelOffsetToColumn (uint column) const
	Return the pixel offset to the ListHeaderSegment at the given zero based column index. More...

float	getTotalSegmentsPixelExtent (void) const
	Return the total pixel width of all attached segments. More...

UDim	getColumnWidth (uint column) const
	Return the width of the specified column. More...

ListHeaderSegment::SortDirection	getSortDirection (void) const
	Return the currently set sort direction. More...

bool	isSortingEnabled (void) const
	Return whether user manipulation of the sort column & direction are enabled. More...

bool	isColumnSizingEnabled (void) const
	Return whether the user may size column segments. More...

bool	isColumnDraggingEnabled (void) const
	Return whether the user may modify the order of the segments. More...

float	getSegmentOffset (void) const
	Return the current segment offset value. This value is used to implement scrolling of the header segments within the ListHeader area. More...

void	setSortingEnabled (bool setting)
	Set whether user manipulation of the sort column and direction is enabled. More...

void	setSortDirection (ListHeaderSegment::SortDirection direction)
	Set the current sort direction. More...

void	setSortSegment (const ListHeaderSegment &segment)
	Set the column segment to be used as the sort column. More...

void	setSortColumn (uint column)
	Set the column to be used as the sort column. More...

void	setSortColumnFromID (uint id)
	Set the column to to be used for sorting via its ID code. More...

void	setColumnSizingEnabled (bool setting)
	Set whether columns may be sized by the user. More...

void	setColumnDraggingEnabled (bool setting)
	Set whether columns may be reordered by the user via drag and drop. More...

void	addColumn (const String &text, uint id, const UDim &width)
	Add a new column segment to the end of the header. More...

void	insertColumn (const String &text, uint id, const UDim &width, uint position)
	Insert a new column segment at the specified position. More...

void	insertColumn (const String &text, uint id, const UDim &width, const ListHeaderSegment &position)
	Insert a new column segment at the specified position. More...

void	removeColumn (uint column)
	Removes a column segment from the ListHeader. More...

void	removeSegment (const ListHeaderSegment &segment)
	Remove the specified segment from the ListHeader. More...

void	moveColumn (uint column, uint position)
	Moves a column segment into a new position. More...

void	moveColumn (uint column, const ListHeaderSegment &position)
	Move a column segment to a new position. More...

void	moveSegment (const ListHeaderSegment &segment, uint position)
	Moves a segment into a new position. More...

void	moveSegment (const ListHeaderSegment &segment, const ListHeaderSegment &position)
	Move a segment to a new position. More...

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

void	setColumnWidth (uint column, const UDim &width)
	Set the width of the specified column. More...

	ListHeader (const String &type, const String &name)
	Constructor for the list header base class.

virtual	~ListHeader (void)
	Destructor for the list header base class.

Public Member Functions inherited from CEGUI::Window
	Window (const String &type, const String &name)
	Constructor for Window base class. More...

virtual	~Window (void)
	Destructor for Window base class.

const String &	getType (void) const
	return a String object holding the type name for this Window. More...

const String &	getName (void) const
	return a String object holding the name of this Window. More...

const String &	getPrefix (void) const

bool	isDestroyedByParent (void) const
	returns whether or not this Window is set to be destroyed when its parent window is destroyed. More...

bool	isAlwaysOnTop (void) const
	returns whether or not this Window is an always on top Window. Also known as a top-most window. More...

bool	isDisabled (bool localOnly=false) const
	return whether the Window is currently disabled More...

bool	isVisible (bool localOnly=false) const
	return true if the Window is currently visible. More...

bool	isActive (void) const
	return true if this is the active Window. An active window is a window that may receive user inputs. More...

bool	isClippedByParent (void) const
	return true if this Window is clipped so that its rendering will not pass outside of its parent Window area. More...

uint	getID (void) const
	return the ID code currently assigned to this Window by client code. More...

size_t	getChildCount (void) const
	return the number of child Window objects currently attached to this Window. More...

bool	isChild (const String &name) const
	returns whether a Window with the specified name is currently attached to this Window as a child. More...

bool	isChild (uint ID) const
	returns whether at least one window with the given ID code is attached to this Window as a child. More...

bool	isChildRecursive (uint ID) const
	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. More...

bool	isChild (const Window *window) const
	return true if the given Window is a child of this window. More...

Window *	getChild (const String &name) const
	return a pointer to the child window with the specified name. More...

Window *	recursiveChildSearch (const String &name) const

Window *	getChild (uint ID) const
	return a pointer to the first attached child window with the specified ID value. More...

Window *	getChildRecursive (uint ID) const
	return a pointer to the first attached child window with the specified ID value. Children are traversed recursively. More...

Window *	getChildAtIdx (size_t idx) const
	return a pointer to the child window that is attached to 'this' at the given index. More...

Window *	getActiveChild (void)
	return a pointer to the Window that currently has input focus starting with this Window. More...

const Window *	getActiveChild (void) const

bool	isAncestor (const String &name) const
	return true if the specified Window is some ancestor of this Window More...

bool	isAncestor (uint ID) const
	return true if any Window with the given ID is some ancestor of this Window. More...

bool	isAncestor (const Window *window) const
	return true if the specified Window is some ancestor of this Window. More...

Font *	getFont (bool useDefault=true) const
	return the active Font object for the Window. More...

const String &	getText (void) const
	return the current text for the Window More...

bool	inheritsAlpha (void) const
	return true if the Window inherits alpha from its parent(s). More...

float	getAlpha (void) const
	return the current alpha value set for this Window More...

float	getEffectiveAlpha (void) const
	return the effective alpha value that will be used when rendering this window, taking into account inheritance of parent window(s) alpha. More...

Rect	getPixelRect (void) const
	return a Rect object describing the Window area in screen space. More...

virtual Rect	getPixelRect_impl (void) const
	return a Rect object describing the Window area in screen space. More...

Rect	getInnerRect (void) const
	return a Rect object describing the clipped inner area for this window. More...

Rect	getUnclippedPixelRect (void) const
	return a Rect object describing the Window area unclipped, in screen space. More...

Rect	getUnclippedInnerRect (void) const
	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. More...

virtual Rect	getUnclippedInnerRect_impl (void) const
	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. More...

bool	isCapturedByThis (void) const
	return true if this Window has input captured. More...

bool	isCapturedByAncestor (void) const
	return true if an ancestor window has captured inputs. More...

bool	isCapturedByChild (void) const
	return true if a child window has captured inputs. More...

virtual bool	isHit (const Vector2 &position) const
	check if the given pixel position would hit this window. More...

Window *	getChildAtPosition (const Vector2 &position) const
	return the child Window that is hit by the given pixel position More...

Window *	getTargetChildAtPosition (const Vector2 &position) const
	return the child Window that is 'hit' by the given position, and is allowed to handle mouse events. More...

Window *	getParent (void) const
	return the parent of this Window. More...

const Image *	getMouseCursor (bool useDefault=true) const
	Return a pointer to the mouse cursor image to use when the mouse cursor is within this window's area. More...

Size	getPixelSize (void) const
	Return the window size in pixels. More...

void *	getUserData (void) const
	Return the user data set for this Window. More...

bool	restoresOldCapture (void) const
	Return whether this window is set to restore old input capture when it loses input capture. More...

bool	isZOrderingEnabled (void) const
	Return whether z-order changes are enabled or disabled for this Window. More...

bool	wantsMultiClickEvents (void) const
	Return whether this window will receive multi-click events or multiple 'down' events instead. More...

bool	isMouseAutoRepeatEnabled (void) const
	Return whether mouse button down event autorepeat is enabled for this window. More...

float	getAutoRepeatDelay (void) const
	Return the current auto-repeat delay setting for this window. More...

float	getAutoRepeatRate (void) const
	Return the current auto-repeat rate setting for this window. More...

bool	distributesCapturedInputs (void) const
	Return whether the window wants inputs passed to its attached child windows when the window has inputs captured. More...

bool	isUsingDefaultTooltip (void) const
	Return whether this Window is using the system default Tooltip for its Tooltip window. More...

Tooltip *	getTooltip (void) const
	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. More...

String	getTooltipType (void) const
	Return the custom tooltip type. More...

const String &	getTooltipText (void) const
	Return the current tooltip text set for this Window. More...

bool	inheritsTooltipText (void) const
	Return whether this window inherits Tooltip text from its parent when its own tooltip text is not set. More...

bool	isRiseOnClickEnabled (void) const
	Return whether this window will rise to the top of the z-order when clicked with the left mouse button. More...

bool	testClassName (const String &class_name) const
	Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. More...

VerticalAlignment	getVerticalAlignment () const
	Get the vertical alignment. More...

HorizontalAlignment	getHorizontalAlignment () const
	Get the horizontal alignment. More...

RenderCache &	getRenderCache ()
	Return the RenderCache object for this Window. More...

const String &	getLookNFeel () const
	Get the name of the LookNFeel assigned to this window. More...

bool	getModalState (void) const
	Get whether or not this Window is the modal target. More...

const String &	getUserString (const String &name) const
	Returns a named user string. More...

bool	isUserStringDefined (const String &name) const
	Return whether a user string with the specified name exists. More...

Window *	getActiveSibling ()
	Returns the active sibling window. More...

Size	getParentPixelSize (void) const
	Return the pixel size of the parent element. This always returns a valid object. More...

float	getParentPixelWidth (void) const
	Return the pixel Width of the parent element. This always returns a valid number. More...

float	getParentPixelHeight (void) const
	Return the pixel Height of the parent element. This always returns a valid number. More...

bool	isMousePassThroughEnabled (void) const
	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. More...

bool	isAutoWindow (void) const
	Returns whether this window is an auto-child window. All auto-child windows have "__auto_" in their name, but this is faster.

bool	isWritingXMLAllowed (void) const
	Returns whether this window is allowed to write XML.

EventSet::Iterator	getEventIterator () const
	Helper method that returns an EventSet::Iterator object that can be used to iterate over the events currently added to the EventSet of this Window. More...

PropertySet::Iterator	getPropertyIterator () const
	Helper method that returns a PropertySet::Iterator object that can be used to iterate over the events currently added to the PropertySet of this Window. More...

bool	isDragDropTarget () const
	Returns whether this Window object will receive events generated by the drag and drop support in the system. More...

void	rename (const String &new_name)
	Renames the window. More...

virtual void	initialiseComponents (void)
	Initialises the Window based object ready for use. More...

void	setDestroyedByParent (bool setting)
	Set whether or not this Window will automatically be destroyed when its parent Window is destroyed. More...

void	setAlwaysOnTop (bool setting)
	Set whether this window is always on top, or not. More...

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. More...

void	enable (void)
	enable the Window to allow interaction. More...

void	disable (void)
	disable the Window to prevent interaction. More...

void	setVisible (bool setting)
	Set whether the Window is visible or hidden. More...

void	show (void)
	show the Window. More...

void	hide (void)
	hide the Window. More...

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. More...

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. More...

void	setClippedByParent (bool setting)
	Set whether this Window will be clipped by its parent window(s). More...

void	setID (uint ID)
	Set the current ID for the Window. More...

void	setPrefix (String prefix)

void	setText (const String &text)
	Set the current text string for the Window. More...

void	insertText (const String &text, const String::size_type position)
	Insert the text string text into the current text string for the Window object at the position specified by position. More...

void	appendText (const String &text)
	Append the string text to the currect text string for the Window object. More...

void	setFont (Font *font)
	Set the font used by this Window. More...

void	setFont (const String &name)
	Set the font used by this Window. More...

void	addChildWindow (const 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. More...

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. More...

void	removeChildWindow (const String &name)
	Remove the named Window from this windows child list. More...

void	removeChildWindow (Window *window)
	Remove the specified Window form this windows child list. More...

void	removeChildWindow (uint 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. More...

void	moveToFront ()
	Move the Window to the top of the z order. More...

void	moveToBack ()
	Move the Window to the bottom of the Z order. More...

bool	captureInput (void)
	Captures input to this window. More...

void	releaseInput (void)
	Releases input capture from this Window. If this Window does not have inputs captured, nothing happens. More...

void	setRestoreCapture (bool setting)
	Set whether this window will remember and restore the previous window that had inputs captured. More...

void	setAlpha (float alpha)
	Set the current alpha value for this window. More...

void	setInheritsAlpha (bool setting)
	Sets whether this Window will inherit alpha from its parent windows. More...

void	requestRedraw (void) const
	Signal the System object to redraw (at least) this Window on the next render cycle. More...

void	setMouseCursor (const Image *image)
	Set the mouse cursor image to be used when the mouse enters this window. More...

void	setMouseCursor (MouseCursorImage image)
	Set the mouse cursor image to be used when the mouse enters this window. More...

void	setMouseCursor (const String &imageset, const String &image_name)
	Set the mouse cursor image to be used when the mouse enters this window. More...

void	setUserData (void *user_data)
	Set the user data set for this Window. More...

void	setZOrderingEnabled (bool setting)
	Set whether z-order changes are enabled or disabled for this Window. More...

void	setWantsMultiClickEvents (bool setting)
	Set whether this window will receive multi-click events or multiple 'down' events instead. More...

void	setMouseAutoRepeatEnabled (bool setting)
	Set whether mouse button down event autorepeat is enabled for this window. More...

void	setAutoRepeatDelay (float delay)
	Set the current auto-repeat delay setting for this window. More...

void	setAutoRepeatRate (float rate)
	Set the current auto-repeat rate setting for this window. More...

void	setDistributesCapturedInputs (bool setting)
	Set whether the window wants inputs passed to its attached child windows when the window has inputs captured. More...

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.

virtual void	destroy (void)
	Internal destroy method which actually just adds the window and any parent destructed child windows to the dead pool. More...

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. More...

void	setTooltipType (const String &tooltipType)
	Set the custom Tooltip to be used by this Window by specifying a Window type. More...

void	setTooltipText (const String &tip)
	Set the tooltip text for this window. More...

void	setInheritsTooltipText (bool setting)
	Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set. More...

void	setRiseOnClickEnabled (bool setting)
	Set whether this window will rise to the top of the z-order when clicked with the left mouse button. More...

void	setVerticalAlignment (const VerticalAlignment alignment)
	Set the vertical alignment. More...

void	setHorizontalAlignment (const HorizontalAlignment alignment)
	Set the horizontal alignment. More...

virtual void	setLookNFeel (const String &look)
	Set the LookNFeel that shoule be used for this window. More...

void	setModalState (bool state)
	Set the modal state for this Window. More...

virtual void	performChildWindowLayout ()
	method called to perform extended laying out of attached child windows. More...

void	setUserString (const String &name, const String &value)
	Sets the value a named user string, creating it as required. More...

void	setArea (const UDim &xpos, const UDim &ypos, const UDim &width, const UDim &height)
	Set the window area. More...

void	setArea (const UVector2 &pos, const UVector2 &size)
	Set the window area. More...

void	setArea (const URect &area)
	Set the window area. More...

void	setPosition (const UVector2 &pos)
	Set the window's position. More...

void	setXPosition (const UDim &x)
	Set the window's X position. More...

void	setYPosition (const UDim &y)
	Set the window's Y position. More...

void	setSize (const UVector2 &size)
	Set the window's size. More...

void	setWidth (const UDim &width)
	Set the window's width. More...

void	setHeight (const UDim &height)
	Set the window's height. More...

void	setMaxSize (const UVector2 &size)
	Set the window's maximum size. More...

void	setMinSize (const UVector2 &size)
	Set the window's minimum size. More...

const URect &	getArea () const
	Return the windows area. More...

const UVector2 &	getPosition () const
	Get the window's position. More...

const UDim &	getXPosition () const
	Get the window's X position. More...

const UDim &	getYPosition () const
	Get the window's Y position. More...

UVector2	getSize () const
	Get the window's size. More...

UDim	getWidth () const
	Get the window's width. More...

UDim	getHeight () const
	Get the window's height. More...

const UVector2 &	getMaxSize () const
	Get the window's maximum size. More...

const UVector2 &	getMinSize () const
	Get the window's minimum size. More...

void	render (void)
	Causes the Window object to render itself and all of it's attached children. More...

void	update (float elapsed)
	Cause window to update itself and any attached children. Client code does not need to call this method; to ensure full, and proper updates, call the injectTimePulse methodname method provided by the System class. More...

virtual void	writeXMLToStream (XMLSerializer &xml_stream) const
	Writes an xml representation of this window object to out_stream. More...

virtual void	beginInitialisation (void)
	Sets the internal 'initialising' flag to true. This can be use to optimize initialisation of some widgets, and is called automatically by the layout XML handler when it has created a window. That is just after the window has been created, but before any children or properties are read.

virtual void	endInitialisation (void)
	Sets the internal 'initialising' flag to false. This is called automatically by the layout XML handler when it is done creating a window. That is after all properties and children have been loaded and just before the next sibling gets created.

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. More...

void	setWindowRenderer (const String &name)
	Assign the WindowRenderer to specify the Look'N'Feel specification to be used. More...

WindowRenderer *	getWindowRenderer (void) const
	Get the currently assigned WindowRenderer. (Look'N'Feel specification). More...

String	getWindowRendererName (void) const
	Get the factory name of the currently assigned WindowRenderer. (Look'N'Feel specification). More...

void	setWritingXMLAllowed (bool allow)
	Sets whether this window is allowed to write XML.

void	notifyScreenAreaChanged (void)
	Recursively inform all children that the screen area has changed, and needs to be re-cached.

void	setFalagardType (const String &type, const String &rendererType="")
	Changes the widget's falagard type, thus changing its look'n'feel and optionally its renderer in the process. More...

void	setDragDropTarget (bool setting)
	Specifies whether this Window object will receive events generated by the drag and drop support in the system. More...

Public Member Functions inherited from CEGUI::PropertySet
	PropertySet (void)
	Constructs a new PropertySet object.

virtual	~PropertySet (void)
	Destructor for PropertySet objects.

void	addProperty (Property *property)
	Adds a new Property to the PropertySet. More...

void	removeProperty (const String &name)
	Removes a Property from the PropertySet. More...

void	clearProperties (void)
	Removes all Property objects from the PropertySet. More...

bool	isPropertyPresent (const String &name) const
	Checks to see if a Property with the given name is in the PropertySet. More...

const String &	getPropertyHelp (const String &name) const
	Return the help text for the specified Property. More...

String	getProperty (const String &name) const
	Gets the current value of the specified Property. More...

void	setProperty (const String &name, const String &value)
	Sets the current value of a Property. More...

bool	isPropertyDefault (const String &name) const
	Returns whether a Property is at it's default value. More...

String	getPropertyDefault (const String &name) const
	Returns the default value of a Property as a String. More...

Iterator	getIterator (void) const
	Return a PropertySet::Iterator object to iterate over the available Properties.

Public Member Functions inherited from CEGUI::EventSet
	EventSet ()
	Constructor for EventSet objects.

virtual	~EventSet (void)
	Destructor for EventSet objects.

void	addEvent (const String &name)
	Add a new Event to the EventSet with the given name. More...

void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected. More...

void	removeAllEvents (void)
	Remove all Event objects from the EventSet. More...

bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in the EventSet. More...

virtual Event::Connection	subscribeEvent (const String &name, Event::Subscriber subscriber)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...

virtual Event::Connection	subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
	Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...

virtual Event::Connection	subscribeScriptedEvent (const String &name, const String &subscriber_name)
	Subscribes the named Event to a scripted funtion. More...

virtual Event::Connection	subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
	Subscribes the specified group of the named Event to a scripted funtion. More...

virtual void	fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
	Fires the named event passing the given EventArgs object. More...

bool	isMuted (void) const
	Return whether the EventSet is muted or not. More...

void	setMutedState (bool setting)
	Set the mute state for this EventSet. More...

Iterator	getIterator (void) const
	Return a EventSet::Iterator object to iterate over the events currently added to the EventSet.

Static Public Attributes
static const String	EventNamespace
	Namespace for global events.

static const String	WidgetTypeName
	Window factory name.

static const String	EventSortColumnChanged
	Event fired when the current sort column changes.

static const String	EventSortDirectionChanged
	Event fired when the sort direction changes.

static const String	EventSegmentSized
	Event fired when a segment has been sized by the user (e.window is the segment).

static const String	EventSegmentClicked
	Event fired when a segment has been clicked by the user (e.window is the segment).

static const String	EventSplitterDoubleClicked
	Event fired when a segment splitter has been double-clicked. (e.window is the segment).

static const String	EventSegmentSequenceChanged
	Event fired when the order of the segments has changed. ('e' is a HeaderSequenceEventArgs&)

static const String	EventSegmentAdded
	Event fired when a segment is added to the header.

static const String	EventSegmentRemoved
	Event fired when a segment is removed from the header.

static const String	EventSortSettingChanged
	Event fired when setting that controls user modification to sort configuration changes.

static const String	EventDragMoveSettingChanged
	Event fired when setting that controls user drag & drop of segments changes.

static const String	EventDragSizeSettingChanged
	Event fired when setting that controls user sizing of segments changes.

static const String	EventSegmentRenderOffsetChanged
	Event fired when the rendering offset for the segments changes.

static const float	ScrollSpeed = 8.0f
	Speed to scroll at when dragging outside header.

static const float	MinimumSegmentPixelWidth = 20.0f
	Miniumum width of a segment in pixels.

static const char	SegmentNameSuffix [] = "__auto_seg_"
	Widget name suffix for header segments.

Static Public Attributes inherited from CEGUI::Window
static const String	EventNamespace
	< Namespace for global events

static const String	EventWindowUpdated

static const String	EventParentSized
	Parent of this Window has been re-sized.

static const String	EventSized
	Window size has changed.

static const String	EventMoved
	Window position has changed.

static const String	EventTextChanged
	Text string for the Window has changed.

static const String	EventFontChanged
	Font object for the Window has been changed.

static const String	EventAlphaChanged
	Alpha blend value for the Window has changed.

static const String	EventIDChanged
	Client assigned ID code for the Window has changed.

static const String	EventActivated
	Window has been activated (has input focus)

static const String	EventDeactivated
	Window has been deactivated (loses input focus)

static const String	EventShown
	Window has been made visible.

static const String	EventHidden
	Window has been hidden from view.

static const String	EventEnabled
	Window has been enabled (interaction is possible)

static const String	EventDisabled
	Window has been disabled (interaction is no longer possible)

static const String	EventClippedByParentChanged
	Clipping by parent mode has been modified.

static const String	EventDestroyedByParentChanged
	Destruction by parent mode has been modified.

static const String	EventInheritsAlphaChanged
	Alpha inherited from parent mode has been modified.

static const String	EventAlwaysOnTopChanged
	Always on top mode has been modified.

static const String	EventInputCaptureGained
	Window has captured all inputs.

static const String	EventInputCaptureLost
	Window has lost it's capture on inputs.

static const String	EventRenderingStarted
	Rendering of the Window has started.

static const String	EventRenderingEnded
	Rendering for the Window has finished.

static const String	EventChildAdded
	A child Window has been added.

static const String	EventChildRemoved
	A child window has been removed.

static const String	EventDestructionStarted
	Destruction of the Window is about to begin.

static const String	EventZOrderChanged
	The z-order of the window has changed.

static const String	EventDragDropItemEnters
	A DragContainer has been dragged over this window.

static const String	EventDragDropItemLeaves
	A DragContainer has left this window.

static const String	EventDragDropItemDropped
	A DragContainer was dropped on this Window.

static const String	EventVerticalAlignmentChanged
	The vertical alignment of the window has changed.

static const String	EventHorizontalAlignmentChanged
	The vertical alignment of the window has changed.

static const String	EventWindowRendererAttached
	The a new window renderer was attached.

static const String	EventWindowRendererDetached
	The currently assigned window renderer was detached.

static const String	EventMouseEnters
	Mouse cursor has entered the Window.

static const String	EventMouseLeaves
	Mouse cursor has left the Window.

static const String	EventMouseMove
	Mouse cursor was moved within the area of the Window.

static const String	EventMouseWheel
	Mouse wheel was scrolled within the Window.

static const String	EventMouseButtonDown
	A mouse button was pressed down within the Window.

static const String	EventMouseButtonUp
	A mouse button was released within the Window.

static const String	EventMouseClick
	A mouse button was clicked (down then up) within the Window.

static const String	EventMouseDoubleClick
	A mouse button was double-clicked within the Window.

static const String	EventMouseTripleClick
	A mouse button was triple-clicked within the Window.

static const String	EventKeyDown
	A key on the keyboard was pressed.

static const String	EventKeyUp
	A key on the keyboard was released.

static const String	EventCharacterKey
	A text character was typed on the keyboard.

static const String	TooltipNameSuffix
	Widget name suffix for automatically created tooltip widgets.

static const String	AutoWidgetNameSuffix
	Something that all generated widgets will have in their names.

Protected Types
typedef std::vector < ListHeaderSegment * >	SegmentList

Protected Types inherited from CEGUI::Window
typedef std::vector< Window * >	ChildList

typedef std::map< String, String, String::FastLessCompare >	UserStringMap

typedef std::set< String, String::FastLessCompare >	BannedXMLPropertySet
	std::set used to determine whether a window should write a property to XML or not. if the property name is present the property will not be written

Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event *, String::FastLessCompare >	EventMap

Protected Member Functions
ListHeaderSegment *	createInitialisedSegment (const String &text, uint id, const UDim &width)
	Create and return a pointer to a new ListHeaderSegment based object. More...

void	layoutSegments (void)
	Layout the attached segments.

virtual bool	testClassName_impl (const String &class_name) const
	Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. More...

ListHeaderSegment *	createNewSegment (const String &name) const
	Create and return a pointer to a new ListHeaderSegment based object. More...

void	destroyListSegment (ListHeaderSegment *segment) const
	Cleanup and destroy the given ListHeaderSegment that was created via the createNewSegment method. More...

virtual bool	validateWindowRenderer (const String &name) const
	Function used in checking if a WindowRenderer is valid for this window. More...

virtual void	onSortColumnChanged (WindowEventArgs &e)
	Handler called when the sort column is changed.

virtual void	onSortDirectionChanged (WindowEventArgs &e)
	Handler called when the sort direction is changed.

virtual void	onSegmentSized (WindowEventArgs &e)
	Handler called when a segment is sized by the user. e.window points to the segment.

virtual void	onSegmentClicked (WindowEventArgs &e)
	Handler called when a segment is clicked by the user. e.window points to the segment.

virtual void	onSplitterDoubleClicked (WindowEventArgs &e)
	Handler called when a segment splitter / sizer is double-clicked. e.window points to the segment.

virtual void	onSegmentSequenceChanged (WindowEventArgs &e)
	Handler called when the segment / column order changes.

virtual void	onSegmentAdded (WindowEventArgs &e)
	Handler called when a new segment is added to the header.

virtual void	onSegmentRemoved (WindowEventArgs &e)
	Handler called when a segment is removed from the header.

virtual void	onSortSettingChanged (WindowEventArgs &e)
	Handler called then setting that controls the users ability to modify the search column & direction changes.

virtual void	onDragMoveSettingChanged (WindowEventArgs &e)
	Handler called when the setting that controls the users ability to drag and drop segments changes.

virtual void	onDragSizeSettingChanged (WindowEventArgs &e)
	Handler called when the setting that controls the users ability to size segments changes.

virtual void	onSegmentOffsetChanged (WindowEventArgs &e)
	Handler called when the base rendering offset for the segments (scroll position) changes.

bool	segmentSizedHandler (const EventArgs &e)

bool	segmentMovedHandler (const EventArgs &e)

bool	segmentClickedHandler (const EventArgs &e)

bool	segmentDoubleClickHandler (const EventArgs &e)

bool	segmentDragHandler (const EventArgs &e)

Protected Member Functions inherited from CEGUI::Window
virtual void	onSized (WindowEventArgs &e)
	Handler called when the window's size changes. More...

virtual void	onMoved (WindowEventArgs &e)
	Handler called when the window's position changes. More...

virtual void	onTextChanged (WindowEventArgs &e)
	Handler called when the window's text is changed. More...

virtual void	onFontChanged (WindowEventArgs &e)
	Handler called when the window's font is changed. More...

virtual void	onAlphaChanged (WindowEventArgs &e)
	Handler called when the window's alpha blend value is changed. More...

virtual void	onIDChanged (WindowEventArgs &e)
	Handler called when the window's client assigned ID is changed. More...

virtual void	onShown (WindowEventArgs &e)
	Handler called when the window is shown (made visible). More...

virtual void	onHidden (WindowEventArgs &e)
	Handler called when the window is hidden. More...

virtual void	onEnabled (WindowEventArgs &e)
	Handler called when the window is enabled. More...

virtual void	onDisabled (WindowEventArgs &e)
	Handler called when the window is disabled. More...

virtual void	onClippingChanged (WindowEventArgs &e)
	Handler called when the window's setting for being clipped by it's parent is changed. More...

virtual void	onParentDestroyChanged (WindowEventArgs &e)
	Handler called when the window's setting for being destroyed automatically be it's parent is changed. More...

virtual void	onInheritsAlphaChanged (WindowEventArgs &e)
	Handler called when the window's setting for inheriting alpha-blending is changed. More...

virtual void	onAlwaysOnTopChanged (WindowEventArgs &e)
	Handler called when the window's always-on-top setting is changed. More...

virtual void	onCaptureGained (WindowEventArgs &e)
	Handler called when this window gains capture of mouse inputs. More...

virtual void	onCaptureLost (WindowEventArgs &e)
	Handler called when this window loses capture of mouse inputs. More...

virtual void	onRenderingStarted (WindowEventArgs &e)
	Handler called when rendering for this window has started. More...

virtual void	onRenderingEnded (WindowEventArgs &e)
	Handler called when rendering for this window has ended. More...

virtual void	onZChanged (WindowEventArgs &e)
	Handler called when the z-order position of this window has changed. More...

virtual void	onDestructionStarted (WindowEventArgs &e)
	Handler called when this window's destruction sequence has begun. More...

virtual void	onActivated (ActivationEventArgs &e)
	Handler called when this window has become the active window. More...

virtual void	onDeactivated (ActivationEventArgs &e)
	Handler called when this window has lost input focus and has been deactivated. More...

virtual void	onParentSized (WindowEventArgs &e)
	Handler called when this window's parent window has been resized. If this window is the root / GUI Sheet window, this call will be made when the display size changes. More...

virtual void	onChildAdded (WindowEventArgs &e)
	Handler called when a child window is added to this window. More...

virtual void	onChildRemoved (WindowEventArgs &e)
	Handler called when a child window is removed from this window. More...

virtual void	onMouseEnters (MouseEventArgs &e)
	Handler called when the mouse cursor has entered this window's area. More...

virtual void	onMouseLeaves (MouseEventArgs &e)
	Handler called when the mouse cursor has left this window's area. More...

virtual void	onMouseMove (MouseEventArgs &e)
	Handler called when the mouse cursor has been moved within this window's area. More...

virtual void	onMouseWheel (MouseEventArgs &e)
	Handler called when the mouse wheel (z-axis) position changes within this window's area. More...

virtual void	onMouseButtonDown (MouseEventArgs &e)
	Handler called when a mouse button has been depressed within this window's area. More...

virtual void	onMouseButtonUp (MouseEventArgs &e)
	Handler called when a mouse button has been released within this window's area. More...

virtual void	onMouseClicked (MouseEventArgs &e)
	Handler called when a mouse button has been clicked (that is depressed and then released, within a specified time) within this window's area. More...

virtual void	onMouseDoubleClicked (MouseEventArgs &e)
	Handler called when a mouse button has been double-clicked within this window's area. More...

virtual void	onMouseTripleClicked (MouseEventArgs &e)
	Handler called when a mouse button has been triple-clicked within this window's area. More...

virtual void	onKeyDown (KeyEventArgs &e)
	Handler called when a key as been depressed while this window has input focus. More...

virtual void	onKeyUp (KeyEventArgs &e)
	Handler called when a key as been released while this window has input focus. More...

virtual void	onCharacter (KeyEventArgs &e)
	Handler called when a character-key has been pressed while this window has input focus. More...

virtual void	onDragDropItemEnters (DragDropEventArgs &e)
	Handler called when a DragContainer is dragged over this window. More...

virtual void	onDragDropItemLeaves (DragDropEventArgs &e)
	Handler called when a DragContainer is dragged over this window. More...

virtual void	onDragDropItemDropped (DragDropEventArgs &e)
	Handler called when a DragContainer is dragged over this window. More...

virtual void	onVerticalAlignmentChanged (WindowEventArgs &e)
	Handler called when the vertical alignment setting for the window is changed. More...

virtual void	onHorizontalAlignmentChanged (WindowEventArgs &e)
	Handler called when the horizontal alignment setting for the window is changed. More...

virtual void	onWindowRendererAttached (WindowEventArgs &e)
	Handler called when a new window renderer object is attached. More...

virtual void	onWindowRendererDetached (WindowEventArgs &e)
	Handler called when the currently attached window renderer object is detached. More...

virtual void	updateSelf (float elapsed)
	Perform actual update processing for this Window. More...

virtual void	drawSelf (float z)
	Perform the actual rendering for this Window. More...

virtual void	populateRenderCache ()
	Update the rendering cache. More...

void	setParent (Window *parent)
	Set the parent window for this window object. More...

Size	getSize_impl (const Window *window) const

void	generateAutoRepeatEvent (MouseButton button)
	Fires off a repeated mouse button down event for this window.

void	banPropertyFromXML (const Property *property)
	Adds a property to the XML ban list.

bool	isPropertyBannedFromXML (const Property *property) const
	Returns whether a property is banned from XML.

bool	isPropertyAtDefault (const Property *property) const
	Returns whether a property is at it's default value. This function is different from Property::isDefatult as it takes the assigned look'n'feel (if the is one) into account.

void	notifyClippingChanged (void)
	Recursively inform all children that the clipping has changed and screen rects needs to be recached.

virtual void	cleanupChildren (void)
	Cleanup child windows.

virtual void	addChild_impl (Window *wnd)
	Add given window to child list at an appropriate position.

virtual void	removeChild_impl (Window *wnd)
	Remove given window from child list.

virtual void	onZChange_impl (void)
	Notify 'this' and all siblings of a ZOrder change event.

void	addStandardProperties (void)
	Add standard CEGUI::Window properties.

virtual bool	moveToFront_impl (bool wasClicked)
	Implements move to front behavior. More...

bool	doRiseOnClick (void)
	Implementation of rise on click functionality. More...

void	setArea_impl (const UVector2 &pos, const UVector2 &size, bool topLeftSizing=false, bool fireEvents=true)
	Implementation method to modify window area while correctly applying min / max size processing, and firing any appropriate events. More...

void	addWindowToDrawList (Window &wnd, bool at_back=false)
	Add the given window to the drawing list at an appropriate position for it's settings and the required direction. Basically, when at_back is false, the window will appear in front of all other windows with the same 'always on top' setting. When at_back is true, the window will appear behind all other windows wih the same 'always on top' setting. More...

void	removeWindowFromDrawList (const Window &wnd)
	Removes the window from the drawing list. If the window is not attached to the drawing list then nothing happens. More...

bool	isTopOfZOrder () const
	Return whether the window is at the top of the Z-Order. This will correctly take into account 'Always on top' windows as needed. More...

virtual int	writePropertiesXML (XMLSerializer &xml_stream) const

virtual int	writeChildWindowsXML (XMLSerializer &xml_stream) const

virtual bool	writeAutoChildWindowXML (XMLSerializer &xml_stream) const

	Window (const Window &wnd)

Window &	operator= (const Window &wnd)

Protected Member Functions inherited from CEGUI::EventSet
Event *	getEventObject (const String &name, bool autoAdd=false)
	Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...

void	fireEvent_impl (const String &name, EventArgs &args)
	Implementation event firing member.

	EventSet (EventSet &e)

EventSet &	operator= (EventSet &e)

Protected Attributes
SegmentList	d_segments
	Attached segment windows in header order.

ListHeaderSegment *	d_sortSegment
	Pointer to the segment that is currently set as the sork-key,.

bool	d_sizingEnabled
	true if segments can be sized by the user.

bool	d_sortingEnabled
	true if the sort criteria modifications by user are enabled (no sorting is actuall done)

bool	d_movingEnabled
	true if drag & drop moving of columns / segments is enabled.

uint	d_uniqueIDNumber
	field used to create unique names.

float	d_segmentOffset
	Base offset used to layout the segments (allows scrolling within the window area)

ListHeaderSegment::SortDirection	d_sortDir
	Brief copy of the current sort direction.

Protected Attributes inherited from CEGUI::Window
ChildList	d_children
	The list of child Window objects attached to this.

ChildList	d_drawList
	Child window objects arranged in rendering order.

Window *	d_oldCapture
	The Window that previously had capture (used for restoreOldCapture mode)

Window *	d_parent
	Holds pointer to the parent window.

Font *	d_font
	Holds pointer to the Window objects current Font.

String	d_text
	Holds the text / label / caption for this Window.

uint	d_ID
	User ID assigned to this Window.

float	d_alpha
	Alpha transparency setting for the Window.

URect	d_area
	This Window objects area as defined by a URect.

Size	d_pixelSize
	Current constrained pixel size of the window.

const Image *	d_mouseCursor
	Holds pointer to the Window objects current mouse cursor image.

UserStringMap	d_userStrings
	Holds a collection of named user string values.

void *	d_userData
	Holds pointer to some user assigned data.

HorizontalAlignment	d_horzAlign
	Specifies the base for horizontal alignment.

VerticalAlignment	d_vertAlign
	Specifies the base for vertical alignment.

UVector2	d_minSize
	current minimum size for the window.

UVector2	d_maxSize
	current maximum size for the window.

bool	d_enabled
	true when Window is enabled

bool	d_visible
	true when Window is visible (that is it will be rendered, but may be obscured so no necesarily really visible)

bool	d_active
	true when Window is the active Window (receiving inputs).

bool	d_clippedByParent
	true when Window will be clipped by parent Window area Rect.

bool	d_destroyedByParent
	true when Window will be auto-destroyed by parent.

bool	d_alwaysOnTop
	true if Window will be drawn on top of all other Windows

bool	d_inheritsAlpha
	true if the Window inherits alpha from the parent Window

bool	d_restoreOldCapture
	true if the Window restores capture to the previous window when it releases capture.

bool	d_zOrderingEnabled
	true if the Window responds to z-order change requests.

bool	d_wantsMultiClicks
	true if the Window wishes to hear about multi-click mouse events.

bool	d_distCapturedInputs
	true if unhandled captured inputs should be distributed to child windows.

bool	d_riseOnClick
	True if the window should come to the front of the z order in response to a left mouse button down event.

bool	d_autoRepeat
	true if button will auto-repeat mouse button down events while mouse button is held down.

float	d_repeatDelay
	seconds before first repeat event is fired

float	d_repeatRate
	secons between further repeats after delay has expired.

bool	d_repeating
	implements repeating - is true after delay has elapsed,

float	d_repeatElapsed
	implements repeating - tracks time elapsed.

MouseButton	d_repeatButton
	Button we're tracking (implication of this is that we only support one button at a time).

bool	d_dragDropTarget
	true if window will receive drag and drop related notifications

String	d_tooltipText
	Text string used as tip for this window.

Tooltip *	d_customTip
	Possible custom Tooltip for this window.

bool	d_weOwnTip
	true if this Window created the custom Tooltip.

bool	d_inheritsTipText
	true if the Window inherits tooltip text from its parent (when none set for itself).

RenderCache	d_renderCache
	Object which acts as a cache for Images to be drawn by this Window.

bool	d_needsRedraw
	true if window image cache needs to be regenerated.

String	d_lookName
	Name of the Look assigned to this window (if any).

WindowRenderer *	d_windowRenderer
	The WindowRenderer module that implements the Look'N'Feel specification.

bool	d_initialising
	true when this window is currently being initialised (creating children etc)

bool	d_destructionStarted
	true when this window is being destroyed.

bool	d_mousePassThroughEnabled
	true if this window can never be "hit" by the cursor. false for normal mouse event handling.

bool	d_autoWindow
	true when this window is an auto-window (it's name contains __auto_)

BannedXMLPropertySet	d_bannedXMLProperties

bool	d_allowWriteXML
	true if this window is allowed to write XML, false if not

Rect	d_screenUnclippedRect
	current unclipped screen rect in pixels

bool	d_screenUnclippedRectValid

Rect	d_screenUnclippedInnerRect
	current unclipped inner screen rect in pixels

bool	d_screenUnclippedInnerRectValid

Rect	d_screenRect
	current fully clipped screen rect in pixels

bool	d_screenRectValid

Rect	d_screenInnerRect
	current fully clipped inner screen rect in pixels

bool	d_screenInnerRectValid

const String	d_type
	String holding the type name for the Window (is also the name of the WindowFactory that created us)

String	d_name
	The name of the window (GUI system unique).

String	d_falagardType
	Type name of the window as defined in a Falagard mapping.

String	d_windowPrefix
	The prefix used on this window (if any) when created instanced windows.

Protected Attributes inherited from CEGUI::EventSet
EventMap	d_events

bool	d_muted
	true if events for this EventSet have been muted.

Additional Inherited Members
Public Types inherited from CEGUI::PropertySet
typedef ConstBaseIterator < PropertyRegistry >	Iterator

Public Types inherited from CEGUI::EventSet
typedef ConstBaseIterator < EventMap >	Iterator

Static Public Member Functions inherited from CEGUI::Window
static Window *	getCaptureWindow (void)
	return the Window that currently has inputs captured. More...

Static Protected Attributes inherited from CEGUI::Window
static Window *	d_captureWindow = 0
	Window that has captured inputs.

static WindowProperties::Alpha	d_alphaProperty

static WindowProperties::AlwaysOnTop	d_alwaysOnTopProperty

static WindowProperties::ClippedByParent	d_clippedByParentProperty

static WindowProperties::DestroyedByParent	d_destroyedByParentProperty

static WindowProperties::Disabled	d_disabledProperty

static WindowProperties::Font	d_fontProperty

static WindowProperties::ID	d_IDProperty

static WindowProperties::InheritsAlpha	d_inheritsAlphaProperty

static WindowProperties::MouseCursorImage	d_mouseCursorProperty

static WindowProperties::RestoreOldCapture	d_restoreOldCaptureProperty

static WindowProperties::Text	d_textProperty

static WindowProperties::Visible	d_visibleProperty

static WindowProperties::ZOrderChangeEnabled	d_zOrderChangeProperty

static WindowProperties::WantsMultiClickEvents	d_wantsMultiClicksProperty

static WindowProperties::MouseButtonDownAutoRepeat	d_autoRepeatProperty

static WindowProperties::AutoRepeatDelay	d_autoRepeatDelayProperty

static WindowProperties::AutoRepeatRate	d_autoRepeatRateProperty

static WindowProperties::DistributeCapturedInputs	d_distInputsProperty

static WindowProperties::CustomTooltipType	d_tooltipTypeProperty

static WindowProperties::Tooltip	d_tooltipProperty

static WindowProperties::InheritsTooltipText	d_inheritsTooltipProperty

static WindowProperties::RiseOnClick	d_riseOnClickProperty

static WindowProperties::VerticalAlignment	d_vertAlignProperty

static WindowProperties::HorizontalAlignment	d_horzAlignProperty

static WindowProperties::UnifiedAreaRect	d_unifiedAreaRectProperty

static WindowProperties::UnifiedPosition	d_unifiedPositionProperty

static WindowProperties::UnifiedXPosition	d_unifiedXPositionProperty

static WindowProperties::UnifiedYPosition	d_unifiedYPositionProperty

static WindowProperties::UnifiedSize	d_unifiedSizeProperty

static WindowProperties::UnifiedWidth	d_unifiedWidthProperty

static WindowProperties::UnifiedHeight	d_unifiedHeightProperty

static WindowProperties::UnifiedMinSize	d_unifiedMinSizeProperty

static WindowProperties::UnifiedMaxSize	d_unifiedMaxSizeProperty

static WindowProperties::MousePassThroughEnabled	d_mousePassThroughEnabledProperty

static WindowProperties::WindowRenderer	d_windowRendererProperty

static WindowProperties::LookNFeel	d_lookNFeelProperty

static WindowProperties::DragDropTarget	d_dragDropTargetProperty

Detailed Description

Base class for the multi column list header widget.

Member Function Documentation

void CEGUI::ListHeader::addColumn	(	const String &	text,
		uint	id,
		const 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.

References getColumnCount(), and insertColumn().

ListHeaderSegment * CEGUI::ListHeader::createInitialisedSegment	(	const String &	text,
		uint	id,
		const UDim &	width
	)

protected

Create and return a pointer to a new ListHeaderSegment based object.

Parameters

name	String object holding the name that should be given to the new Window.

Returns: Pointer to an ListHeaderSegment based object of whatever type is appropriate for this ListHeader.

    Cleanup and destroy the given ListHeaderSegment that was created via the
    createNewSegment method.

Parameters

segment Pointer to a ListHeaderSegment based object to be destroyed.

Returns: Nothing.

    Create initialise and return a ListHeaderSegment object, with all events subscribed and ready to use.

Referenced by insertColumn().

ListHeaderSegment * CEGUI::ListHeader::createNewSegment ( const String & name ) const

protected

Create and return a pointer to a new ListHeaderSegment based object.

Parameters

name	String object holding the name that should be given to the new Window.

Returns: Pointer to an ListHeaderSegment based object of whatever type is appropriate for this ListHeader.

References CEGUI::ListHeaderWindowRenderer::createNewSegment(), and CEGUI::Window::d_windowRenderer.

Referenced by createInitialisedSegment().

void CEGUI::ListHeader::destroyListSegment ( ListHeaderSegment * segment ) const

protected

Cleanup and destroy the given ListHeaderSegment that was created via the createNewSegment method.

Parameters

segment Pointer to a ListHeaderSegment based object to be destroyed.

Returns: Nothing.

References CEGUI::Window::d_windowRenderer, and CEGUI::ListHeaderWindowRenderer::destroyListSegment().

Referenced by removeColumn().

uint CEGUI::ListHeader::getColumnCount ( void ) const

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.

References d_segments.

Referenced by addColumn(), getColumnFromID(), getColumnFromSegment(), getColumnWidth(), getColumnWithText(), getPixelOffsetToColumn(), getPixelOffsetToSegment(), getSegmentFromColumn(), getSegmentFromID(), getTotalSegmentsPixelExtent(), insertColumn(), layoutSegments(), moveColumn(), removeColumn(), setColumnDraggingEnabled(), setColumnSizingEnabled(), setColumnWidth(), setSortColumn(), and setSortingEnabled().

uint CEGUI::ListHeader::getColumnFromID ( uint id ) const

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.

References d_segments, getColumnCount(), and CEGUI::Window::getID().

Referenced by CEGUI::MultiColumnList::getColumnWithID().

uint CEGUI::ListHeader::getColumnFromSegment ( const ListHeaderSegment & segment ) const

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.

References d_segments, and getColumnCount().

Referenced by getSortColumn(), insertColumn(), moveColumn(), moveSegment(), removeSegment(), and setSortSegment().

UDim CEGUI::ListHeader::getColumnWidth ( uint column ) const

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.

References d_segments, and getColumnCount().

Referenced by CEGUI::MultiColumnList::getColumnHeaderWidth(), and CEGUI::MultiColumnList::getTotalColumnHeadersWidth().

uint CEGUI::ListHeader::getColumnWithText ( const String & text ) const

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.

References d_segments, getColumnCount(), and CEGUI::Window::getText().

Referenced by CEGUI::MultiColumnList::getColumnWithHeaderText().

float CEGUI::ListHeader::getPixelOffsetToColumn ( uint column ) const

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.

References d_segments, and getColumnCount().

float CEGUI::ListHeader::getPixelOffsetToSegment ( const ListHeaderSegment & segment ) const

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.

References d_segments, and getColumnCount().

ListHeaderSegment & CEGUI::ListHeader::getSegmentFromColumn ( uint column ) const

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.

References d_segments, and getColumnCount().

Referenced by CEGUI::MultiColumnList::getColumnID(), CEGUI::MultiColumnList::getHeaderSegmentForColumn(), CEGUI::MultiColumnList::getItemAtPoint(), CEGUI::MultiColumnList::getNominatedSelectionColumnID(), and CEGUI::MultiColumnList::setSortColumnByID().

ListHeaderSegment & CEGUI::ListHeader::getSegmentFromID ( uint id ) const

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.

References d_segments, getColumnCount(), and CEGUI::Window::getID().

Referenced by setSortColumnFromID().

float CEGUI::ListHeader::getSegmentOffset ( void ) const

inline

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.

uint CEGUI::ListHeader::getSortColumn ( void ) const

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.

References getColumnFromSegment(), and getSortSegment().

Referenced by CEGUI::MultiColumnList::getSortColumn().

ListHeaderSegment::SortDirection CEGUI::ListHeader::getSortDirection ( void ) const

Return the currently set sort direction.

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

References d_sortDir.

Referenced by CEGUI::MultiColumnList::getSortDirection().

ListHeaderSegment & CEGUI::ListHeader::getSortSegment ( void ) const

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.

References d_sortSegment.

Referenced by getSortColumn().

float CEGUI::ListHeader::getTotalSegmentsPixelExtent ( void ) const

Return the total pixel width of all attached segments.

Returns: Sum of the pixel widths of all attached ListHeaderSegment objects.

References d_segments, and getColumnCount().

Referenced by CEGUI::MultiColumnList::configureScrollbars().

void CEGUI::ListHeader::insertColumn	(	const String &	text,
		uint	id,
		const UDim &	width,
		uint	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.

References CEGUI::Window::addChildWindow(), createInitialisedSegment(), d_segments, d_sortSegment, getColumnCount(), layoutSegments(), onSegmentAdded(), and setSortColumn().

Referenced by addColumn(), insertColumn(), and CEGUI::MultiColumnList::insertColumn().

void CEGUI::ListHeader::insertColumn	(	const String &	text,
		uint	id,
		const UDim &	width,
		const 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.

References getColumnFromSegment(), and insertColumn().

bool CEGUI::ListHeader::isColumnDraggingEnabled ( void ) const

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.

References d_movingEnabled.

Referenced by CEGUI::MultiColumnList::isUserColumnDraggingEnabled().

bool CEGUI::ListHeader::isColumnSizingEnabled ( void ) const

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.

References d_sizingEnabled.

Referenced by CEGUI::MultiColumnList::isUserColumnSizingEnabled().

bool CEGUI::ListHeader::isSortingEnabled ( void ) const

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

References d_sortingEnabled.

Referenced by CEGUI::MultiColumnList::isUserSortControlEnabled().

void CEGUI::ListHeader::moveColumn	(	uint	column,
		uint	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.

References d_segments, getColumnCount(), layoutSegments(), and onSegmentSequenceChanged().

Referenced by moveColumn(), CEGUI::MultiColumnList::moveColumn(), and moveSegment().

void CEGUI::ListHeader::moveColumn	(	uint	column,
		const 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.

References getColumnFromSegment(), and moveColumn().

void CEGUI::ListHeader::moveSegment	(	const ListHeaderSegment &	segment,
		uint	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.

References getColumnFromSegment(), and moveColumn().

void CEGUI::ListHeader::moveSegment	(	const ListHeaderSegment &	segment,
		const 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.

References getColumnFromSegment(), and moveColumn().

void CEGUI::ListHeader::removeColumn ( uint 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.

References d_segments, d_sortDir, d_sortSegment, destroyListSegment(), getColumnCount(), layoutSegments(), CEGUI::ListHeaderSegment::None, onSegmentRemoved(), CEGUI::Window::removeChildWindow(), and setSortColumn().

Referenced by CEGUI::MultiColumnList::removeColumn(), and removeSegment().

void CEGUI::ListHeader::removeSegment ( const 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.

References getColumnFromSegment(), and removeColumn().

void CEGUI::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.

References d_movingEnabled, d_segments, getColumnCount(), and onDragMoveSettingChanged().

Referenced by CEGUI::MultiColumnList::setUserColumnDraggingEnabled().

void CEGUI::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.

References d_segments, d_sizingEnabled, getColumnCount(), and onDragSizeSettingChanged().

Referenced by CEGUI::MultiColumnList::setUserColumnSizingEnabled().

void CEGUI::ListHeader::setColumnWidth	(	uint	column,
		const 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.

References d_segments, getColumnCount(), layoutSegments(), and onSegmentSized().

Referenced by CEGUI::MultiColumnList::setColumnHeaderWidth().

void CEGUI::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.

References d_segmentOffset, layoutSegments(), onSegmentOffsetChanged(), and CEGUI::Window::requestRedraw().

void CEGUI::ListHeader::setSortColumn ( uint 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.

References d_segments, d_sortDir, d_sortSegment, getColumnCount(), CEGUI::ListHeaderSegment::None, onSortColumnChanged(), and CEGUI::ListHeaderSegment::setSortDirection().

Referenced by insertColumn(), removeColumn(), CEGUI::MultiColumnList::setSortColumn(), and setSortSegment().

void CEGUI::ListHeader::setSortColumnFromID ( uint 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.

References getSegmentFromID(), and setSortSegment().

Referenced by CEGUI::MultiColumnList::setSortColumnByID().

void CEGUI::ListHeader::setSortDirection ( ListHeaderSegment::SortDirection direction )

Set the current sort direction.

Parameters

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

Returns: Nothing.

References d_sortDir, d_sortSegment, onSortDirectionChanged(), and CEGUI::ListHeaderSegment::setSortDirection().

Referenced by CEGUI::MultiColumnList::setSortDirection().

void CEGUI::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.