CEGUI::FrameWindow Class Reference

Abstract base class for a movable, sizable, window with a title-bar and a frame. More...

Inheritance diagram for CEGUI::FrameWindow:

Collaboration diagram for CEGUI::FrameWindow:

Public Types
enum	SizingLocation {   SizingNone, SizingTopLeft, SizingTopRight, SizingBottomLeft,   SizingBottomRight, SizingTop, SizingLeft, SizingBottom,   SizingRight }
	Enumeration that defines the set of possible locations for the mouse on a frame windows sizing border. More...

Public Member Functions
virtual void	initialiseComponents (void)
	Initialises the Window based object ready for use. More...
bool	isSizingEnabled (void) const
	Return whether this window is sizable. Note that this requires that the window have an enabled frame and that sizing itself is enabled. More...
bool	isFrameEnabled (void) const
	Return whether the frame for this window is enabled. More...
bool	isTitleBarEnabled (void) const
	Return whether the title bar for this window is enabled. More...
bool	isCloseButtonEnabled (void) const
	Return whether this close button for this window is enabled. More...
bool	isRollupEnabled (void) const
	Return whether roll up (a.k.a shading) is enabled for this window. More...
bool	isRolledup (void) const
	Return whether the window is currently rolled up (a.k.a shaded). More...
float	getSizingBorderThickness (void) const
	Return the thickness of the sizing border. More...
void	setSizingEnabled (bool setting)
	Enables or disables sizing for this window. More...
void	setFrameEnabled (bool setting)
	Enables or disables the frame for this window. More...
void	setTitleBarEnabled (bool setting)
	Enables or disables the title bar for the frame window. More...
void	setCloseButtonEnabled (bool setting)
	Enables or disables the close button for the frame window. More...
void	setRollupEnabled (bool setting)
	Enables or disables roll-up (shading) for this window. More...
void	toggleRollup (void)
	Toggles the state of the window between rolled-up (shaded) and normal sizes. This requires roll-up to be enabled. More...
void	setSizingBorderThickness (float pixels)
	Set the size of the sizing border for this window. More...
void	offsetPixelPosition (const Vector2 &offset)
	Move the window by the pixel offsets specified in offset. More...
bool	isDragMovingEnabled (void) const
	Return whether this FrameWindow can be moved by dragging the title bar. More...
void	setDragMovingEnabled (bool setting)
	Set whether this FrameWindow can be moved by dragging the title bar. More...
const Image *	getNSSizingCursorImage () const
	Return a pointer to the currently set Image to be used for the north-south sizing mouse cursor. More...
const Image *	getEWSizingCursorImage () const
	Return a pointer to the currently set Image to be used for the east-west sizing mouse cursor. More...
const Image *	getNWSESizingCursorImage () const
	Return a pointer to the currently set Image to be used for the northwest-southeast sizing mouse cursor. More...
const Image *	getNESWSizingCursorImage () const
	Return a pointer to the currently set Image to be used for the northeast-southwest sizing mouse cursor. More...
void	setNSSizingCursorImage (const Image *image)
	Set the Image to be used for the north-south sizing mouse cursor. More...
void	setEWSizingCursorImage (const Image *image)
	Set the Image to be used for the east-west sizing mouse cursor. More...
void	setNWSESizingCursorImage (const Image *image)
	Set the Image to be used for the northwest-southeast sizing mouse cursor. More...
void	setNESWSizingCursorImage (const Image *image)
	Set the Image to be used for the northeast-southwest sizing mouse cursor. More...
void	setNSSizingCursorImage (const String &imageset, const String &image)
	Set the image to be used for the north-south sizing mouse cursor. More...
void	setEWSizingCursorImage (const String &imageset, const String &image)
	Set the image to be used for the east-west sizing mouse cursor. More...
void	setNWSESizingCursorImage (const String &imageset, const String &image)
	Set the image to be used for the northwest-southeast sizing mouse cursor. More...
void	setNESWSizingCursorImage (const String &imageset, const String &image)
	Set the image to be used for the northeast-southwest sizing mouse cursor. More...
bool	isHit (const Point &position, const bool) const
	check if the given pixel position would hit this window. More...
Titlebar *	getTitlebar () const
	Return a pointer to the Titlebar component widget for this FrameWindow. More...
PushButton *	getCloseButton () const
	Return a pointer to the close button component widget for this FrameWindow. More...
	FrameWindow (const String &type, const String &name)
	Constructor for FrameWindow objects.
virtual	~FrameWindow (void)
	Destructor for FramwWindow objects.
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...
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 *	getChild (uint ID) const
	return a pointer to the first attached child window with the specified ID value. 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 *	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...
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...
Rect	getUnclippedOuterRect () const
	Return a Rect that describes the unclipped outer rect area of the Window in screen pixels.
