Base class for standard Tree widget. More...

Inheritance diagram for CEGUI::Tree:

Collaboration diagram for CEGUI::Tree:

Public Member Functions
void	doTreeRender ()

void	doScrollbars ()

size_t	getItemCount (void) const
	Return number of items attached to the list box. More...

size_t	getSelectedCount (void) const
	Return the number of selected items in the list box. More...

TreeItem *	getFirstSelectedItem (void) const
	Return a pointer to the first selected item. More...

TreeItem *	getLastSelectedItem (void) const
	Return a pointer to the first selected item. More...

TreeItem *	getNextSelected (const TreeItem *start_item) const
	Return a pointer to the next selected item after item start_item. More...

TreeItem *	getNextSelectedItemFromList (const LBItemList &itemList, const TreeItem *start_item, bool foundStartItem) const

bool	isSortEnabled (void) const
	return whether list sorting is enabled More...

void	setItemRenderArea (Rect &r)

Scrollbar *	getVertScrollbar ()

Scrollbar *	getHorzScrollbar ()

bool	isMultiselectEnabled (void) const
	return whether multi-select is enabled More...

bool	isItemTooltipsEnabled (void) const

TreeItem *	findFirstItemWithText (const String &text)
	Search the list for an item with the specified text. More...

TreeItem *	findNextItemWithText (const String &text, const TreeItem *start_item)

TreeItem *	findItemWithTextFromList (const LBItemList &itemList, const String &text, const TreeItem *start_item, bool foundStartItem)

TreeItem *	findFirstItemWithID (uint searchID)
	Search the list for an item with the specified text. More...

TreeItem *	findNextItemWithID (uint searchID, const TreeItem *start_item)

TreeItem *	findItemWithIDFromList (const LBItemList &itemList, uint searchID, const TreeItem *start_item, bool foundStartItem)

bool	isTreeItemInList (const TreeItem *item) const
	Return whether the specified TreeItem is in the List. More...

bool	isVertScrollbarAlwaysShown (void) const
	Return whether the vertical scroll bar is always shown. More...

bool	isHorzScrollbarAlwaysShown (void) const
	Return whether the horizontal scroll bar is always shown. More...

virtual void	initialise (void)
	Initialise the Window based object ready for use. More...

void	resetList (void)
	Remove all items from the list. More...

void	addItem (TreeItem *item)
	Add the given TreeItem to the list. More...

void	insertItem (TreeItem item, const TreeItem position)
	Insert an item into the list box after a specified item already in the list. More...

void	removeItem (const TreeItem *item)
	Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted. More...

void	clearAllSelections (void)
	Clear the selected state for all items. More...

bool	clearAllSelectionsFromList (const LBItemList &itemList)

void	setSortingEnabled (bool setting)
	Set whether the list should be sorted. More...

void	setMultiselectEnabled (bool setting)
	Set whether the list should allow multiple selections or just a single selection. More...

void	setShowVertScrollbar (bool setting)
	Set whether the vertical scroll bar should always be shown. More...

void	setShowHorzScrollbar (bool setting)
	Set whether the horizontal scroll bar should always be shown. More...

void	setItemTooltipsEnabled (bool setting)

void	setItemSelectState (TreeItem *item, bool state)
	Set the select state of an attached TreeItem. More...

void	setItemSelectState (size_t item_index, bool state)
	Set the select state of an attached TreeItem. More...

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

void	handleUpdatedItemData (void)
	Causes the list box to update it's internal state after changes have been made to one or more attached TreeItem objects. More...

void	ensureItemIsVisible (const TreeItem *item)
	Ensure the item at the specified index is visible within the list box. More...

	Tree (const String &type, const String &name)
	Constructor for Tree base class.

virtual	~Tree (void)
	Destructor for Tree 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	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...

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

static const String	EventListContentsChanged
	Event triggered when the contents of the list is changed.

static const String	EventSelectionChanged
	Event triggered when there is a change to the currently selected item(s).

static const String	EventSortModeChanged
	Event triggered when the sort mode setting changes.

static const String	EventMultiselectModeChanged
	Event triggered when the multi-select mode setting changes.

static const String	EventVertScrollbarModeChanged
	Event triggered when the vertical scroll bar 'force' setting changes.

static const String	EventHorzScrollbarModeChanged
	Event triggered when the horizontal scroll bar 'force' setting changes.

static const String	EventBranchOpened
	Event triggered when a branch of the tree is opened by the user.

static const String	EventBranchClosed
	Event triggered when a branch of the tree is closed by the user.

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 Member Functions
virtual Rect	getTreeRenderArea (void) const
	Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. More...

virtual Scrollbar *	createVertScrollbar (const String &name) const
	create and return a pointer to a Scrollbar widget for use as vertical scroll bar More...

virtual Scrollbar *	createHorzScrollbar (const String &name) const
	create and return a pointer to a Scrollbar widget for use as horizontal scroll bar More...

virtual void	cacheTreeBaseImagery ()
	Perform caching of the widget control frame and other 'static' areas. This method should not render the actual items. Note that the items are typically rendered to layer 3, other layers can be used for rendering imagery behind and infront of the items. More...

void	addTreeEvents (void)
	Add list box specific events.

void	configureScrollbars (void)
	display required integrated scroll bars according to current state of the list box and update their values.

void	selectRange (size_t start, size_t end)
	select all strings between positions start and end. (inclusive) including end.

float	getTotalItemsHeight (void) const
	Return the sum of all item heights.

void	getTotalItemsInListHeight (const LBItemList &itemList, float *heightSum) const

float	getWidestItemWidth (void) const
	Return the width of the widest item.

void	getWidestItemWidthInList (const LBItemList &itemList, int itemDepth, float *widest) const

bool	getHeightToItemInList (const LBItemList &itemList, const TreeItem treeItem, int itemDepth, float height) const
	Clear the selected state for all items (implementation) More...

bool	clearAllSelections_impl (void)
	Clear the selected state for all items (implementation) More...

TreeItem *	getItemAtPoint (const Point &pt) const
	Return the TreeItem under the given window local pixel co-ordinate. More...

TreeItem *	getItemFromListAtPoint (const LBItemList &itemList, float *bottomY, const Point &pt) const

bool	resetList_impl (void)
	Remove all items from the list. More...

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

bool	handle_scrollChange (const EventArgs &args)
	Internal handler that is triggered when the user interacts with the scrollbars.

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

void	drawItemList (LBItemList &itemList, Rect &itemsArea, float widest, Vector3 &itemPos, RenderCache &cache, float alpha)

virtual void	onListContentsChanged (WindowEventArgs &e)
	Handler called internally when the list contents are changed.

virtual void	onSelectionChanged (TreeEventArgs &e)
	Handler called internally when the currently selected item or items changes.

virtual void	onSortModeChanged (WindowEventArgs &e)
	Handler called internally when the sort mode setting changes.

virtual void	onMultiselectModeChanged (WindowEventArgs &e)
	Handler called internally when the multi-select mode setting changes.

virtual void	onVertScrollbarModeChanged (WindowEventArgs &e)
	Handler called internally when the forced display of the vertical scroll bar setting changes.

virtual void	onHorzScrollbarModeChanged (WindowEventArgs &e)
	Handler called internally when the forced display of the horizontal scroll bar setting changes.

virtual void	onBranchOpened (TreeEventArgs &e)
	Handler called internally when the user opens a branch of the tree.

virtual void	onBranchClosed (TreeEventArgs &e)
	Handler called internally when the user closes a branch of the tree.

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

virtual void	onMouseButtonDown (MouseEventArgs &e)
	Handler called when a mouse button has been depressed 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	onMouseMove (MouseEventArgs &e)
	Handler called when the mouse cursor has been moved within this window's area. More...

Protected Member Functions inherited from CEGUI::Window
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	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...

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.

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

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
bool	d_sorted
	true if list is sorted

bool	d_multiselect
	true if multi-select is enabled

bool	d_forceVertScroll
	true if vertical scrollbar should always be displayed

bool	d_forceHorzScroll
	true if horizontal scrollbar should always be displayed

bool	d_itemTooltips
	true if each item should have an individual tooltip

Scrollbar *	d_vertScrollbar
	vertical scroll-bar widget

Scrollbar *	d_horzScrollbar
	horizontal scroll-bar widget

LBItemList	d_listItems
	list of items in the list box.

TreeItem *	d_lastSelected
	holds pointer to the last selected item (used in range selections)

ImagerySection *	openButtonImagery

ImagerySection *	closeButtonImagery

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.

Friends
class	TreeItem

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

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

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 standard Tree widget.

Member Function Documentation

void CEGUI::Tree::addItem ( TreeItem * item )

Add the given TreeItem to the list.

Parameters

item	Pointer to the TreeItem to be added to the list. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens.

Returns: Nothing.

References d_listItems, isSortEnabled(), CEGUI::lbi_less(), onListContentsChanged(), and CEGUI::TreeItem::setOwnerWindow().

Referenced by insertItem().

virtual void CEGUI::Tree::cacheTreeBaseImagery ( )

inlineprotectedvirtual

Perform caching of the widget control frame and other 'static' areas. This method should not render the actual items. Note that the items are typically rendered to layer 3, other layers can be used for rendering imagery behind and infront of the items.

Returns: Nothing.

Referenced by populateRenderCache().

void CEGUI::Tree::clearAllSelections ( void )

Clear the selected state for all items.

Returns: Nothing.

References clearAllSelections_impl(), and onSelectionChanged().

bool CEGUI::Tree::clearAllSelections_impl ( void )

protected

Clear the selected state for all items (implementation)

Returns: true if some selections were cleared, false nothing was changed.

References d_listItems.

Referenced by clearAllSelections(), onMouseButtonDown(), and setItemSelectState().

virtual Scrollbar* CEGUI::Tree::createHorzScrollbar ( const String & name ) const

inlineprotectedvirtual

create and return a pointer to a Scrollbar widget for use as horizontal scroll bar

Parameters

name	String holding the name to be given to the created widget component.

Returns: Pointer to a Scrollbar to be used for scrolling the list horizontally.

Referenced by configureScrollbars(), and initialise().

virtual Scrollbar* CEGUI::Tree::createVertScrollbar ( const String & name ) const

inlineprotectedvirtual

create and return a pointer to a Scrollbar widget for use as vertical scroll bar

Parameters

name	String holding the name to be given to the created widget component.

Returns: Pointer to a Scrollbar to be used for scrolling the list vertically.

Referenced by configureScrollbars(), and initialise().

void CEGUI::Tree::ensureItemIsVisible ( const TreeItem * item )

Ensure the item at the specified index is visible within the list box.

Parameters

item	Pointer to the TreeItem to be made visible in the list box.

Returns: Nothing.

Exceptions

InvalidRequestException thrown if item is not attached to this list box.

References d_listItems, d_vertScrollbar, CEGUI::Scrollbar::getDocumentSize(), CEGUI::Rect::getHeight(), getHeightToItemInList(), getItemCount(), CEGUI::Scrollbar::getPageSize(), CEGUI::TreeItem::getPixelSize(), CEGUI::Scrollbar::getScrollPosition(), getTreeRenderArea(), and CEGUI::Scrollbar::setScrollPosition().

Referenced by onMouseButtonDown().

TreeItem * CEGUI::Tree::findFirstItemWithID ( uint searchID )

Search the list for an item with the specified text.

Parameters

text	String object containing the text to be searched for.
start_item	TreeItem where the search is to begin, the search will not include item. If item is NULL, the search will begin from the first item in the list.

Returns: Pointer to the first TreeItem in the list after item that has text matching text. If no item matches the criteria NULL is returned.

Exceptions

InvalidRequestException thrown if item is not attached to this list box.

References d_listItems.

TreeItem * CEGUI::Tree::findFirstItemWithText ( const String & text )

Search the list for an item with the specified text.

Parameters

text	String object containing the text to be searched for.
start_item	TreeItem where the search is to begin, the search will not include item. If item is NULL, the search will begin from the first item in the list.

Returns: Pointer to the first TreeItem in the list after item that has text matching text. If no item matches the criteria NULL is returned.

Exceptions

InvalidRequestException thrown if item is not attached to this list box.

References d_listItems.

TreeItem * CEGUI::Tree::getFirstSelectedItem ( void ) const

Return a pointer to the first selected item.

Returns: Pointer to a TreeItem based object that is the first selected item in the list. will return NULL if no item is selected.

References d_listItems.

Referenced by setMultiselectEnabled().

bool CEGUI::Tree::getHeightToItemInList	(	const LBItemList &	itemList,
		const TreeItem *	treeItem,
		int	itemDepth,
		float *	height
	)		const

protected

Clear the selected state for all items (implementation)

Returns: true if treeItem was found in the search, false if it was not.

References getItemCount().

Referenced by ensureItemIsVisible().

TreeItem * CEGUI::Tree::getItemAtPoint ( const Point & pt ) const

protected

Return the TreeItem under the given window local pixel co-ordinate.

Returns: TreeItem that is under window pixel co-ordinate pt, or NULL if no item is under that position.

References d_listItems, d_vertScrollbar, CEGUI::Scrollbar::getScrollPosition(), getTreeRenderArea(), and CEGUI::Rect::isPointInRect().

Referenced by onMouseButtonDown(), and onMouseMove().

size_t CEGUI::Tree::getItemCount ( void ) const

inline

Return number of items attached to the list box.

Returns: the number of items currently attached to this list box.

Referenced by ensureItemIsVisible(), getHeightToItemInList(), resetList_impl(), and setItemSelectState().

TreeItem* CEGUI::Tree::getLastSelectedItem ( void ) const

inline

Return a pointer to the first selected item.

Returns: Pointer to a TreeItem based object that is the last item selected by the user, not necessarily the last selected in the list. Will return NULL if no item is selected.

TreeItem * CEGUI::Tree::getNextSelected ( const TreeItem * start_item ) const

Return a pointer to the next selected item after item start_item.

Parameters

start_item Pointer to the TreeItem where the search for the next selected item is to begin. If this parameter is NULL, the search will begin with the first item in the list box.

Returns: Pointer to a TreeItem based object that is the next selected item in the list after the item specified by start_item. Will return NULL if no further items were selected.

Exceptions

InvalidRequestException thrown if start_item is not attached to this list box.

References d_listItems.

Referenced by setMultiselectEnabled().

size_t CEGUI::Tree::getSelectedCount ( void ) const

Return the number of selected items in the list box.

Returns: Total number of attached items that are in the selected state.

References d_listItems.

Referenced by setMultiselectEnabled().

virtual Rect CEGUI::Tree::getTreeRenderArea ( void ) const

inlineprotectedvirtual

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

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

Referenced by configureScrollbars(), ensureItemIsVisible(), and getItemAtPoint().

void CEGUI::Tree::handleUpdatedItemData ( void )

Causes the list box to update it's internal state after changes have been made to one or more attached TreeItem objects.

    Client code must call this whenever it has made any changes to TreeItem objects already attached to the
    list box.  If you are just adding items, or removed items to update them prior to re-adding them, there is
    no need to call this method.

Returns: Nothing.

References configureScrollbars(), and CEGUI::Window::requestRedraw().

void CEGUI::Tree::initialise ( void )

virtual

Initialise the Window based object ready for use.

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

Returns: Nothing

References CEGUI::Window::addChildWindow(), configureScrollbars(), createHorzScrollbar(), createVertScrollbar(), d_horzScrollbar, CEGUI::Window::d_lookName, d_vertScrollbar, CEGUI::Scrollbar::EventScrollPositionChanged, CEGUI::WidgetLookFeel::getImagerySection(), CEGUI::Window::getName(), CEGUI::WidgetLookManager::getSingleton(), CEGUI::WidgetLookManager::getWidgetLook(), handle_scrollChange(), CEGUI::Window::performChildWindowLayout(), and CEGUI::EventSet::subscribeEvent().

Referenced by setLookNFeel().

void CEGUI::Tree::insertItem	(	TreeItem *	item,
		const TreeItem *	position
	)

Insert an item into the list box after a specified item already in the list.

    Note that if the list is sorted, the item may not end up in the requested position.

Parameters

item	Pointer to the TreeItem to be inserted. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens.
position	Pointer to a TreeItem that item is to be inserted after. If this parameter is NULL, the item is inserted at the start of the list.

Returns: Nothing.

Exceptions

InvalidRequestException thrown if no TreeItem position is attached to this list box.

References addItem(), d_listItems, isSortEnabled(), onListContentsChanged(), and CEGUI::TreeItem::setOwnerWindow().

bool CEGUI::Tree::isHorzScrollbarAlwaysShown ( void ) const

Return whether the horizontal scroll bar is always shown.

Returns

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

References d_forceHorzScroll.

bool CEGUI::Tree::isMultiselectEnabled ( void ) const

inline

return whether multi-select is enabled

Returns: true if multi-select is enabled, false if multi-select is not enabled.

bool CEGUI::Tree::isSortEnabled ( void ) const

inline

return whether list sorting is enabled

Returns: true if the list is sorted, false if the list is not sorted

Referenced by addItem(), and insertItem().

bool CEGUI::Tree::isTreeItemInList ( const TreeItem * item ) const

Return whether the specified TreeItem is in the List.

Returns: true if TreeItem item is in the list, false if TreeItem item is not in the list.

References d_listItems.

bool CEGUI::Tree::isVertScrollbarAlwaysShown ( void ) const

Return whether the vertical scroll bar is always shown.

Returns

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

References d_forceVertScroll.

void CEGUI::Tree::onMouseButtonDown ( MouseEventArgs & e )

protectedvirtual

Handler called when a mouse button has been depressed within this window's area.

Parameters

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

References CEGUI::MouseEventArgs::button, clearAllSelections_impl(), configureScrollbars(), CEGUI::Control, d_lastSelected, d_multiselect, ensureItemIsVisible(), getItemAtPoint(), CEGUI::EventArgs::handled, CEGUI::TreeItem::isSelected(), onBranchClosed(), onBranchOpened(), CEGUI::Window::onMouseButtonDown(), onSelectionChanged(), populateRenderCache(), CEGUI::MouseEventArgs::position, CEGUI::CoordConverter::screenToWindow(), selectRange(), CEGUI::TreeItem::setSelected(), CEGUI::Shift, and CEGUI::MouseEventArgs::sysKeys.

void CEGUI::Tree::onMouseMove ( MouseEventArgs & e )

protectedvirtual

Handler called when the mouse cursor has been moved within this window's area.

Parameters

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

References d_itemTooltips, getItemAtPoint(), CEGUI::Tooltip::getTargetWindow(), CEGUI::Window::getTooltip(), CEGUI::Window::onMouseMove(), CEGUI::MouseEventArgs::position, CEGUI::Tooltip::positionSelf(), CEGUI::CoordConverter::screenToWindow(), CEGUI::Tooltip::setTargetWindow(), and CEGUI::Window::setTooltipText().

void CEGUI::Tree::onMouseWheel ( MouseEventArgs & e )

protectedvirtual

Handler called when the mouse wheel (z-axis) position changes within this window's area.

Parameters

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

References d_horzScrollbar, d_vertScrollbar, CEGUI::Scrollbar::getDocumentSize(), CEGUI::Scrollbar::getPageSize(), CEGUI::Scrollbar::getScrollPosition(), CEGUI::Scrollbar::getStepSize(), CEGUI::EventArgs::handled, CEGUI::Window::isVisible(), CEGUI::Window::onMouseWheel(), CEGUI::Scrollbar::setScrollPosition(), and CEGUI::MouseEventArgs::wheelChange.

void CEGUI::Tree::onSized ( WindowEventArgs & e )

protectedvirtual

Handler called when the window's size changes.

Parameters

e	WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Reimplemented from CEGUI::Window.

References configureScrollbars(), CEGUI::EventArgs::handled, and CEGUI::Window::onSized().

void CEGUI::Tree::populateRenderCache ( )

protectedvirtual

Update the rendering cache.

Populates the Window's RenderCache with imagery to be sent to the renderer.

Reimplemented from CEGUI::Window.

