Base scroll bar class. More...

Inheritance diagram for CEGUI::Scrollbar:

Collaboration diagram for CEGUI::Scrollbar:

Public Member Functions
float	getDocumentSize (void) const
	Return the size of the document or data. More...

void	setDocumentSize (float document_size)
	Set the size of the document or data. More...

float	getPageSize (void) const
	Return the page size for this scroll bar. More...

void	setPageSize (float page_size)
	Set the page size for this scroll bar. More...

float	getStepSize (void) const
	Return the step size for this scroll bar. More...

void	setStepSize (float step_size)
	Set the step size for this scroll bar. More...

float	getOverlapSize (void) const
	Return the overlap size for this scroll bar. More...

void	setOverlapSize (float overlap_size)
	Set the overlap size for this scroll bar. More...

float	getScrollPosition (void) const
	Return the current position of scroll bar within the document. More...

void	setScrollPosition (float position)
	Set the current position of scroll bar within the document. More...

float	getUnitIntervalScrollPosition () const
	return the current scroll position as a value in the interval [0, 1]

void	setUnitIntervalScrollPosition (float position)
	set the current scroll position as a value in the interval [0, 1]

PushButton *	getIncreaseButton () const
	Return a pointer to the 'increase' PushButtoncomponent widget for this Scrollbar. More...

PushButton *	getDecreaseButton () const
	Return a pointer to the 'decrease' PushButton component widget for this Scrollbar. More...

Thumb *	getThumb () const
	Return a pointer to the Thumb component widget for this Scrollbar. More...

void	setConfig (const float const document_size, const float const page_size, const float const step_size, const float const overlap_size, const float *const position)
	Sets multiple scrollbar configuration parameters simultaneously. More...

void	setEndLockEnabled (const bool enabled)
	Enable or disable the 'end lock' mode for the scrollbar. More...

bool	isEndLockEnabled () const
	Returns whether the 'end lock'mode for the scrollbar is enabled. More...

void	scrollForwardsByStep ()
	move scroll position forwards by the current step size

void	scrollBackwardsByStep ()
	move scroll position backwards by the current step size

void	scrollForwardsByPage ()
	move scroll position forwards by a page (uses appropriate overlap)

void	scrollBackwardsByPage ()
	move scroll position backwards by a page (uses appropriate overlap)

	Scrollbar (const String &type, const String &name)

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

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

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 () const
	return whether the Window is currently disabled More...

bool	isEffectiveDisabled () const
	return whether the Window is currently disabled More...

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

bool	isEffectiveVisible () 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...

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

Window *	getChildAtIdx (size_t idx) const
	returns a pointer to the child window at the specified index. Idx is the index of the window in the child window list. It is based on the order in which the children were added and is stable. More...

Window *	getChild (const String &name_path) const
	return the attached child window that the given name path references. More...

Window *	getChildRecursive (const String &name) const
	return a pointer to the first attached child window with the specified name. Children are traversed recursively. More...

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 *	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 (uint ID) const
	return true if any Window with the given ID is some ancestor of this Window. More...

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

const String &	getTextVisual () const
	return text string with visual ordering of glyphs.

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

const Rectf &	getOuterRectClipper () const
	Return a Rect that describes the rendering clipping rect based upon the outer rect area of the window. More...

const Rectf &	getInnerRectClipper () const
	Return a Rect that describes the rendering clipping rect based upon the inner rect area of the window. More...

const Rectf &	getClipRect (const bool non_client=false) const
	Return a Rect that describes the rendering clipping rect for the Window. More...

const Rectf &	getHitTestRect () const
	Return the Rect that descibes the clipped screen area that is used for determining whether this window has been hit by a certain point. More...

Window *	getCaptureWindow () const
	return the Window that currently has inputs captured. 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 Vector2f &position, const bool allow_disabled=false) const
	check if the given pixel position would hit this window. More...

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

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

Window *	getParent () 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...

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

GeometryBuffer &	getGeometryBuffer ()
	Return the GeometryBuffer 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...

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

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

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

void	getRenderingContext (RenderingContext &ctx) const
	Fill in the RenderingContext ctx with details of the RenderingSurface where this Window object should normally do it's rendering.

virtual void	getRenderingContext_impl (RenderingContext &ctx) const
	implementation of the default getRenderingContext logic.

RenderingSurface *	getRenderingSurface () const
	return the RenderingSurface currently set for this window. May return 0.

RenderingSurface &	getTargetRenderingSurface () const
	return the RenderingSurface that will be used by this window as the target for rendering.

bool	isUsingAutoRenderingSurface () const
	Returns whether automatic use of an imagery caching RenderingSurface (i.e. a RenderingWindow) is enabled for this window. The reason we emphasise 'automatic' is because the client may manually set a RenderingSurface that does exactly the same job. More...

const Window *	getRootWindow () const
	Returns the window at the root of the hierarchy starting at this Window. The root window is defined as the first window back up the hierarchy that has no parent window. More...