Rect	getUnclippedInnerRect () const
	Return a Rect that describes the unclipped inner rect area of the Window in screen pixels.
Rect	getUnclippedRect (const bool inner) const
	Return a Rect that describes the unclipped area covered by the Window. More...
Rect	getOuterRectClipper () const
	Return a Rect that describes the rendering clipping rect based upon the outer rect area of the window. More...
Rect	getInnerRectClipper () const
	Return a Rect that describes the rendering clipping rect based upon the inner rect area of the window. More...
Rect	getClipRect (const bool non_client=false) const
	Return a Rect that describes the rendering clipping rect for the Window. More...
Rect	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...
Rect	getChildWindowContentArea (const bool non_client=false) const
	Return a Rect that describes the area that is used to position and - for scale values - size child content attached to this Window. 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...
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 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 (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...
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...
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	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 ()
const Vector3 &	getRotation () const
	return the rotations set for this window.
bool	isNonClientWindow () const
	Return whether the Window is a non-client window. More...
void	rename (const String &new_name)
	Renames the window. 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	setText (const String &text)
	Set the current text string for the Window. More...
void	insertText (const String &text, const String::size_type position)
	Insert the text string text into the current text string for the Window object at the position specified by position. More...
void	appendText (const String &text)
	Append the string text to the currect text string for the Window object. More...
void	setFont (Font *font)
	Set the font used by this Window. More...
void	setFont (const String &name)
	Set the font used by this Window. More...
void	addChildWindow (const String &name)
	Add the named Window as a child of this Window. If the Window name is already attached to a Window, it is detached before being added to this Window. More...
void	addChildWindow (Window *window)
	Add the specified Window as a child of this Window. If the Window window is already attached to a Window, it is detached before being added to this Window. More...
void	removeChildWindow (const String &name)
	Remove the named Window from this windows child list. More...
void	removeChildWindow (Window *window)
	Remove the specified Window form this windows child list. More...
void	removeChildWindow (uint ID)
	Remove the first child Window with the specified ID. If there is more than one attached Window objects with the specified ID, only the fist one encountered will be removed. More...
void	moveToFront ()
	Move the Window to the top of the z order. More...
void	moveToBack ()
	Move the Window to the bottom of the Z order. More...
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...
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	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 (MouseCursorImage image)
	Set the mouse cursor image to be used when the mouse enters this window. More...
void	setMouseCursor (const String &imageset, const String &image_name)
	Set the mouse cursor image to be used when the mouse enters this window. More...
void	setUserData (void *user_data)
	Set the user data set for this Window. More...
void	setZOrderingEnabled (bool setting)
	Set whether z-order changes are enabled or disabled for this Window. More...
void	setWantsMultiClickEvents (bool setting)
	Set whether this window will receive multi-click events or multiple 'down' events instead. More...
void	setMouseAutoRepeatEnabled (bool setting)
	Set whether mouse button down event autorepeat is enabled for this window. More...
void	setAutoRepeatDelay (float delay)
	Set the current auto-repeat delay setting for this window. More...
void	setAutoRepeatRate (float rate)
	Set the current auto-repeat rate setting for this window. More...
void	setDistributesCapturedInputs (bool setting)
	Set whether the window wants inputs passed to its attached child windows when the window has inputs captured. More...
void	notifyDragDropItemEnters (DragContainer *item)
	Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
void	notifyDragDropItemLeaves (DragContainer *item)
	Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
void	notifyDragDropItemDropped (DragContainer *item)
	Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
virtual void	destroy (void)
	Internal destroy method which actually just adds the window and any parent destructed child windows to the dead pool. More...
void	setTooltip (Tooltip *tooltip)
	Set the custom Tooltip object for this Window. This value may be 0 to indicate that the Window should use the system default Tooltip object. More...
void	setTooltipType (const String &tooltipType)
	Set the custom Tooltip to be used by this Window by specifying a Window type. More...
void	setTooltipText (const String &tip)
	Set the tooltip text for this window. More...
void	setInheritsTooltipText (bool setting)
	Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set. More...
void	setRiseOnClickEnabled (bool setting)
	Set whether this window will rise to the top of the z-order when clicked with the left mouse button. More...
void	setVerticalAlignment (const VerticalAlignment alignment)
	Set the vertical alignment. More...
void	setHorizontalAlignment (const HorizontalAlignment alignment)
	Set the horizontal alignment. More...
virtual void	setLookNFeel (const String &look)
	Set the LookNFeel that shoule be used for this window. More...
void	setModalState (bool state)
	Set the modal state for this Window. More...
virtual void	performChildWindowLayout ()
	method called to perform extended laying out of attached child windows. More...
void	setUserString (const String &name, const String &value)
	Sets the value a named user string, creating it as required. More...
void	setArea (const UDim &xpos, const UDim &ypos, const UDim &width, const UDim &height)
	Set the window area. More...
void	setArea (const UVector2 &pos, const UVector2 &size)
	Set the window area. More...
void	setArea (const URect &area)
	Set the window area. More...
void	setPosition (const UVector2 &pos)
	Set the window's position. More...
void	setXPosition (const UDim &x)
	Set the window's X position. More...
void	setYPosition (const UDim &y)
	Set the window's Y position. More...
void	setSize (const UVector2 &size)
	Set the window's size. More...
void	setWidth (const UDim &width)
	Set the window's width. More...
void	setHeight (const UDim &height)
	Set the window's height. More...
void	setMaxSize (const UVector2 &size)
	Set the window's maximum size. More...
void	setMinSize (const UVector2 &size)
	Set the window's minimum size. More...
const URect &	getArea () const
	Return the windows area. More...
const UVector2 &	getPosition () const
	Get the window's position. More...
const UDim &	getXPosition () const
	Get the window's X position. More...
const UDim &	getYPosition () const
	Get the window's Y position. More...
UVector2	getSize () const
	Get the window's size. More...
UDim	getWidth () const
	Get the window's width. More...
UDim	getHeight () const
	Get the window's height. More...
const UVector2 &	getMaxSize () const
	Get the window's maximum size. More...
const UVector2 &	getMinSize () const
	Get the window's minimum size. More...
void	render ()
	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 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 (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...
void	setRotation (const Vector3 &rotation)
	set the rotations for this window.
void	setNonClientWindow (const bool setting)
	Set whether the Window is a non-client window. 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
Vector2	getUnprojectedPosition (const Vector2 &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.
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.
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 the given property is banned from XML.
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 String &newName, 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
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...
Public Member Functions inherited from CEGUI::PropertySet
	PropertySet (void)
	Constructs a new PropertySet object.
virtual	~PropertySet (void)
	Destructor for PropertySet objects.
void	addProperty (Property *property)
	Adds a new Property to the PropertySet. More...
void	removeProperty (const String &name)
	Removes a Property from the PropertySet. More...
void	clearProperties (void)
	Removes all Property objects from the PropertySet. More...
bool	isPropertyPresent (const String &name) const
	Checks to see if a Property with the given name is in the PropertySet. More...
const String &	getPropertyHelp (const String &name) const
	Return the help text for the specified Property. More...
String	getProperty (const String &name) const
	Gets the current value of the specified Property. More...
void	setProperty (const String &name, const String &value)
	Sets the current value of a Property. More...
bool	isPropertyDefault (const String &name) const
	Returns whether a Property is at it's default value. More...
String	getPropertyDefault (const String &name) const
	Returns the default value of a Property as a String. More...
Iterator	getIterator (void) const
	Return a PropertySet::Iterator object to iterate over the available Properties.
Public Member Functions inherited from CEGUI::EventSet
	EventSet ()
	Constructor for EventSet objects.
virtual	~EventSet (void)
	Destructor for EventSet objects.
void	addEvent (const String &name)
	Add a new Event to the EventSet with the given name. More...
void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected. More...
void	removeAllEvents (void)
	Remove all Event objects from the EventSet. More...
bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in the EventSet. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Subscriber subscriber)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
	Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, const String &subscriber_name)
	Subscribes the named Event to a scripted funtion. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
	Subscribes the specified group of the named Event to a scripted funtion. More...
virtual void	fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
	Fires the named event passing the given EventArgs object. More...
bool	isMuted (void) const
	Return whether the EventSet is muted or not. More...
void	setMutedState (bool setting)
	Set the mute state for this EventSet. More...
Iterator	getIterator (void) const
	Return a EventSet::Iterator object to iterate over the events currently added to the EventSet.

Static Public Attributes
static const String	EventNamespace
	Namespace for global events.
static const String	WidgetTypeName
	Window factory name.
static const String	EventRollupToggled
static const String	EventCloseClicked
static const String	EventDragSizingStarted
static const String	EventDragSizingEnded
static const float	DefaultSizingBorderSize
	Default size for the sizing border (in pixels)
static const String	TitlebarNameSuffix
	Widget name suffix for the titlebar component.
static const String	CloseButtonNameSuffix
	Widget name suffix for the close button component.
Static Public Attributes inherited from CEGUI::Window
static const String	EventNamespace
	Namespace for global events.
static const String	EventWindowUpdated
static const String	EventParentSized
static const String	EventSized
static const String	EventMoved
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	EventRenderingStarted
static const String	EventRenderingEnded
static const String	EventChildAdded
static const String	EventChildRemoved
static const String	EventDestructionStarted
static const String	EventZOrderChanged
static const String	EventDragDropItemEnters
static const String	EventDragDropItemLeaves
static const String	EventDragDropItemDropped
static const String	EventVerticalAlignmentChanged
static const String	EventHorizontalAlignmentChanged
static const String	EventWindowRendererAttached
static const String	EventWindowRendererDetached
static const String	EventRotated
static const String	EventNonClientChanged
static const String	EventTextParsingChanged
static const String	EventMarginChanged
static const String	EventMouseEntersArea
static const String	EventMouseLeavesArea
static const String	EventMouseEnters
static const String	EventMouseLeaves
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	AutoWidgetNameSuffix
	Something that all generated widgets will have in their names.

Protected Member Functions
bool	moveLeftEdge (float delta, URect &out_area)
	move the window's left edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window. More...
bool	moveRightEdge (float delta, URect &out_area)
	move the window's right edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window. More...
bool	moveTopEdge (float delta, URect &out_area)
	move the window's top edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window. More...
bool	moveBottomEdge (float delta, URect &out_area)
	move the window's bottom edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window. More...
SizingLocation	getSizingBorderAtPoint (const Point &pt) const
	check local pixel co-ordinate point 'pt' and return one of the SizingLocation enumerated values depending where the point falls on the sizing border. More...
bool	isLeftSizingLocation (SizingLocation loc) const
	return true if given SizingLocation is on left edge. More...
bool	isRightSizingLocation (SizingLocation loc) const
	return true if given SizingLocation is on right edge. More...
bool	isTopSizingLocation (SizingLocation loc) const
	return true if given SizingLocation is on top edge. More...
bool	isBottomSizingLocation (SizingLocation loc) const
	return true if given SizingLocation is on bottom edge. More...
bool	closeClickHandler (const EventArgs &e)
	Method to respond to close button click events and fire our close event.
void	setCursorForPoint (const Point &pt) const
	Set the appropriate mouse cursor for the given window-relative pixel point.
virtual Rect	getSizingRect (void) const
	Return a Rect that describes, in window relative pixel co-ordinates, the outer edge of the sizing area for this window.
virtual bool	testClassName_impl (const String &class_name) const
	Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. More...
virtual void	onRollupToggled (WindowEventArgs &e)
	Event generated internally whenever the roll-up / shade state of the window changes.
virtual void	onCloseClicked (WindowEventArgs &e)
	Event generated internally whenever the close button is clicked.
virtual void	onDragSizingStarted (WindowEventArgs &e)
	Handler called when drag-sizing of the FrameWindow starts.
virtual void	onDragSizingEnded (WindowEventArgs &e)
	Handler called when drag-sizing of the FrameWindow ends.
virtual void	onMouseMove (MouseEventArgs &e)
	Handler called when the mouse cursor has been moved within this window's area. More...
virtual void	onMouseButtonDown (MouseEventArgs &e)
	Handler called when a mouse button has been depressed within this window's area. More...
virtual void	onMouseButtonUp (MouseEventArgs &e)
	Handler called when a mouse button has been released within this window's area. More...
virtual void	onCaptureLost (WindowEventArgs &e)
	Handler called when this window loses capture of mouse inputs. More...
virtual void	onTextChanged (WindowEventArgs &e)
	Handler called when the window's text is changed. 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...
Protected Member Functions inherited from CEGUI::Window
virtual void	onSized (WindowEventArgs &e)
	Handler called when the window's size changes. More...
virtual void	onMoved (WindowEventArgs &e)
	Handler called when the window's position changes. More...
virtual void	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	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	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	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	onMouseWheel (MouseEventArgs &e)
	Handler called when the mouse wheel (z-axis) position changes 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	onRotated (WindowEventArgs &e)
	Handler called when the window's rotation factor is changed. More...
virtual void	onNonClientChanged (WindowEventArgs &e)
	Handler called when the window's non-client setting, affecting it's position and size relative to it's parent is changed. 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...
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...
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	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...
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...
void	updateGeometryRenderSettings ()
	Update position and clip region on this Windows geometry / rendering surface.
void	transferChildSurfaces ()
	transfer RenderingSurfaces to be owned by our target RenderingSurface.
Rect	getParentElementClipIntersection (const Rect &unclipped_area) const
	helper function for calculating clipping rectangles.
void	invalidate_impl (const bool recursive)
	helper function to invalidate window and optionally child windows.
bool	isInnerRectSizeChanged () const
	helper to return whether the inner rect size has changed
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 Rect	getUnclippedOuterRect_impl () const
	Default implementation of function to return Window outer rect area.
virtual Rect	getOuterRectClipper_impl () const
	Default implementation of function to return Window outer clipper area.
virtual Rect	getInnerRectClipper_impl () const
	Default implementation of function to return Window inner clipper area.
virtual Rect	getHitTestRect_impl () const
	Default implementation of function to return Window hit-test area.
virtual Rect	getNonClientChildWindowContentArea_impl () const
	Default implementation of function to return non-client content area.
virtual Rect	getClientChildWindowContentArea_impl () const
	Default implementation of function to return client content area.
virtual int	writePropertiesXML (XMLSerializer &xml_stream) const
virtual int	writeChildWindowsXML (XMLSerializer &xml_stream) const
virtual bool	writeAutoChildWindowXML (XMLSerializer &xml_stream) const
bool	constrainUVector2ToMinSize (const Size &base_sz, UVector2 &sz)
bool	constrainUVector2ToMaxSize (const Size &base_sz, UVector2 &sz)
void	markAllCachedRectsInvalid ()
void	calculatePixelSize ()
	calculate constrained pixel size of the window (outer rect)
void	fireAreaChangeEvents (const bool moved, const bool sized)
	helper to fire events based on changes to area rect
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 &)
EventSet &	operator= (EventSet &)

Protected Attributes
bool	d_frameEnabled
	true if window frame should be drawn.
bool	d_rollupEnabled
	true if roll-up of window is allowed.
bool	d_rolledup
	true if window is rolled up.
bool	d_sizingEnabled
	true if sizing is enabled for this window.
bool	d_beingSized
	true if window is being sized.
float	d_borderSize
	thickness of the sizing border around this window
Point	d_dragPoint
	point window is being dragged at.
const Image *	d_nsSizingCursor
	North/South sizing cursor image.
const Image *	d_ewSizingCursor
	East/West sizing cursor image.
const Image *	d_nwseSizingCursor
	North-West/South-East cursor image.
const Image *	d_neswSizingCursor
	North-East/South-West cursor image.
bool	d_dragMovable
	true if the window will move when dragged by the title bar.
Protected Attributes inherited from CEGUI::Window
const String	d_type
	type of Window (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.
bool	d_autoWindow
	true when this window is an auto-window (it's name contains __auto_)
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).
ChildList	d_children
	The list of child Window objects attached to this.
ChildList	d_drawList
	Child window objects arranged in rendering order.
Window *	d_parent
	Holds pointer to the parent window.
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.
bool	d_nonClientContent
	true if Window is in non-client (outside InnerRect) area of parent.
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.
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
	secons 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.
URect	d_area
	This Window objects area as defined by a URect.
Size	d_pixelSize
	Current constrained pixel size of the window.
UVector2	d_minSize
	current minimum size for the window.
UVector2	d_maxSize
	current maximum size for the window.
HorizontalAlignment	d_horzAlign
	Specifies the base for horizontal alignment.
VerticalAlignment	d_vertAlign
	Specifies the base for vertical alignment.
Vector3	d_rotation
	Rotation angles for this window.
Rect	d_outerUnclippedRect
	outer area rect in screen pixels
Rect	d_innerUnclippedRect
	inner area rect in screen pixels
Rect	d_outerRectClipper
	outer area clipping rect in screen pixels
Rect	d_innerRectClipper
	inner area clipping rect in screen pixels
Rect	d_hitTestRect
	area rect used for hit-testing agains this window
bool	d_outerUnclippedRectValid
bool	d_innerUnclippedRectValid
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)
Protected Attributes inherited from CEGUI::EventSet
EventMap	d_events
bool	d_muted
	true if events for this EventSet have been muted.

Additional Inherited Members
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
	definition of type used for the list of attached child windows.
typedef std::map< String, String, String::FastLessCompare >	UserStringMap
	definition of type used for the UserString dictionary.
typedef std::set< String, String::FastLessCompare >	BannedXMLPropertySet
	definition of type used to track properties banned from writing XML.
Static Protected Attributes inherited from CEGUI::Window
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
static WindowProperties::AutoRenderingSurface	d_autoRenderingSurfaceProperty
static WindowProperties::Rotation	d_rotationProperty
static WindowProperties::XRotation	d_xRotationProperty
static WindowProperties::YRotation	d_yRotationProperty
static WindowProperties::ZRotation	d_zRotationProperty
static WindowProperties::NonClient	d_nonClientProperty
static WindowProperties::TextParsingEnabled	d_textParsingEnabledProperty
static WindowProperties::Margin	d_marginProperty
static WindowProperties::UpdateMode	d_updateModeProperty
static WindowProperties::MouseInputPropagationEnabled	d_mouseInputPropagationProperty
static Window *	d_captureWindow
	Window that has captured inputs.
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

Abstract base class for a movable, sizable, window with a title-bar and a frame.

Member Enumeration Documentation

enum CEGUI::FrameWindow::SizingLocation

Enumeration that defines the set of possible locations for the mouse on a frame windows sizing border.

Enumerator
SizingNone	Position is not a sizing location.
SizingTopLeft	Position will size from the top-left.
SizingTopRight	Position will size from the top-right.
SizingBottomLeft	Position will size from the bottom left.
SizingBottomRight	Position will size from the bottom right.
SizingTop	Position will size from the top.
SizingLeft	Position will size from the left.
SizingBottom	Position will size from the bottom.
SizingRight	Position will size from the right.

Member Function Documentation

PushButton* CEGUI::FrameWindow::getCloseButton

(

)

const

Return a pointer to the close button component widget for this FrameWindow.

Returns

Pointer to a PushButton object.

Exceptions

UnknownObjectException

Thrown if the close button component does not exist.

const Image* CEGUI::FrameWindow::getEWSizingCursorImage

(

)

const

Return a pointer to the currently set Image to be used for the east-west sizing mouse cursor.

Returns

Pointer to an Image object, or 0 for none.

const Image* CEGUI::FrameWindow::getNESWSizingCursorImage

(

)

const

Return a pointer to the currently set Image to be used for the northeast-southwest sizing mouse cursor.

Returns

Pointer to an Image object, or 0 for none.

const Image* CEGUI::FrameWindow::getNSSizingCursorImage

(

)

const

Return a pointer to the currently set Image to be used for the north-south sizing mouse cursor.

Returns

Pointer to an Image object, or 0 for none.

const Image* CEGUI::FrameWindow::getNWSESizingCursorImage

(

)

const

Return a pointer to the currently set Image to be used for the northwest-southeast sizing mouse cursor.

Returns

Pointer to an Image object, or 0 for none.

SizingLocation CEGUI::FrameWindow::getSizingBorderAtPoint ( const Point &  pt ) const

protected

check local pixel co-ordinate point 'pt' and return one of the SizingLocation enumerated values depending where the point falls on the sizing border.

Parameters

pt	Point object describing, in pixels, the window relative offset to check.

Returns

One of the SizingLocation enumerated values that describe which part of the sizing border that pt corresponded to, if any.

float CEGUI::FrameWindow::getSizingBorderThickness ( void  ) const

inline

Return the thickness of the sizing border.

Returns

float value describing the thickness of the sizing border in screen pixels.

Titlebar* CEGUI::FrameWindow::getTitlebar

(

)

const

Return a pointer to the Titlebar component widget for this FrameWindow.

Returns

Pointer to a Titlebar object.

Exceptions

UnknownObjectException

Thrown if the Titlebar component does not exist.

virtual void CEGUI::FrameWindow::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 WindowFactory for each Window type.

Returns

Nothing

Reimplemented from CEGUI::Window.

bool CEGUI::FrameWindow::isBottomSizingLocation ( SizingLocation  loc ) const

inlineprotected

return true if given SizingLocation is on bottom edge.

Parameters

loc	SizingLocation value to be checked.

Returns

true if loc is on the bottom edge. false if loc is not on the bottom edge.

bool CEGUI::FrameWindow::isCloseButtonEnabled

(

void

)

const

Return whether this close button for this window is enabled.

Returns

true if the window has a close button and it is enabled, false if the window either has no close button or if the close button is disabled.

bool CEGUI::FrameWindow::isDragMovingEnabled ( void  ) const

inline

Return whether this FrameWindow can be moved by dragging the title bar.

Returns

true if the Window will move when the user drags the title bar, false if the window will not move.

bool CEGUI::FrameWindow::isFrameEnabled ( void  ) const

inline

Return whether the frame for this window is enabled.

Returns

true if the frame for this window is enabled, false if the frame for this window is disabled.

bool CEGUI::FrameWindow::isHit ( const Point &  position, const bool  allow_disabled  ) const

inlinevirtual

check if the given pixel position would hit this window.

Parameters

position	Vector2 object describing the position to check. The position describes a pixel offset from the top-left corner of the display.
allow_disabled	true specifies that the window may be 'hit' if it is disabled. false specifies that the window may only be hit if it is enabled.

Returns

• true if position hits this Window.
• false if position does not hit this window.

Reimplemented from CEGUI::Window.

References CEGUI::Window::isHit().

bool CEGUI::FrameWindow::isLeftSizingLocation ( SizingLocation  loc ) const

inlineprotected

return true if given SizingLocation is on left edge.

Parameters

loc	SizingLocation value to be checked.

Returns

true if loc is on the left edge. false if loc is not on the left edge.

bool CEGUI::FrameWindow::isRightSizingLocation ( SizingLocation  loc ) const

inlineprotected

return true if given SizingLocation is on right edge.

Parameters

loc	SizingLocation value to be checked.

Returns

true if loc is on the right edge. false if loc is not on the right edge.

bool CEGUI::FrameWindow::isRolledup ( void  ) const

inline

Return whether the window is currently rolled up (a.k.a shaded).

Returns

true if the window is rolled up, false if the window is not rolled up.

bool CEGUI::FrameWindow::isRollupEnabled ( void  ) const

inline

Return whether roll up (a.k.a shading) is enabled for this window.

Returns

true if roll up is enabled, false if roll up is disabled.

bool CEGUI::FrameWindow::isSizingEnabled ( void  ) const

inline

Return whether this window is sizable. Note that this requires that the window have an enabled frame and that sizing itself is enabled.

Returns

true if the window can be sized, false if the window can not be sized

bool CEGUI::FrameWindow::isTitleBarEnabled

(

void

)

const

Return whether the title bar for this window is enabled.

Returns

true if the window has a title bar and it is enabled, false if the window has no title bar or if the title bar is disabled.

bool CEGUI::FrameWindow::isTopSizingLocation ( SizingLocation  loc ) const

inlineprotected

return true if given SizingLocation is on top edge.

Parameters

loc	SizingLocation value to be checked.

Returns

true if loc is on the top edge. false if loc is not on the top edge.

bool CEGUI::FrameWindow::moveBottomEdge ( float  delta, URect &  out_area  )

protected

move the window's bottom edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.

Parameters

delta

float value that specifies the amount to move the window edge, and in which direction. Positive values make window larger.

bool CEGUI::FrameWindow::moveLeftEdge ( float  delta, URect &  out_area  )

protected

move the window's left edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.

Parameters

delta

float value that specifies the amount to move the window edge, and in which direction. Positive values make window smaller.

bool CEGUI::FrameWindow::moveRightEdge ( float  delta, URect &  out_area  )

protected

move the window's right edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.

Parameters

delta

float value that specifies the amount to move the window edge, and in which direction. Positive values make window larger.

bool CEGUI::FrameWindow::moveTopEdge ( float  delta, URect &  out_area  )

protected

move the window's top edge by 'delta'. The rest of the window does not move, thus this changes the size of the Window.

Parameters

delta

float value that specifies the amount to move the window edge, and in which direction. Positive values make window smaller.

void CEGUI::FrameWindow::offsetPixelPosition

(

const Vector2 &

offset

)

Move the window by the pixel offsets specified in offset.

    This is intended for internal system use - it is the method by which the title bar moves the frame window.

Parameters

offset

Vector2 object containing the offsets to apply (offsets are in screen pixels).

Returns

Nothing.

virtual void CEGUI::FrameWindow::onActivated ( ActivationEventArgs &  e )

protectedvirtual

Handler called when this window has become the active window.

Parameters

e	ActivationEventArgs class whose 'otherWindow' field is set to the window that previously was active, or NULL for none.

Reimplemented from CEGUI::Window.

virtual void CEGUI::FrameWindow::onCaptureLost ( WindowEventArgs &  e )

protectedvirtual

Handler called when this window loses capture of mouse inputs.

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.

virtual void CEGUI::FrameWindow::onDeactivated ( ActivationEventArgs &  e )

protectedvirtual

Handler called when this window has lost input focus and has been deactivated.

Parameters

e	ActivationEventArgs object whose 'otherWindow' field is set to the window that has now become active, or NULL for none.

Reimplemented from CEGUI::Window.

virtual void CEGUI::FrameWindow::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::FrameWindow::onMouseButtonUp ( MouseEventArgs &  e )

protectedvirtual

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

Parameters

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

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

virtual void CEGUI::FrameWindow::onTextChanged ( WindowEventArgs &  e )

protectedvirtual

Handler called when the window's text is changed.

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.

void CEGUI::FrameWindow::setCloseButtonEnabled

(

bool

setting

)

Enables or disables the close button for the frame window.

Parameters

setting

Set to true to enable the close button (if one is attached), or false to disable the close button.

Returns

Nothing.

void CEGUI::FrameWindow::setDragMovingEnabled

(

bool

setting

)

Set whether this FrameWindow can be moved by dragging the title bar.

Parameters

setting

true if the Window should move when the user drags the title bar, false if the window should not move.

Returns

Nothing.

void CEGUI::FrameWindow::setEWSizingCursorImage

(

const Image *

image

)

Set the Image to be used for the east-west sizing mouse cursor.

Parameters

image

Pointer to an Image object, or 0 for none.

Returns

Nothing.

void CEGUI::FrameWindow::setEWSizingCursorImage	(	const String &	imageset,
		const String &	image
	)

Set the image to be used for the east-west sizing mouse cursor.

Parameters

imageset	String holding the name of the Imageset containing the Image to be used.
image	String holding the name of the Image to be used.

Returns

Nothing.

Exceptions

UnknownObjectException

thrown if either imageset or image refer to non-existant entities.

void CEGUI::FrameWindow::setFrameEnabled

(

bool

setting

)

Enables or disables the frame for this window.

Parameters

setting

set to true to enable the frame for this window, or false to disable the frame for this window.

Returns

Nothing.

void CEGUI::FrameWindow::setNESWSizingCursorImage

(

const Image *

image

)

Set the Image to be used for the northeast-southwest sizing mouse cursor.

Parameters

image

Pointer to an Image object, or 0 for none.

Returns

Nothing.

void CEGUI::FrameWindow::setNESWSizingCursorImage	(	const String &	imageset,
		const String &	image
	)

Set the image to be used for the northeast-southwest sizing mouse cursor.

Parameters

imageset	String holding the name of the Imageset containing the Image to be used.
image	String holding the name of the Image to be used.

Returns

Nothing.

Exceptions

UnknownObjectException

thrown if either imageset or image refer to non-existant entities.

void CEGUI::FrameWindow::setNSSizingCursorImage

(

const Image *

image

)

Set the Image to be used for the north-south sizing mouse cursor.

Parameters

image

Pointer to an Image object, or 0 for none.

Returns

Nothing.

void CEGUI::FrameWindow::setNSSizingCursorImage	(	const String &	imageset,
		const String &	image
	)

Set the image to be used for the north-south sizing mouse cursor.

Parameters

imageset	String holding the name of the Imageset containing the Image to be used.
image	String holding the name of the Image to be used.

Returns

Nothing.

Exceptions

UnknownObjectException

thrown if either imageset or image refer to non-existant entities.

void CEGUI::FrameWindow::setNWSESizingCursorImage

(

const Image *

image

)

Set the Image to be used for the northwest-southeast sizing mouse cursor.

Parameters

image

Pointer to an Image object, or 0 for none.

Returns

Nothing.

void CEGUI::FrameWindow::setNWSESizingCursorImage	(	const String &	imageset,
		const String &	image
	)

Set the image to be used for the northwest-southeast sizing mouse cursor.

Parameters

imageset	String holding the name of the Imageset containing the Image to be used.
image	String holding the name of the Image to be used.

Returns

Nothing.

Exceptions

UnknownObjectException

thrown if either imageset or image refer to non-existant entities.

void CEGUI::FrameWindow::setRollupEnabled

(

bool

setting

)

Enables or disables roll-up (shading) for this window.

Parameters

setting

Set to true to enable roll-up for the frame window, or false to disable roll-up.

Returns

Nothing.

void CEGUI::FrameWindow::setSizingBorderThickness ( float  pixels )

inline

Set the size of the sizing border for this window.

Parameters

pixels

float value specifying the thickness for the sizing border in screen pixels.

Returns

Nothing.

void CEGUI::FrameWindow::setSizingEnabled

(

bool

setting

)

Enables or disables sizing for this window.

Parameters

setting

set to true to enable sizing (also requires frame to be enabled), or false to disable sizing.

Returns

nothing

void CEGUI::FrameWindow::setTitleBarEnabled

(

bool

setting

)

Enables or disables the title bar for the frame window.

Parameters

setting

set to true to enable the title bar (if one is attached), or false to disable the title bar.

Returns

Nothing.

virtual bool CEGUI::FrameWindow::testClassName_impl ( const String &  class_name ) const

inlineprotectedvirtual

Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.

Parameters

class_name

The class name that is to be checked.

Returns

true if this window was inherited from class_name. false if not.

Reimplemented from CEGUI::Window.

References CEGUI::Window::testClassName_impl().

void CEGUI::FrameWindow::toggleRollup

(

void

)

Toggles the state of the window between rolled-up (shaded) and normal sizes. This requires roll-up to be enabled.

Returns

Nothing

Member Data Documentation

const String CEGUI::FrameWindow::EventCloseClicked

static

Event fired when the close button for the window is clicked. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the FrameWindow whose close button was clicked.

const String CEGUI::FrameWindow::EventDragSizingEnded

static

Event fired when drag-sizing of the window ends. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the FrameWindow for which drag sizing has ended.

const String CEGUI::FrameWindow::EventDragSizingStarted

static

Event fired when drag-sizing of the window starts. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the FrameWindow that has started to be drag sized.

const String CEGUI::FrameWindow::EventRollupToggled

static

Event fired when the rollup (shade) state of the window is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the FrameWindow whose rolled up state has been changed.