References cacheTreeBaseImagery(), d_horzScrollbar, d_listItems, CEGUI::Window::d_renderCache, d_vertScrollbar, CEGUI::Renderer::getCurrentZ(), CEGUI::Window::getEffectiveAlpha(), CEGUI::System::getRenderer(), CEGUI::Scrollbar::getScrollPosition(), CEGUI::System::getSingleton(), getWidestItemWidth(), and CEGUI::Renderer::getZLayer().

Referenced by onMouseButtonDown().

void CEGUI::Tree::removeItem ( const TreeItem * item )

Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted.

Parameters

item	Pointer to the TreeItem that is to be removed. If item is not attached to this list box then nothing will happen.

Returns: Nothing.

References d_lastSelected, d_listItems, CEGUI::TreeItem::isAutoDeleted(), and onListContentsChanged().

void CEGUI::Tree::resetList ( void )

Remove all items from the list.

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

References onListContentsChanged(), and resetList_impl().

bool CEGUI::Tree::resetList_impl ( void )

protected

Remove all items from the list.

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

Returns

true if the list contents were changed.
false if the list contents were not changed (list already empty).

References d_lastSelected, d_listItems, and getItemCount().

Referenced by resetList(), and ~Tree().

void CEGUI::Tree::setItemSelectState	(	TreeItem *	item,
		bool	state
	)

Set the select state of an attached TreeItem.

    This is the recommended way of selecting and deselecting items attached to a list box as it respects the
    multi-select mode setting.  It is possible to modify the setting on TreeItems directly, but that approach
    does not respect the settings of the list box.

Parameters

item	The TreeItem to be affected. This item must be attached to the list box.
state	true to select the item, false to de-select the item.

Returns: Nothing.

Exceptions

InvalidRequestException thrown if item is not attached to this list box.

References d_listItems.

void CEGUI::Tree::setItemSelectState	(	size_t	item_index,
		bool	state
	)

Set the select state of an attached TreeItem.

    This is the recommended way of selecting and deselecting items attached to a list box as it respects the
    multi-select mode setting.  It is possible to modify the setting on TreeItems directly, but that approach
    does not respect the settings of the list box.

Parameters

item_index	The zero based index of the TreeItem to be affected. This must be a valid index (0 <= index < getItemCount())
state	true to select the item, false to de-select the item.

Returns: Nothing.

Exceptions

InvalidRequestException thrown if item_index is out of range for the list box

References clearAllSelections_impl(), d_listItems, d_multiselect, getItemCount(), and onSelectionChanged().

void CEGUI::Tree::setLookNFeel ( const String & look )

virtual

Set the LookNFeel that shoule be used for this window.

Parameters

look	String object holding the name of the look to be assigned to the window.

Returns: Nothing.

Exceptions

UnknownObjectException thrown if the look'n'feel specified by look does not exist.

Note: Once a look'n'feel has been assigned it is locked - as in cannot be changed.

Reimplemented from CEGUI::Window.

References initialise(), and CEGUI::Window::setLookNFeel().

void CEGUI::Tree::setMultiselectEnabled ( bool setting )

Set whether the list should allow multiple selections or just a single selection.

Parameters

setting true if the widget should allow multiple items to be selected, false if the widget should only allow a single selection.

Returns: Nothing.

References d_multiselect, getFirstSelectedItem(), getNextSelected(), getSelectedCount(), onMultiselectModeChanged(), onSelectionChanged(), and CEGUI::TreeItem::setSelected().

void CEGUI::Tree::setShowHorzScrollbar ( bool setting )

Set whether the horizontal scroll bar should always be shown.

Parameters

setting true if the horizontal scroll bar should be shown even when it is not required. false if the horizontal scroll bar should only be shown when it is required.

Returns: Nothing.

References configureScrollbars(), d_forceHorzScroll, and onHorzScrollbarModeChanged().

void CEGUI::Tree::setShowVertScrollbar ( bool setting )

Set whether the vertical scroll bar should always be shown.

Parameters

setting true if the vertical scroll bar should be shown even when it is not required. false if the vertical scroll bar should only be shown when it is required.