Window *	getRootWindow ()

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	setDisabled (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	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 (const Font *font)
	Set the font used by this Window. More...

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

void	removeChild (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...

Window *	createChild (const String &type, const String &name="")
	Creates a child window attached to this window. More...

void	destroyChild (Window *wnd)
	Destroys a child window of this window. More...

void	destroyChild (const String &name_path)
	Destroys a child window of this window. 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...

void	moveInFront (const Window *const window)
	Move this window immediately above it's sibling window in the z order. More...

void	moveBehind (const Window *const window)
	Move this window immediately behind it's sibling window in the z order. More...

size_t	getZIndex () const
	Return the (visual) z index of the window on it's parent. More...

bool	isInFront (const Window &wnd) const
	Return whether /a this Window is in front of the given window. More...

bool	isBehind (const Window &wnd) const
	Return whether /a this Window is behind the given window. 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	setRestoreOldCapture (bool setting)
	Set whether this window will remember and restore the previous window that had inputs captured. More...

void	setAlpha (const 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	invalidate (void)
	Invalidate this window causing at least this window to be redrawn during the next rendering pass. More...

void	invalidate (const bool recursive)
	Invalidate this window and - dependant upon recursive - all child content, causing affected windows to be redrawn during the next rendering pass. More...

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

void	setMouseCursor (const String &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...

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 (bool nonclient_sized_hint=false, bool client_sized_hint=false)
	Layout child window content. More...

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

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

virtual 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 bool	performCopy (Clipboard &clipboard)
	Asks the widget to perform a clipboard copy to the provided clipboard. More...

virtual bool	performCut (Clipboard &clipboard)
	Asks the widget to perform a clipboard cut to the provided clipboard. More...

virtual bool	performPaste (Clipboard &clipboard)
	Asks the widget to perform a clipboard paste from the provided clipboard. 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 type to be used when rendering this window. More...

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

const String &	getWindowRendererName () 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.

virtual void	notifyScreenAreaChanged (bool recursive=true)
	Inform the window, and optionally all children, that screen area rectangles have changed. More...

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

void	setRenderingSurface (RenderingSurface *surface)
	Set the RenderingSurface to be associated with this Window, or 0 if none is required. More...

void	invalidateRenderingSurface ()
	Invalidate the chain of rendering surfaces from this window backwards to ensure they get properly redrawn - but doing the minimum amount of work possibe - next render.

void	setUsingAutoRenderingSurface (bool setting)
	Sets whether automatic use of an imagery caching RenderingSurface (i.e. a RenderingWindow) is enabled for this window. The reason we emphasise 'atutomatic' is because the client may manually set a RenderingSurface that does exactlythe same job. More...

const RenderedString &	getRenderedString () const
	Return the parsed RenderedString object for this window.

RenderedStringParser *	getCustomRenderedStringParser () const
	Return a pointer to any custom RenderedStringParser set, or 0 if none.

void	setCustomRenderedStringParser (RenderedStringParser *parser)
	Set a custom RenderedStringParser, or 0 to remove an existing one.

virtual RenderedStringParser &	getRenderedStringParser () const
	return the active RenderedStringParser to be used

bool	isTextParsingEnabled () const
	return whether text parsing is enabled for this window.

void	setTextParsingEnabled (const bool setting)
	set whether text parsing is enabled for this window.

virtual void	setMargin (const UBox &margin)
	set margin

const UBox &	getMargin () const
	retrieves currently set margin

Vector2f	getUnprojectedPosition (const Vector2f &pos) const
	return Vector2 pos after being fully unprojected for this Window.

const BidiVisualMapping *	getBidiVisualMapping () const
	return the pointer to the BidiVisualMapping for this window, if any.

void	banPropertyFromXML (const String &property_name)
	Add the named property to the XML ban list for this window. More...

void	unbanPropertyFromXML (const String &property_name)
	Remove the named property from the XML ban list for this window.

bool	isPropertyBannedFromXML (const String &property_name) const
	Return whether the named property is banned from XML. More...

void	banPropertyFromXML (const Property *property)
	Add the given property to the XML ban list for this window.

void	unbanPropertyFromXML (const Property *property)
	Remove the given property from the XML ban list for this window.

bool	isPropertyBannedFromXML (const Property *property) const
	Return whether given property is banned from XML. More...

void	setUpdateMode (const WindowUpdateMode mode)
	Set the window update mode. This mode controls the behaviour of the Window::update member function such that updates are processed for this window (and therefore it's child content) according to the set mode. More...

WindowUpdateMode	getUpdateMode () const
	Return the current window update mode that is set for this Window. This mode controls the behaviour of the Window::update member function such that updates are processed for this window (and therefore it's child content) according to the set mode. More...

void	setMouseInputPropagationEnabled (const bool enabled)
	Set whether mouse input that is not directly handled by this Window (including it's event subscribers) should be propagated back to the Window's parent. More...

bool	isMouseInputPropagationEnabled () const
	Return whether mouse input that is not directly handled by this Window (including it's event subscribers) should be propagated back to the Window's parent. More...

Window *	clone (const bool deepCopy=true) const
	Clones this Window and returns the result. More...

virtual void	clonePropertiesTo (Window &target) const
	copies this widget's properties to given target widget

virtual void	cloneChildWidgetsTo (Window &target) const
	copies this widget's child widgets to given target widget

GUIContext &	getGUIContext () const
	return the GUIContext this window is associated with.

void	setGUIContext (GUIContext *context)
	function used internally. Do not call this from client code.

void	syncTargetSurface ()
	ensure that the window will be rendered to the correct target surface.

void	setAutoWindow (bool is_auto)
	Set whether this window is marked as an auto window. More...

bool	isMouseContainedInArea () const
	Return whether Window thinks mouse is currently within its area. More...

const Sizef &	getRootContainerSize () const
	Return the size of the root container (such as screen size). More...

Public Member Functions inherited from CEGUI::NamedElement
	NamedElement (const String &name="")
	Constructor. More...

virtual	~NamedElement ()
	Destructor.

virtual void	setName (const String &name)
	Renames the element. More...

const String &	getName () const
	Return a String object holding the name of this Element.

String	getNamePath () const
	Return a String object that describes the name path for this Element.

bool	isChild (const String &name_path) const
	Checks whether given name path references a NamedElement that is attached to this Element. More...

bool	isChildRecursive (const String &name) const
	returns whether at least one window with the given name is attached to this Window or any of it's children as a child. More...

bool	isAncestor (const String &name) const
	Return true if the specified element name is a name of some ancestor of this Element. More...

NamedElement *	getChildElement (const String &name_path) const
	Return the attached child element that the given name path references. More...

NamedElement *	getChildElementRecursive (const String &name) const
	Find the first child with the given name, recursively and breadth-first. More...

void	removeChild (const String &name_path)
	Remove the Element referenced by the given name path from this Element's child list. More...

Public Member Functions inherited from CEGUI::Element
	Element ()
	Constructor.

virtual	~Element ()
	Destructor.

Element *	getParentElement () const
	Retrieves parent of this element. More...

virtual void	setArea (const UVector2 &pos, const USize &size)
	Set the Element area. More...

void	setArea (const UDim &xpos, const UDim &ypos, const UDim &width, const UDim &height)

void	setArea (const URect &area)

const URect &	getArea () const
	Return the element's area. More...

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

void	setXPosition (const UDim &pos)

void	setYPosition (const UDim &pos)

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

const UDim &	getXPosition () const

const UDim &	getYPosition () const

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

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

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

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

void	setSize (const USize &size)
	Set the element's size. More...

void	setWidth (const UDim &width)

void	setHeight (const UDim &height)

USize	getSize () const
	Get the element's size. More...

UDim	getWidth () const

UDim	getHeight () const

void	setMinSize (const USize &size)
	Set the element's minimum size. More...

const USize &	getMinSize () const
	Get the element's minimum size. More...

void	setMaxSize (const USize &size)
	Set the element's maximum size. More...

const USize &	getMaxSize () const
	Get the element's maximum size. More...

void	setAspectMode (const AspectMode mode)
	Sets current aspect mode and recalculates the area rect. More...

AspectMode	getAspectMode () const
	Retrieves currently used aspect mode. More...

void	setAspectRatio (const float ratio)
	Sets target aspect ratio. More...

float	getAspectRatio () const
	Retrieves target aspect ratio. More...

void	setPixelAligned (const bool setting)
	Sets whether this Element is pixel aligned (both position and size, basically the 4 "corners"). More...

bool	isPixelAligned () const
	Checks whether this Element is pixel aligned. More...

const Vector2f &	getPixelPosition () const
	Return the element's absolute (or screen, depending on the type of the element) position in pixels. More...

const Sizef &	getPixelSize () const
	Return the element's size in pixels. More...

Sizef	calculatePixelSize (bool skipAllPixelAlignment=false) const
	Calculates this element's pixel size. More...

Sizef	getParentPixelSize (bool skipAllPixelAlignment=false) const
	Return the pixel size of the parent element. More...

void	setRotation (const Quaternion &rotation)
	sets rotation of this widget More...

const Quaternion &	getRotation () const
	retrieves rotation of this widget More...

void	addChild (Element *element)
	Add the specified Element as a child of this Element. More...

void	removeChild (Element *element)
	Remove the Element Element's child list. More...

Element *	getChildElementAtIdx (size_t idx) const
	return a pointer to the child element that is attached to 'this' at the given index. More...

size_t	getChildCount () const
	Returns number of child elements attached to this Element.

bool	isChild (const Element *element) const
	Checks whether given element is attached to this Element.

bool	isAncestor (const Element *element) const
	Checks whether the specified Element is an ancestor of this Element. More...

void	setNonClient (const bool setting)
	Set whether the Element is non-client. More...

bool	isNonClient () const
	Checks whether this element was set to be non client. More...

const CachedRectf &	getUnclippedOuterRect () const
	Return a Rect that describes the unclipped outer rect area of the Element. More...

const CachedRectf &	getUnclippedInnerRect () const
	Return a Rect that describes the unclipped inner rect area of the Element. More...

const CachedRectf &	getUnclippedRect (const bool inner) const
	Return a Rect that describes the unclipped area covered by the Element. More...

virtual const CachedRectf &	getClientChildContentArea () const
	Return a Rect that is used by client child elements as content area. More...

virtual const CachedRectf &	getNonClientChildContentArea () const
	Return a Rect that is used by client child elements as content area. More...

const CachedRectf &	getChildContentArea (const bool non_client=false) const
	Return a Rect that is used to position and size child elements. 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...

Property *	getPropertyInstance (const String &name) const
	Retrieves a property instance (that was previously added) 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...

template<typename T >
PropertyHelper< T >::return_type	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...

template<typename T >
void	setProperty (const String &name, typename PropertyHelper< T >::pass_type 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...

PropertyIterator	getPropertyIterator (void) const
	Return a PropertySet::PropertyIterator 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)
	Creates a new Event object with the given name and adds it to the EventSet. More...

void	addEvent (Event &event)
	Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...

void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...

void	removeEvent (Event &event)
	Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...

void	removeAllEvents (void)
	Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.

bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in this 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...

template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...

template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2)
	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	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...

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

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

Static Public Attributes
static const String	WidgetTypeName
	Window factory name.

static const String	EventNamespace
	Namespace for global events.

static const String	EventScrollPositionChanged

static const String	EventThumbTrackStarted

static const String	EventThumbTrackEnded

static const String	EventScrollConfigChanged

static const String	ThumbName
	Widget name for the thumb component.

static const String	IncreaseButtonName
	Widget name for the increase button component.

static const String	DecreaseButtonName
	Widget name for the decrease button component.

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

static const String	EventUpdated

static const String	EventTextChanged

static const String	EventFontChanged

static const String	EventAlphaChanged

static const String	EventIDChanged

static const String	EventActivated

static const String	EventDeactivated

static const String	EventShown

static const String	EventHidden

static const String	EventEnabled

static const String	EventDisabled

static const String	EventClippedByParentChanged

static const String	EventDestroyedByParentChanged

static const String	EventInheritsAlphaChanged

static const String	EventAlwaysOnTopChanged

static const String	EventInputCaptureGained

static const String	EventInputCaptureLost

static const String	EventInvalidated

static const String	EventRenderingStarted

static const String	EventRenderingEnded

static const String	EventDestructionStarted

static const String	EventDragDropItemEnters

static const String	EventDragDropItemLeaves

static const String	EventDragDropItemDropped

static const String	EventWindowRendererAttached

static const String	EventWindowRendererDetached

static const String	EventTextParsingChanged

static const String	EventMarginChanged

static const String	EventMouseEntersArea

static const String	EventMouseLeavesArea

static const String	EventMouseEntersSurface

static const String	EventMouseLeavesSurface

static const String	EventMouseMove

static const String	EventMouseWheel

static const String	EventMouseButtonDown

static const String	EventMouseButtonUp

static const String	EventMouseClick

static const String	EventMouseDoubleClick

static const String	EventMouseTripleClick

static const String	EventKeyDown

static const String	EventKeyUp

static const String	EventCharacterKey

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

static const String	WindowXMLElementName

static const String	AutoWindowXMLElementName

static const String	UserStringXMLElementName

static const String	WindowTypeXMLAttributeName

static const String	WindowNameXMLAttributeName

static const String	AutoWindowNamePathXMLAttributeName

static const String	UserStringNameXMLAttributeName

static const String	UserStringValueXMLAttributeName

Static Public Attributes inherited from CEGUI::NamedElement
static const String	EventNamespace
	Namespace for global events.

static const String	EventNameChanged

Static Public Attributes inherited from CEGUI::Element
static const String	EventNamespace
	Namespace for global events.

static const String	EventSized

static const String	EventParentSized

static const String	EventMoved

static const String	EventHorizontalAlignmentChanged

static const String	EventVerticalAlignmentChanged

static const String	EventRotated

static const String	EventChildAdded

static const String	EventChildRemoved

static const String	EventZOrderChanged

static const String	EventNonClientChanged

Protected Member Functions
void	updateThumb (void)
	update the size and location of the thumb to properly represent the current state of the scroll bar

float	getValueFromThumb (void) const
	return value that best represents current scroll bar position given the current location of the thumb. More...

float	getAdjustDirectionFromPoint (const Vector2f &pt) const
	Given window location pt, return a value indicating what change should be made to the scroll bar. More...

bool	setScrollPosition_impl (const float position)

bool	isAtEnd () const
	return whether the current scroll position is at the end of the range.

float	getMaxScrollPosition () const
	return the max allowable scroll position value

bool	handleThumbMoved (const EventArgs &e)
	handler function for when thumb moves.

bool	handleIncreaseClicked (const EventArgs &e)
	handler function for when the increase button is clicked.

bool	handleDecreaseClicked (const EventArgs &e)
	handler function for when the decrease button is clicked.

bool	handleThumbTrackStarted (const EventArgs &e)
	handler function for when thumb tracking begins

bool	handleThumbTrackEnded (const EventArgs &e)
	handler function for when thumb tracking begins

virtual bool	validateWindowRenderer (const WindowRenderer *renderer) const
	validate window renderer

virtual void	onScrollPositionChanged (WindowEventArgs &e)
	Handler triggered when the scroll position changes.

virtual void	onThumbTrackStarted (WindowEventArgs &e)
	Handler triggered when the user begins to drag the scroll bar thumb.

virtual void	onThumbTrackEnded (WindowEventArgs &e)
	Handler triggered when the scroll bar thumb is released.

virtual void	onScrollConfigChanged (WindowEventArgs &e)
	Handler triggered when the scroll bar data configuration changes.

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

void	banPropertiesForAutoWindow ()

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

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

virtual void	onRotated (ElementEventArgs &e)
	Handler called when the element's rotation is changed. 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	onInvalidated (WindowEventArgs &e)
	Handler called when this window gets invalidated. 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 (ElementEventArgs &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 (ElementEventArgs &e)
	Handler called when a child window is added to this window. More...

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

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

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

virtual void	onMouseEnters (MouseEventArgs &e)
	Handler called when the mouse cursor has entered this window's area and is actually over some part of this windows surface and not, for instance over a child window - even though technically in those cases the mouse is also within this Window's area, the handler will not be called. More...

virtual void	onMouseLeaves (MouseEventArgs &e)
	Handler called when the mouse cursor is no longer over this window's surface area. This will be called when the mouse is not over a part of this Window's actual surface - even though technically the mouse is still within the Window's area, for example if the mouse moves over a child window. More...

virtual void	onMouseMove (MouseEventArgs &e)
	Handler called when the mouse cursor has been moved 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	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	onTextParsingChanged (WindowEventArgs &e)
	Handler called when the window's setting for whether text parsing is enabled is changed. More...

virtual void	onMarginChanged (WindowEventArgs &e)

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

virtual void	drawSelf (const RenderingContext &ctx)
	Perform the actual rendering for this Window. More...

void	bufferGeometry (const RenderingContext &ctx)
	Perform drawing operations concerned with generating and buffering window geometry. More...

void	queueGeometry (const RenderingContext &ctx)
	Perform drawing operations concerned with positioning, clipping and queueing of window geometry to RenderingSurfaces. More...

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

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

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

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.

void	allocateRenderingWindow ()
	helper to create and setup the auto RenderingWindow surface

void	releaseRenderingWindow ()
	helper to clean up the auto RenderingWindow surface

void	initialiseClippers (const RenderingContext &ctx)
	Helper to intialise the needed clipping for geometry and render surface.

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

virtual void	cleanupChildren (void)
	Cleanup child windows.

virtual void	addChild_impl (Element *element)
	Add given element to child list at an appropriate position. More...

virtual void	removeChild_impl (Element *element)
	Remove given element from child list. More...

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

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

virtual bool	moveToFront_impl (bool wasClicked)
	Implements move to front behavior. 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...

void	updateGeometryRenderSettings ()
	Update position and clip region on this Windows geometry / rendering surface.

void	transferChildSurfaces ()
	transfer RenderingSurfaces to be owned by our target RenderingSurface.

Rectf	getParentElementClipIntersection (const Rectf &unclipped_area) const
	helper function for calculating clipping rectangles.

void	invalidate_impl (const bool recursive)
	helper function to invalidate window and optionally child windows.

const Window *	getWindowAttachedToCommonAncestor (const Window &wnd) const
	Helper function to return the ancestor Window of /a wnd that is attached as a child to a window that is also an ancestor of /a this. Returns 0 if /a wnd and /a this are not part of the same hierachy.

virtual Rectf	getUnclippedInnerRect_impl (bool skipAllPixelAlignment) const
	Default implementation of function to return Element's inner rect area.

virtual Rectf	getOuterRectClipper_impl () const
	Default implementation of function to return Window outer clipper area.

virtual Rectf	getInnerRectClipper_impl () const
	Default implementation of function to return Window inner clipper area.

virtual Rectf	getHitTestRect_impl () const
	Default implementation of function to return Window hit-test area.

virtual int	writePropertiesXML (XMLSerializer &xml_stream) const

virtual int	writeChildWindowsXML (XMLSerializer &xml_stream) const

virtual bool	writeAutoChildWindowXML (XMLSerializer &xml_stream) const

virtual bool	handleFontRenderSizeChange (const EventArgs &args)
	handler function for when font render size changes.

void	markCachedWindowRectsInvalid ()

void	layoutLookNFeelChildWidgets ()

Window *	getChildAtPosition (const Vector2f &position, bool(Window::*hittestfunc)(const Vector2f &, bool) const, bool allow_disabled=false) const

bool	isHitTargetWindow (const Vector2f &position, bool allow_disabled) const

Protected Member Functions inherited from CEGUI::NamedElement
virtual NamedElement *	getChildByNamePath_impl (const String &name_path) const
	Retrieves a child at name_path or 0 if none such exists.

virtual NamedElement *	getChildByNameRecursive_impl (const String &name) const
	Finds a child by name or 0 if none such exists.

void	addNamedElementProperties ()
	Add standard CEGUI::NamedElement properties.

virtual void	onNameChanged (NamedElementEventArgs &e)
	Handler called when the element's name changes. More...

Protected Member Functions inherited from CEGUI::Element
void	addElementProperties ()
	Add standard CEGUI::Element properties.

bool	isInnerRectSizeChanged () const
	helper to return whether the inner rect size has changed

virtual Rectf	getUnclippedOuterRect_impl (bool skipAllPixelAlignment) const
	Default implementation of function to return Element's outer rect area.

void	fireAreaChangeEvents (const bool moved, const bool sized)
	helper to fire events based on changes to area rect

void	notifyChildrenOfSizeChange (const bool non_client, const bool client)

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

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

virtual void	onNonClientChanged (ElementEventArgs &e)
	Handler called when the element's non-client setting, affecting it's position and size relative to it's parent is changed. More...

Protected Member Functions inherited from CEGUI::EventSet
void	fireEvent_impl (const String &name, EventArgs &args)
	Implementation event firing member.

ScriptModule *	getScriptModule () const
	Helper to return the script module pointer or throw.

	EventSet (EventSet &)

EventSet &	operator= (EventSet &)

Protected Attributes
float	d_documentSize
	The size of the document / data being scrolled thorugh.

float	d_pageSize
	The size of a single 'page' of data.

float	d_stepSize
	Step size used for increase / decrease button clicks.

float	d_overlapSize
	Amount of overlap when jumping by a page.

float	d_position
	Current scroll position.

bool	d_endLockPosition
	whether 'end lock' mode is enabled.

Protected Attributes inherited from CEGUI::Window
const String	d_type
	type of Window (also the name of the WindowFactory that created us)

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

bool	d_autoWindow
	true when this window is an auto-window

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_enabled
	true when Window is enabled

bool	d_visible
	is window visible (i.e. it will be rendered, but may still be obscured)

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

ChildDrawList	d_drawList
	Child window objects arranged in rendering order.

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

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

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.

GeometryBuffer *	d_geometry
	Object which acts as a cache of geometry drawn by this Window.

RenderingSurface *	d_surface
	RenderingSurface owned by this window (may be 0)

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

bool	d_autoRenderingWindow
	holds setting for automatic creation of of surface (RenderingWindow)

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

float	d_alpha
	Alpha transparency setting for the Window.

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

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

bool	d_restoreOldCapture
	Restore capture to the previous capture window when releasing capture.

bool	d_distCapturedInputs
	Whether to distribute captured inputs to child windows.

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

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

BidiVisualMapping *	d_bidiVisualMapping
	pointer to bidirection support object

bool	d_bidiDataValid
	whether bidi visual mapping has been updated since last text change.

RenderedString	d_renderedString
	RenderedString representation of text string as ouput from a parser.

bool	d_renderedStringValid
	true if d_renderedString is valid, false if needs re-parse.

RenderedStringParser *	d_customStringParser
	Pointer to a custom (user assigned) RenderedStringParser object.

bool	d_textParsingEnabled
	true if use of parser other than d_defaultStringParser is enabled

UBox	d_margin
	Margin, only used when the Window is inside LayoutContainer class.

uint	d_ID
	User ID assigned to this Window.

void *	d_userData
	Holds pointer to some user assigned data.

UserStringMap	d_userStrings
	Holds a collection of named user string values.

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

bool	d_riseOnClick
	whether window should rise in the z order when left clicked.

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_mousePassThroughEnabled
	whether (most) mouse events pass through this window

bool	d_autoRepeat
	whether pressed mouse button will auto-repeat the down event.

float	d_repeatDelay
	seconds before first repeat event is fired

float	d_repeatRate
	seconds between further repeats after delay has expired.

MouseButton	d_repeatButton
	button we're tracking for auto-repeat purposes.

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

float	d_repeatElapsed
	implements repeating - tracks time elapsed.

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
	whether tooltip text may be inherited from parent.

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

BannedXMLPropertySet	d_bannedXMLProperties
	collection of properties not to be written to XML for this window.

Rectf	d_outerRectClipper
	outer area clipping rect in screen pixels

Rectf	d_innerRectClipper
	inner area clipping rect in screen pixels

Rectf	d_hitTestRect
	area rect used for hit-testing against this window

bool	d_outerRectClipperValid

bool	d_innerRectClipperValid

bool	d_hitTestRectValid

WindowUpdateMode	d_updateMode
	The mode to use for calling Window::update.

bool	d_propagateMouseInputs
	specifies whether mouse inputs should be propagated to parent(s)

GUIContext *	d_guiContext
	GUIContext. Set when this window is used as a root window.

bool	d_containsMouse
	true when mouse is contained within this Window's area.

Protected Attributes inherited from CEGUI::NamedElement
String	d_name
	The name of the element, unique in the parent of this element.

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

Element *	d_parent
	Holds pointer to the parent element.

bool	d_nonClient
	true if element is in non-client (outside InnerRect) area of parent.

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

HorizontalAlignment	d_horizontalAlignment
	Specifies the base for horizontal alignment.

VerticalAlignment	d_verticalAlignment
	Specifies the base for vertical alignment.

USize	d_minSize
	current minimum size for the element.

USize	d_maxSize
	current maximum size for the element.

AspectMode	d_aspectMode
	How to satisfy current aspect ratio.

float	d_aspectRatio
	The target aspect ratio.

bool	d_pixelAligned
	If true, the position and size are pixel aligned.

Sizef	d_pixelSize
	Current constrained pixel size of the element.

Quaternion	d_rotation
	Rotation of this element (relative to the parent)

CachedRectf	d_unclippedOuterRect
	outer area rect in screen pixels

CachedRectf	d_unclippedInnerRect
	inner area rect in screen pixels

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 ConstMapIterator < PropertyRegistry >	PropertyIterator

Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator < EventMap >	EventIterator

Protected Types inherited from CEGUI::Window
typedef std::vector< Window CEGUI_VECTOR_ALLOC(Window )>	ChildDrawList
	definition of type used for the list of child windows to be drawn

typedef std::map< String, String, StringFastLessCompare CEGUI_MAP_ALLOC(String, String)>	UserStringMap
	definition of type used for the UserString dictionary.

typedef std::set< String, StringFastLessCompare CEGUI_SET_ALLOC(String)>	BannedXMLPropertySet
	definition of type used to track properties banned from writing XML.

Static Protected Attributes inherited from CEGUI::Window
CEGUI::Window::WindowRendererProperty	d_windowRendererProperty

CEGUI::Window::LookNFeelProperty	d_lookNFeelProperty

static BasicRenderedStringParser	d_basicStringParser
	Shared instance of a parser to be used in most instances.

static DefaultRenderedStringParser	d_defaultStringParser
	Shared instance of a parser to be used when rendering text verbatim.

Detailed Description

Base scroll bar class.

This base class for scroll bars does not have any idea of direction - a derived class would add whatever meaning is appropriate according to what that derived class represents to the user.

Member Function Documentation

float CEGUI::Scrollbar::getAdjustDirectionFromPoint ( const Vector2f & pt ) const

protected

Given window location pt, return a value indicating what change should be made to the scroll bar.

Parameters

pt	Point object describing a pixel position in window space.

Returns

-1 to indicate scroll bar position should be moved to a lower value.
0 to indicate scroll bar position should not be changed.
+1 to indicate scroll bar position should be moved to a higher value.

PushButton* CEGUI::Scrollbar::getDecreaseButton ( ) const

Return a pointer to the 'decrease' PushButton component widget for this Scrollbar.

Returns: Pointer to a PushButton object.

Exceptions

UnknownObjectException Thrown if the 'decrease' PushButton component does not exist.

float CEGUI::Scrollbar::getDocumentSize ( void ) const

inline

Return the size of the document or data.

The document size should be thought of as the total size of the data
that is being scrolled through (the number of lines in a text file for
example).

Note: The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns: float value specifying the currently set document size.

PushButton* CEGUI::Scrollbar::getIncreaseButton ( ) const

Return a pointer to the 'increase' PushButtoncomponent widget for this Scrollbar.

Returns: Pointer to a PushButton object.

Exceptions

UnknownObjectException Thrown if the increase PushButton component does not exist.

float CEGUI::Scrollbar::getOverlapSize ( void ) const

inline

Return the overlap size for this scroll bar.

The overlap size is the amount of data from the end of a 'page' that
will remain visible when the position is moved by a page.  This is
usually used so that the user keeps some context of where they were
within the document's data when jumping a page at a time.

Note: The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns: float value specifying the currently set overlap size.

float CEGUI::Scrollbar::getPageSize ( void ) const

inline

Return the page size for this scroll bar.

The page size is typically the amount of data that can be displayed at
one time.  This value is also used when calculating the amount the
position will change when you click either side of the scroll bar
thumb, the amount the position changes will is (pageSize - overlapSize).

Note: The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns: float value specifying the currently set page size.

float CEGUI::Scrollbar::getScrollPosition ( void ) const

inline

Return the current position of scroll bar within the document.

The range of the scroll bar is from 0 to the size of the document minus
the size of a page (0 <= position <= (documentSize - pageSize)).

Note: The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns: float value specifying the current position of the scroll bar within its document.

float CEGUI::Scrollbar::getStepSize ( void ) const

inline

Return the step size for this scroll bar.

The step size is typically a single unit of data that can be displayed,
this is the amount the position will change when you click either of
the arrow buttons on the scroll bar.  (this could be 1 for a single
line of text, for example).

Note: The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Returns: float value specifying the currently set step size.

Thumb* CEGUI::Scrollbar::getThumb ( ) const

Return a pointer to the Thumb component widget for this Scrollbar.

Returns: Pointer to a Thumb object.

Exceptions

UnknownObjectException Thrown if the Thumb component does not exist.

float CEGUI::Scrollbar::getValueFromThumb ( void ) const

protected

return value that best represents current scroll bar position given the current location of the thumb.

Returns: float value that, given the thumb widget position, best represents the current position for the scroll bar.

void CEGUI::Scrollbar::initialiseComponents ( void )

virtual

Initialises the Window based object ready for use.

Note: This must be called for every window created. Normally this is handled automatically by the WindowManager.

Returns: Nothing

Reimplemented from CEGUI::Window.

bool CEGUI::Scrollbar::isEndLockEnabled ( ) const

Returns whether the 'end lock'mode for the scrollbar is enabled.

When enabled, and the current position of the scrollbar is at the end of
it's travel, the end lock mode of the scrollbar will automatically
update the scrollbar position when the document and/or page size change
in order that the scroll position will remain at the end of it's travel.
This can be used to implement auto-scrolling in certain other widget
types.

Returns

true to indicate that the end lock mode is enabled.
false to indicate that the end lock mode is disabled.

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

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

void CEGUI::Scrollbar::setConfig	(	const float *const	document_size,
		const float *const	page_size,
		const float *const	step_size,
		const float *const	overlap_size,
		const float *const	position
	)

Sets multiple scrollbar configuration parameters simultaneously.

This function is provided in order to be able to minimise the number
of internal state updates that occur when modifying the scrollbar
parameters.

Parameters

document_size	Pointer to a float value holding the new value to be used for the scroll bar document size. If this is 0 the document size is left unchanged.
page_size	Pointer to a float value holding the new value to be used for the scroll bar page size. If this is 0 the page size is left unchanged.
step_size	Pointer to a float value holding the new value to be used for the scroll bar step size. If this is 0 the step size is left unchanged.
overlap_size	Pointer to a float value holding the new value to be used for the scroll bar overlap size. If this is 0 then overlap size is left unchanged.
position	Pointer to a float value holding the new value to be used for the scroll bar current scroll position. If this is 0 then the current position is left unchanged.

Note: Even if position is 0, the scrollbar position may still change depending on how the other changes affect the scrollbar.

void CEGUI::Scrollbar::setDocumentSize ( float document_size )

Set the size of the document or data.

The document size should be thought of as the total size of the data
that is being scrolled through (the number of lines in a text file for
example).

Note: The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters

document_size float value specifying the document size.

void CEGUI::Scrollbar::setEndLockEnabled ( const bool enabled )

Enable or disable the 'end lock' mode for the scrollbar.

When enabled and the current position of the scrollbar is at the end of
it's travel, the end lock mode of the scrollbar will automatically
update the position when the document and/or page size change in order
that the scroll position will remain at the end of it's travel.  This
can be used to implement auto-scrolling in certain other widget types.

Parameters

enabled

true to indicate that end lock mode should be enabled.
false to indicate that end lock mode should be disabled.

void CEGUI::Scrollbar::setOverlapSize ( float overlap_size )

Set the overlap size for this scroll bar.

The overlap size is the amount of data from the end of a 'page' that
will remain visible when the position is moved by a page.  This is
usually used so that the user keeps some context of where they were
within the document's data when jumping a page at a time.

Note: The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters

overlap_size float value specifying the overlap size.

void CEGUI::Scrollbar::setPageSize ( float page_size )

Set the page size for this scroll bar.

The page size is typically the amount of data that can be displayed at
one time.  This value is also used when calculating the amount the
position will change when you click either side of the scroll bar
thumb, the amount the position changes will is (pageSize - overlapSize).

Note: The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters

page_size float value specifying the page size.

void CEGUI::Scrollbar::setScrollPosition ( float position )

Set the current position of scroll bar within the document.

The range of the scroll bar is from 0 to the size of the document minus
the size of a page (0 <= position <= (documentSize - pageSize)), any
attempt to set the position outside this range will be adjusted so that
it falls within the legal range.

Note: The returned value has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters

position float value specifying the position of the scroll bar within its document.

bool CEGUI::Scrollbar::setScrollPosition_impl ( const float position )

protected

implementation func that updates scroll position value, returns true if value was changed. NB: Fires no events and does no other updates.

void CEGUI::Scrollbar::setStepSize ( float step_size )

Set the step size for this scroll bar.

The step size is typically a single unit of data that can be displayed,
this is the amount the position will change when you click either of the
arrow buttons on the scroll bar.  (this could be 1 for a single line of
text, for example).

Note: The value set has no meaning within the Gui system, it is left up to the application to assign appropriate values for the application specific use of the scroll bar.

Parameters

step_size float value specifying the step size.

Member Data Documentation

const String CEGUI::Scrollbar::EventScrollConfigChanged

static

Event fired when the scroll bar configuration data is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Scrollbar whose configuration has been changed.

const String CEGUI::Scrollbar::EventScrollPositionChanged

static

Event fired when the scroll bar position value changes. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Scrollbar whose position value had changed.

const String CEGUI::Scrollbar::EventThumbTrackEnded

static

Event fired when the user releases the scrollbar thumb. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Scrollbar whose thumb has been released.

const String CEGUI::Scrollbar::EventThumbTrackStarted

static

Event fired when the user begins dragging the scrollbar thumb. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Scrollbar whose thumb is being dragged.

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation