Crazy Eddies GUI System  0.7.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
CEGUI::Window Class Reference

An abstract base class providing common functionality and specifying the required interface for derived classes. More...

Inherits CEGUI::PropertySet, and CEGUI::EventSet.

Inherited by CEGUI::ButtonBase, CEGUI::ClippedContainer, CEGUI::Combobox, CEGUI::DragContainer, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::GroupBox, CEGUI::GUISheet, CEGUI::ItemEntry, CEGUI::ItemListBase, CEGUI::Listbox, CEGUI::ListHeader, CEGUI::ListHeaderSegment, CEGUI::MultiColumnList, CEGUI::MultiLineEditbox, CEGUI::ProgressBar, CEGUI::ScrollablePane, CEGUI::Scrollbar, CEGUI::ScrolledContainer, CEGUI::Slider, CEGUI::Spinner, CEGUI::TabControl, CEGUI::Titlebar, CEGUI::Tooltip, and CEGUI::Tree.

+ Collaboration diagram for CEGUI::Window:

Public Member Functions

 Window (const String &type, const String &name)
 Constructor for Window base class. More...
 
virtual ~Window (void)
 Destructor for Window base class.
 
const StringgetType (void) const
 return a String object holding the type name for this Window. More...
 
const StringgetName (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...
 
WindowgetChild (const String &name) const
 return a pointer to the child window with the specified name. More...
 
WindowgetChild (uint ID) const
 return a pointer to the first attached child window with the specified ID value. More...
 
WindowgetChildRecursive (const String &name) const
 return a pointer to the first attached child window with the specified name. Children are traversed recursively. More...
 
WindowgetChildRecursive (uint ID) const
 return a pointer to the first attached child window with the specified ID value. Children are traversed recursively. More...
 
WindowgetChildAtIdx (size_t idx) const
 return a pointer to the child window that is attached to 'this' at the given index. More...
 
WindowgetActiveChild (void)
 return a pointer to the Window that currently has input focus starting with this Window. More...
 
const WindowgetActiveChild (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...
 
FontgetFont (bool useDefault=true) const
 return the active Font object for the Window. More...
 
const StringgetText (void) const
 return the current text for the Window More...
 
const StringgetTextVisual () 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...
 
virtual Rect getUnclippedInnerRect_impl (void) const
 Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering. More...
 
bool isCapturedByThis (void) const
 return true if this Window has input captured. More...
 
bool isCapturedByAncestor (void) const
 return true if an ancestor window has captured inputs. More...
 
bool isCapturedByChild (void) const
 return true if a child window has captured inputs. More...
 
virtual bool isHit (const Vector2 &position, const bool allow_disabled=false) const
 check if the given pixel position would hit this window. More...
 
WindowgetChildAtPosition (const Vector2 &position) const
 return the child Window that is hit by the given pixel position More...
 
WindowgetTargetChildAtPosition (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...
 
WindowgetParent (void) const
 return the parent of this Window. More...
 
const ImagegetMouseCursor (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...
 
TooltipgetTooltip (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 StringgetTooltipText (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...
 
GeometryBuffergetGeometryBuffer ()
 Return the GeometryBuffer object for this Window. More...
 
const StringgetLookNFeel () 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 StringgetUserString (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...
 
WindowgetActiveSibling ()
 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.
 
RenderingSurfacegetRenderingSurface () const
 return the RenderingSurface currently set for this window. May return 0.
 
RenderingSurfacegetTargetRenderingSurface () 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 WindowgetRootWindow () 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...
 
WindowgetRootWindow ()
 
const Vector3getRotation () 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...
 
virtual void initialiseComponents (void)
 Initialises the Window based object ready for use. More...
 
void setDestroyedByParent (bool setting)
 Set whether or not this Window will automatically be destroyed when its parent Window is destroyed. More...
 
void setAlwaysOnTop (bool setting)
 Set whether this window is always on top, or not. More...
 
void setEnabled (bool setting)
 Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering. More...
 
void enable (void)
 enable the Window to allow interaction. More...
 
void disable (void)
 disable the Window to prevent interaction. More...
 
void setVisible (bool setting)
 Set whether the Window is visible or hidden. More...
 
void show (void)
 show the Window. More...
 
void hide (void)
 hide the Window. More...
 
void activate (void)
 Activate the Window giving it input focus and bringing it to the top of all windows with the same always-on-top settig as this Window. More...
 
void deactivate (void)
 Deactivate the window. No further inputs will be received by the window until it is re-activated either programmatically or by the user interacting with the gui. More...
 
void setClippedByParent (bool setting)
 Set whether this Window will be clipped by its parent window(s). More...
 
void setID (uint ID)
 Set the current ID for the Window. More...
 
void setText (const String &text)
 Set the current text string for the Window. More...
 
void insertText (const String &text, const String::size_type position)
 Insert the text string text into the current text string for the Window object at the position specified by position. More...
 
void appendText (const String &text)
 Append the string text to the currect text string for the Window object. More...
 
void setFont (Font *font)
 Set the font used by this Window. More...
 
void setFont (const String &name)
 Set the font used by this Window. More...
 
void addChildWindow (const String &name)
 Add the named Window as a child of this Window. If the Window name is already attached to a Window, it is detached before being added to this Window. More...
 
void addChildWindow (Window *window)
 Add the specified Window as a child of this Window. If the Window window is already attached to a Window, it is detached before being added to this Window. More...
 
void removeChildWindow (const String &name)
 Remove the named Window from this windows child list. More...
 
void removeChildWindow (Window *window)
 Remove the specified Window form this windows child list. More...
 
void removeChildWindow (uint ID)
 Remove the first child Window with the specified ID. If there is more than one attached Window objects with the specified ID, only the fist one encountered will be removed. More...
 
void moveToFront ()
 Move the Window to the top of the z order. More...
 
void moveToBack ()
 Move the Window to the bottom of the Z order. More...
 
bool captureInput (void)
 Captures input to this window. More...
 
void releaseInput (void)
 Releases input capture from this Window. If this Window does not have inputs captured, nothing happens. More...
 
void setRestoreCapture (bool setting)
 Set whether this window will remember and restore the previous window that had inputs captured. More...
 
void setAlpha (float alpha)
 Set the current alpha value for this window. More...
 
void setInheritsAlpha (bool setting)
 Sets whether this Window will inherit alpha from its parent windows. More...
 
void invalidate (void)
 Invalidate this window causing at least this window 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 URectgetArea () const
 Return the windows area. More...
 
const UVector2getPosition () const
 Get the window's position. More...
 
const UDimgetXPosition () const
 Get the window's X position. More...
 
const UDimgetYPosition () 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 UVector2getMaxSize () const
 Get the window's maximum size. More...
 
const UVector2getMinSize () 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...
 
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...
 
WindowRenderergetWindowRenderer (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 RenderedStringgetRenderedString () const
 Return the parsed RenderedString object for this window.
 
RenderedStringParsergetCustomRenderedStringParser () 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 RenderedStringParsergetRenderedStringParser () const
 return the active RenderedStringParser to be used
 
Vector2 getUnprojectedPosition (const Vector2 &pos) const
 return Vector2 pos after being fully unprojected for this Window.
 
const BiDiVisualMappinggetBiDiVisualMapping () const
 return the pointer to the BiDiVisualMapping for this window, if any.
 
- 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 StringgetPropertyHelp (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 Member Functions

static WindowgetCaptureWindow (void)
 return the Window that currently has inputs captured. More...
 

Static Public Attributes

static const String EventNamespace
 Namespace for global events.
 
static const String EventWindowUpdated
 Signal the time based update of window.
 
static const String EventParentSized
 Parent of this Window has been re-sized.
 
static const String EventSized
 Window size has changed.
 
static const String EventMoved
 Window position has changed.
 
static const String EventTextChanged
 Text string for the Window has changed.
 
static const String EventFontChanged
 Font object for the Window has been changed.
 
static const String EventAlphaChanged
 Alpha blend value for the Window has changed.
 
static const String EventIDChanged
 Client assigned ID code for the Window has changed.
 
static const String EventActivated
 Window has been activated (has input focus)
 
static const String EventDeactivated
 Window has been deactivated (loses input focus)
 
static const String EventShown
 Window has been made visible.
 
static const String EventHidden
 Window has been hidden from view.
 
static const String EventEnabled
 Window has been enabled (interaction is possible)
 
static const String EventDisabled
 Window has been disabled (interaction is no longer possible)
 
static const String EventClippedByParentChanged
 Clipping by parent mode has been modified.
 
static const String EventDestroyedByParentChanged
 Destruction by parent mode has been modified.
 
static const String EventInheritsAlphaChanged
 Alpha inherited from parent mode has been modified.
 
static const String EventAlwaysOnTopChanged
 Always on top mode has been modified.
 
static const String EventInputCaptureGained
 Window has captured all inputs.
 
static const String EventInputCaptureLost
 Window has lost it's capture on inputs.
 
static const String EventRenderingStarted
 Rendering of the Window has started.
 
static const String EventRenderingEnded
 Rendering for the Window has finished.
 
static const String EventChildAdded
 A child Window has been added.
 
static const String EventChildRemoved
 A child window has been removed.
 
static const String EventDestructionStarted
 Destruction of the Window is about to begin.
 
static const String EventZOrderChanged
 The z-order of the window has changed.
 
static const String EventDragDropItemEnters
 A DragContainer has been dragged over this window.
 
static const String EventDragDropItemLeaves
 A DragContainer has left this window.
 
static const String EventDragDropItemDropped
 A DragContainer was dropped on this Window.
 
static const String EventVerticalAlignmentChanged
 The vertical alignment of the window has changed.
 
static const String EventHorizontalAlignmentChanged
 The vertical alignment of the window has changed.
 
static const String EventWindowRendererAttached
 The a new window renderer was attached.
 
static const String EventWindowRendererDetached
 The currently assigned window renderer was detached.
 
static const String EventRotated
 Window rotation factor(s) changed.
 
static const String EventNonClientChanged
 Window non-client setting was changed.
 
static const String EventMouseEnters
 Mouse cursor has entered the Window.
 
static const String EventMouseLeaves
 Mouse cursor has left the Window.
 
static const String EventMouseMove
 Mouse cursor was moved within the area of the Window.
 
static const String EventMouseWheel
 Mouse wheel was scrolled within the Window.
 
static const String EventMouseButtonDown
 A mouse button was pressed down within the Window.
 
static const String EventMouseButtonUp
 A mouse button was released within the Window.
 
static const String EventMouseClick
 A mouse button was clicked (down then up) within the Window.
 
static const String EventMouseDoubleClick
 A mouse button was double-clicked within the Window.
 
static const String EventMouseTripleClick
 A mouse button was triple-clicked within the Window.
 
static const String EventKeyDown
 A key on the keyboard was pressed.
 
static const String EventKeyUp
 A key on the keyboard was released.
 
static const String EventCharacterKey
 A text character was typed on the keyboard.
 
static const String TooltipNameSuffix
 Widget name suffix for automatically created tooltip widgets.
 
static const String AutoWidgetNameSuffix
 Something that all generated widgets will have in their names.
 

Protected Types

typedef std::vector< 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.
 
- Protected Types inherited from CEGUI::EventSet
typedef std::map< String,
Event
*, String::FastLessCompare
EventMap
 

Protected Member Functions

virtual void onSized (WindowEventArgs &e)
 Handler called when the window's size changes. More...
 
virtual void onMoved (WindowEventArgs &e)
 Handler called when the window's position changes. More...
 
virtual void onTextChanged (WindowEventArgs &e)
 Handler called when the window's text is changed. More...
 
virtual void onFontChanged (WindowEventArgs &e)
 Handler called when the window's font is changed. More...
 
virtual void onAlphaChanged (WindowEventArgs &e)
 Handler called when the window's alpha blend value is changed. More...
 
virtual void onIDChanged (WindowEventArgs &e)
 Handler called when the window's client assigned ID is changed. More...
 
virtual void onShown (WindowEventArgs &e)
 Handler called when the window is shown (made visible). More...
 
virtual void onHidden (WindowEventArgs &e)
 Handler called when the window is hidden. More...
 
virtual void onEnabled (WindowEventArgs &e)
 Handler called when the window is enabled. More...
 
virtual void onDisabled (WindowEventArgs &e)
 Handler called when the window is disabled. More...
 
virtual void onClippingChanged (WindowEventArgs &e)
 Handler called when the window's setting for being clipped by it's parent is changed. More...
 
virtual void onParentDestroyChanged (WindowEventArgs &e)
 Handler called when the window's setting for being destroyed automatically be it's parent is changed. More...
 
virtual void onInheritsAlphaChanged (WindowEventArgs &e)
 Handler called when the window's setting for inheriting alpha-blending is changed. More...
 
virtual void onAlwaysOnTopChanged (WindowEventArgs &e)
 Handler called when the window's always-on-top setting is changed. More...
 
virtual void onCaptureGained (WindowEventArgs &e)
 Handler called when this window gains capture of mouse inputs. More...
 
virtual void onCaptureLost (WindowEventArgs &e)
 Handler called when this window loses capture of mouse inputs. More...
 
virtual void onRenderingStarted (WindowEventArgs &e)
 Handler called when rendering for this window has started. More...
 
virtual void onRenderingEnded (WindowEventArgs &e)
 Handler called when rendering for this window has ended. More...
 
virtual void onZChanged (WindowEventArgs &e)
 Handler called when the z-order position of this window has changed. More...
 
virtual void onDestructionStarted (WindowEventArgs &e)
 Handler called when this window's destruction sequence has begun. More...
 
virtual void onActivated (ActivationEventArgs &e)
 Handler called when this window has become the active window. More...
 
virtual void onDeactivated (ActivationEventArgs &e)
 Handler called when this window has lost input focus and has been deactivated. More...
 
virtual void onParentSized (WindowEventArgs &e)
 Handler called when this window's parent window has been resized. If this window is the root / GUI Sheet window, this call will be made when the display size changes. More...
 
virtual void onChildAdded (WindowEventArgs &e)
 Handler called when a child window is added to this window. More...
 
virtual void onChildRemoved (WindowEventArgs &e)
 Handler called when a child window is removed from this window. More...
 
virtual void onMouseEnters (MouseEventArgs &e)
 Handler called when the mouse cursor has entered this window's area. More...
 
virtual void onMouseLeaves (MouseEventArgs &e)
 Handler called when the mouse cursor has left this window's area. More...
 
virtual void onMouseMove (MouseEventArgs &e)
 Handler called when the mouse cursor has been moved within this window's area. More...
 
virtual void onMouseWheel (MouseEventArgs &e)
 Handler called when the mouse wheel (z-axis) position changes within this window's area. More...
 
virtual void onMouseButtonDown (MouseEventArgs &e)
 Handler called when a mouse button has been depressed within this window's area. More...
 
virtual void onMouseButtonUp (MouseEventArgs &e)
 Handler called when a mouse button has been released within this window's area. More...
 
virtual void onMouseClicked (MouseEventArgs &e)
 Handler called when a mouse button has been clicked (that is depressed and then released, within a specified time) within this window's area. More...
 
virtual void onMouseDoubleClicked (MouseEventArgs &e)
 Handler called when a mouse button has been double-clicked within this window's area. More...
 
virtual void onMouseTripleClicked (MouseEventArgs &e)
 Handler called when a mouse button has been triple-clicked within this window's area. More...
 
virtual void onKeyDown (KeyEventArgs &e)
 Handler called when a key as been depressed while this window has input focus. More...
 
virtual void onKeyUp (KeyEventArgs &e)
 Handler called when a key as been released while this window has input focus. More...
 
virtual void onCharacter (KeyEventArgs &e)
 Handler called when a character-key has been pressed while this window has input focus. More...
 
virtual void onDragDropItemEnters (DragDropEventArgs &e)
 Handler called when a DragContainer is dragged over this window. More...
 
virtual void onDragDropItemLeaves (DragDropEventArgs &e)
 Handler called when a DragContainer is dragged over this window. More...
 
virtual void onDragDropItemDropped (DragDropEventArgs &e)
 Handler called when a DragContainer is dragged over this window. More...
 
virtual void onVerticalAlignmentChanged (WindowEventArgs &e)
 Handler called when the vertical alignment setting for the window is changed. More...
 
virtual void onHorizontalAlignmentChanged (WindowEventArgs &e)
 Handler called when the horizontal alignment setting for the window is changed. More...
 
virtual void onWindowRendererAttached (WindowEventArgs &e)
 Handler called when a new window renderer object is attached. More...
 
virtual void onWindowRendererDetached (WindowEventArgs &e)
 Handler called when the currently attached window renderer object is detached. More...
 
virtual void 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 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 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...
 
void setParent (Window *parent)
 Set the parent window for this window object. More...
 
Size getSize_impl (const Window *window) const
 
void generateAutoRepeatEvent (MouseButton button)
 Fires off a repeated mouse button down event for this window.
 
virtual bool validateWindowRenderer (const String &name) const
 Function used in checking if a WindowRenderer is valid for this window. More...
 
void banPropertyFromXML (const Property *property)
 Adds a property to the XML ban list.
 
bool isPropertyBannedFromXML (const Property *property) const
 Returns whether a property is banned from XML.
 
bool isPropertyAtDefault (const Property *property) const
 Returns whether a property is at it's default value. This function is different from Property::isDefatult as it takes the assigned look'n'feel (if the is one) into account.
 
void notifyClippingChanged (void)
 Recursively inform all children that the clipping has changed and screen rects needs to be recached.
 
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.
 
virtual int writePropertiesXML (XMLSerializer &xml_stream) const
 
virtual int writeChildWindowsXML (XMLSerializer &xml_stream) const
 
virtual bool writeAutoChildWindowXML (XMLSerializer &xml_stream) const
 
- Protected Member Functions inherited from CEGUI::EventSet
EventgetEventObject (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 &)
 
EventSetoperator= (EventSet &)
 

Protected Attributes

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.
 
Windowd_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).
 
WindowRendererd_windowRenderer
 The WindowRenderer module that implements the Look'N'Feel specification.
 
GeometryBufferd_geometry
 Object which acts as a cache of geometry drawn by this Window.
 
RenderingSurfaced_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 Imaged_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
 
Windowd_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.
 
Fontd_font
 Holds pointer to the Window objects current Font.
 
String d_textLogical
 Holds the text / label / caption for this Window.
 
BiDiVisualMappingd_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.
 
RenderedStringParserd_customStringParser
 Pointer to a custom (user assigned) RenderedStringParser object.
 
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.
 
Tooltipd_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
 
- Protected Attributes inherited from CEGUI::EventSet
EventMap d_events
 
bool d_muted
 true if events for this EventSet have been muted.
 

Static Protected Attributes

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 Windowd_captureWindow
 Window that has captured inputs.
 
static BasicRenderedStringParser d_basicStringParser
 Shared instance of a parser to be used in most instances.
 

Friends

class System
 
class WindowManager
 

Additional Inherited Members

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

Detailed Description

An abstract base class providing common functionality and specifying the required interface for derived classes.

The Window base class is core UI object class that the the system knows about; for this reason, every other window, widget, or similar item within the system must be derived from Window.

The base class provides the common functionality required by all UI objects, and specifies the minimal interface required to be implemented by derived classes.

Constructor & Destructor Documentation

CEGUI::Window::Window ( const String type,
const String name 
)

Constructor for Window base class.

Parameters
typeString object holding Window type (usually provided by WindowFactory).
nameString object holding unique name for the Window.

Member Function Documentation

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

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

Parameters
nameString object holding the name of the Window to be added.
Returns
Nothing.
Exceptions
UnknownObjectExceptionthrown if no Window named name exists.
InvalidRequestExceptionthrown if Window name is an ancestor of this Window, to prevent cyclic Window structures.
void CEGUI::Window::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.

Parameters
windowPointer to the Window object to be added.
Returns
Nothing
Exceptions
InvalidRequestExceptionthrown if Window window is an ancestor of this Window, to prevent cyclic Window structures.
void CEGUI::Window::addWindowToDrawList ( Window wnd,
bool  at_back = false 
)
protected

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.

Parameters
wndWindow object to be added to the drawing list.
at_backIndicates whether the window should be placed at the back of other windows in the same group. If this is false, the window is placed in front of other windows in the group.
Returns
Nothing.
void CEGUI::Window::appendText ( const String text)

Append the string text to the currect text string for the Window object.

Parameters
textString object holding the text that is to be appended to the Window object's current text string.
void CEGUI::Window::bufferGeometry ( const RenderingContext ctx)
protected

Perform drawing operations concerned with generating and buffering window geometry.

Note
This function is a sub-function of drawSelf; it is provided to make it easier to override drawSelf without needing to duplicate large sections of the code from the default implementation.
bool CEGUI::Window::captureInput ( void  )

Captures input to this window.

Returns
  • true if input was successfully captured to this window.
  • false if input could not be captured to this window (maybe because the window is not active).
void CEGUI::Window::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.

Returns
Nothing.
virtual void CEGUI::Window::destroy ( void  )
virtual

Internal destroy method which actually just adds the window and any parent destructed child windows to the dead pool.

This is virtual to allow for specialised cleanup which may be required
in some advanced cases.  If you override this for the above reason, you
MUST call this base class version.
Note
You never have to call this method yourself, use WindowManager to destroy your Window objects (which will call this for you).

Reimplemented in CEGUI::ScrollablePane.

void CEGUI::Window::disable ( void  )
inline

disable the Window to prevent interaction.

Returns
Nothing
bool CEGUI::Window::distributesCapturedInputs ( void  ) const

Return whether the window wants inputs passed to its attached child windows when the window has inputs captured.

Returns
  • true if System should pass captured input events to child windows.
  • false if System should pass captured input events to this window only.
virtual void CEGUI::Window::drawSelf ( const RenderingContext ctx)
protectedvirtual

Perform the actual rendering for this Window.

Parameters
ctxRenderingContext holding the details of the RenderingSurface to be used for the Window rendering operations.
Returns
Nothing

Reimplemented in CEGUI::TabControl, CEGUI::ScrolledContainer, and CEGUI::ClippedContainer.

void CEGUI::Window::enable ( void  )
inline

enable the Window to allow interaction.

Returns
Nothing
Window* CEGUI::Window::getActiveChild ( void  )

return a pointer to the Window that currently has input focus starting with this Window.

Returns
Pointer to the window that is active (has input focus) starting at this window. The function will return 'this' if this Window is active and either no children are attached or if none of the attached children are active. Returns NULL if this Window (and therefore all children) are not active.
Window* CEGUI::Window::getActiveSibling ( )

Returns the active sibling window.

This searches the immediate children of this window's parent, and
returns a pointer to the active window.  The method will return this if
we are the immediate child of our parent that is active.  If our parent
is not active, or if no immediate child of our parent is active then 0
is returned.  If this window has no parent, and this window is not
active then 0 is returned, else this is returned.
Returns
A pointer to the immediate child window attached to our parent that is currently active, or 0 if no immediate child of our parent is active.
float CEGUI::Window::getAlpha ( void  ) const
inline

return the current alpha value set for this Window

Note
The alpha value set for any given window may or may not be the final alpha value that is used when rendering. All window objects, by default, inherit alpha from thier parent window(s) - this will blend child windows, relatively, down the line of inheritance. This behaviour can be overridden via the setInheritsAlpha() method. To return the true alpha value that will be applied when rendering, use the getEffectiveAlpha() method.
Returns
the currently set alpha value for this Window. The value returned Will be between 0.0f and 1.0f.
const URect& CEGUI::Window::getArea ( ) const

Return the windows area.

Returns the area occupied by this window.  The defined area is offset
from the top-left corner of this windows parent window or from the
top-left corner of the display if this window has no parent
(i.e. it is the root window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Returns
URect describing the rectangle of the window area.
float CEGUI::Window::getAutoRepeatDelay ( void  ) const

Return the current auto-repeat delay setting for this window.

Returns
float value indicating the delay, in seconds, defore the first repeat mouse button down event will be triggered when autorepeat is enabled.
float CEGUI::Window::getAutoRepeatRate ( void  ) const

Return the current auto-repeat rate setting for this window.

Returns
float value indicating the rate, in seconds, at which repeat mouse button down events will be generated after the initial delay has expired.
static Window* CEGUI::Window::getCaptureWindow ( void  )
inlinestatic

return the Window that currently has inputs captured.

Returns
Pointer to the Window object that currently has inputs captured, or NULL if no Window has captured input.
Window* CEGUI::Window::getChild ( const String name) const

return a pointer to the child window with the specified name.

This function will throw an exception if no child object with the given
name is attached.  This decision was made (over returning NULL if no
window was found) so that client code can assume that if the call
returns it has a valid window pointer.  We provide the isChild()
functions for checking if a given window is attached.
Parameters
nameString object holding the name of the child window for which a pointer is to be returned.
Returns
Pointer to the Window object attached to this window that has the name name.
Exceptions
UnknownObjectExceptionthrown if no window named name is attached to this Window.
Window* CEGUI::Window::getChild ( uint  ID) const

return a pointer to the first attached child window with the specified ID value.

This function will throw an exception if no child object with the given
ID is attached.  This decision was made (over returning NULL if no
window was found) so that client code can assume that if the call
returns it has a valid window pointer.  We provide the isChild()
functions for checking if a given window is attached.
Parameters
IDuint value specifying the ID code of the window to return a pointer to.
Returns
Pointer to the (first) Window object attached to this window that has the ID code ID.
Exceptions
UnknownObjectExceptionthrown if no window with the ID code ID is attached to this Window.
Window* CEGUI::Window::getChildAtIdx ( size_t  idx) const
inline

return a pointer to the child window that is attached to 'this' at the given index.

Parameters
idxIndex of the child window whos pointer should be returned. This value is not bounds checked, client code should ensure that this is less than the value returned by getChildCount().
Returns
Pointer to the child window currently attached at index position idx
Window* CEGUI::Window::getChildAtPosition ( const Vector2 position) const

return the child Window that is hit by the given pixel position

Parameters
positionVector2 object describing the position to check. The position describes a pixel offset from the top-left corner of the display.
Returns
Pointer to the child Window that was hit according to the location position, or 0 if no child of this window was hit.
size_t CEGUI::Window::getChildCount ( void  ) const
inline

return the number of child Window objects currently attached to this Window.

Returns
size_t value equal to the number of Window objects directly attached to this Window as children.
Window* CEGUI::Window::getChildRecursive ( const String name) const

return a pointer to the first attached child window with the specified name. Children are traversed recursively.

Contrary to the non recursive version of this function, this one will
not throw an exception, but return 0 in case no child was found.
Note
WARNING! This function can be very expensive and should only be used when you have no other option available. If you decide to use it anyway, make sure the window hierarchy from the entry point is small.
Parameters
nameString object holding the name of the child window for which a pointer is to be returned.
Returns
Pointer to the Window object attached to this window that has the name name.

If no child is found with the name name, 0 is returned.

Window* CEGUI::Window::getChildRecursive ( uint  ID) const

return a pointer to the first attached child window with the specified ID value. Children are traversed recursively.

Contrary to the non recursive version of this function, this one will
not throw an exception, but return 0 in case no child was found.
Note
WARNING! This function can be very expensive and should only be used when you have no other option available. If you decide to use it anyway, make sure the window hierarchy from the entry point is small.
Parameters
IDuint value specifying the ID code of the window to return a pointer to.
Returns
Pointer to the (first) Window object attached to this window that has the ID code ID. If no child is found with the ID code ID, 0 is returned.
Rect CEGUI::Window::getClipRect ( const bool  non_client = false) const

Return a Rect that describes the rendering clipping rect for the Window.

This function can return the clipping rect for either the inner or outer
area dependant upon the boolean values passed in.
Note
The areas returned by this function gives you the correct clipping rects for rendering within the Window's areas. The area described may or may not correspond to the final visual clipping actually seen on the display; this is intentional and neccessary due to the way that imagery is cached under some configurations.
Parameters
non_client
  • true to return the non-client clipping area (based on outer rect).
  • false to return the client clipping area (based on inner rect).
float CEGUI::Window::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.

Returns
the effective alpha that will be applied to this Window when rendering. The value returned Will be between 0.0f and 1.0f.
EventSet::Iterator CEGUI::Window::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.

This helper member is provided as an easy way to avoid some abiguity we have due to using multiple inheritence. Ultimately it avoids the need to do things like this (which some people don't like!):
// obtain an iterator for the EventSet
EventSet::Iterator evt_iter = myWindow->EventSet::getIterator();
// obtain an iterator for the PropertySet
PropertySet::Iterator prp_iter = myWindow->PropertySet::getIterator();
Note
Iterating over events in the EventSet is of questionable use these days, since available Events are no longer added in one batch at creation time, but are added individually whenever an event is first subscribed.
Returns
EventSet::Iterator object.
Font* CEGUI::Window::getFont ( bool  useDefault = true) const

return the active Font object for the Window.

Parameters
useDefaultSepcifies whether to return the default font if this Window has no preferred font set.
Returns
Pointer to the Font being used by this Window. If the window has no assigned font, and useDefault is true, then the default system font is returned.
GeometryBuffer& CEGUI::Window::getGeometryBuffer ( )

Return the GeometryBuffer object for this Window.

Returns
Reference to the GeometryBuffer object for this Window.
UDim CEGUI::Window::getHeight ( ) const

Get the window's height.

Gets the height of the area occupied by this window.
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Returns
UDim describing the height of the window area.
Rect CEGUI::Window::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.

The area returned by this function may also be useful for certain calculations that require the clipped Window area as seen on the display as opposed to what is used for rendering (since the actual rendering clipper rects should not to be used if reliable results are desired).

HorizontalAlignment CEGUI::Window::getHorizontalAlignment ( ) const
inline

Get the horizontal alignment.

Returns the horizontal alignment for the window.  This setting affects
how the windows position is interpreted relative to its parent.
Returns
One of the HorizontalAlignment enumerated values.
uint CEGUI::Window::getID ( void  ) const
inline

return the ID code currently assigned to this Window by client code.

Returns
uint value equal to the currently assigned ID code for this Window.
Rect CEGUI::Window::getInnerRectClipper ( ) const

Return a Rect that describes the rendering clipping rect based upon the inner rect area of the window.

Note
The area returned by this function gives you the correct clipping rect for rendering within the Window's inner rect area. The area described may or may not correspond to the final visual clipping actually seen on the display; this is intentional and neccessary due to the way that imagery is cached under some configurations.
const String& CEGUI::Window::getLookNFeel ( ) const

Get the name of the LookNFeel assigned to this window.

Returns
String object holding the name of the look assigned to this window. Returns the empty string if no look is assigned.
const UVector2& CEGUI::Window::getMaxSize ( ) const

Get the window's maximum size.

Gets the maximum size that this windows area may occupy (whether size
changes occur by user interaction, general system operation, or by
direct setting by client code).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Returns
UVector2 describing the maximum size of the window area.
const UVector2& CEGUI::Window::getMinSize ( ) const

Get the window's minimum size.

Gets the minimum size that this windows area may occupy (whether size
changes occur by user interaction, general system operation, or by
direct setting by client code).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Returns
UVector2 describing the minimum size of the window area.
bool CEGUI::Window::getModalState ( void  ) const
inline

Get whether or not this Window is the modal target.

Returns
Returns true if this Window is the modal target, otherwise false.

References CEGUI::System::getSingleton().

const Image* CEGUI::Window::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.

Parameters
useDefaultSepcifies whether to return the default mouse cursor image if this window specifies no preferred mouse cursor image.
Returns
Pointer to the mouse cursor image that will be used when the mouse enters this window's area. May return NULL indicating no cursor will be drawn for this window.
const String& CEGUI::Window::getName ( void  ) const
inline

return a String object holding the name of this Window.

Returns
String object holding the unique Window name.
Rect CEGUI::Window::getOuterRectClipper ( ) const

Return a Rect that describes the rendering clipping rect based upon the outer rect area of the window.

Note
The area returned by this function gives you the correct clipping rect for rendering within the Window's outer rect area. The area described may or may not correspond to the final visual clipping actually seen on the display; this is intentional and neccessary due to the way that imagery is cached under some configurations.
Window* CEGUI::Window::getParent ( void  ) const
inline

return the parent of this Window.

Returns
Pointer to the Window object that is the parent of this Window. This value can be NULL, in which case the Window is a GUI sheet / root.
float CEGUI::Window::getParentPixelHeight ( void  ) const

Return the pixel Height of the parent element. This always returns a valid number.

Returns
float value that is equal to the pixel height of this Window objects parent
Size CEGUI::Window::getParentPixelSize ( void  ) const

Return the pixel size of the parent element. This always returns a valid object.

Returns
Size object that describes the pixel dimensions of this Window objects parent
float CEGUI::Window::getParentPixelWidth ( void  ) const

Return the pixel Width of the parent element. This always returns a valid number.

Returns
float value that is equal to the pixel width of this Window objects parent
Size CEGUI::Window::getPixelSize ( void  ) const
inline

Return the window size in pixels.

Returns
Size object describing this windows size in pixels.
const UVector2& CEGUI::Window::getPosition ( ) const

Get the window's position.

Gets the position of the area occupied by this window.  The position is
offset from the top-left corner of this windows parent window or from
the top-left corner of the display if this window has no parent
(i.e. it is the root window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Returns
UVector2 describing the position (top-left corner) of the window area.
PropertySet::Iterator CEGUI::Window::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.

This helper member is provided as an easy way to avoid some abiguity we have due to using multiple inheritence. Ultimately it avoids the need to do things like this (which some people don't like!):
// obtain an iterator for the EventSet
EventSet:: Iterator evt_iter = myWindow->EventSet::getIterator();
// obtain an iterator for the PropertySet
PropertySet::Iterator prp_iter = myWindow->PropertySet::getIterator();
Returns
PropertySet::Iterator object.
const Window* CEGUI::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.

Returns
A pointer to the root window of the hierarchy that this window is attched to.
UVector2 CEGUI::Window::getSize ( ) const

Get the window's size.

Gets the size of the area occupied by this window.
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Returns
UVector2 describing the size of the window area.
Window* CEGUI::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.

Parameters
positionVector2 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 a disabled window may be returned as the target.
  • false specifies that only enabled windows may be returned.
Returns
Pointer to the child Window that was hit according to the location position, or 0 if no child of this window was hit.
const String& CEGUI::Window::getText ( void  ) const
inline

return the current text for the Window

Returns
The String object that holds the current text for this Window.
Tooltip* CEGUI::Window::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.

Returns
Pointer to a Tooltip based object, or NULL.
const String& CEGUI::Window::getTooltipText ( void  ) const

Return the current tooltip text set for this Window.

Returns
String object holding the current tooltip text set for this window.
String CEGUI::Window::getTooltipType ( void  ) const

Return the custom tooltip type.

Returns
String object holding the current custom tooltip window type, or an empty string if no custom tooltip is set.
const String& CEGUI::Window::getType ( void  ) const

return a String object holding the type name for this Window.

Returns
String object holding the Window type.
virtual Rect CEGUI::Window::getUnclippedInnerRect_impl ( void  ) const
virtual

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.

Returns
Rect object that describes, in unclipped screen pixel co-ordinates, the window object's inner rect area.

Reimplemented in CEGUI::ScrolledContainer, and CEGUI::ClippedContainer.

Rect CEGUI::Window::getUnclippedRect ( const bool  inner) const

Return a Rect that describes the unclipped area covered by the Window.

This function can return either the inner or outer area dependant upon
the boolean values passed in.
Parameters
inner
  • true if the inner rect area should be returned.
  • false if the outer rect area should be returned.
void* CEGUI::Window::getUserData ( void  ) const
inline

Return the user data set for this Window.

Each Window can have some client assigned data attached to it, this data
is not used by the GUI system in any way.  Interpretation of the data is
entirely application specific.
Returns
pointer to the user data that is currently set for this window.
const String& CEGUI::Window::getUserString ( const String name) const

Returns a named user string.

Parameters
nameString object holding the name of the string to be returned.
Returns
String object holding the data stored for the requested user string.
Exceptions
UnknownObjectExceptionthrown if a user string named name does not exist.
VerticalAlignment CEGUI::Window::getVerticalAlignment ( ) const
inline

Get the vertical alignment.

Returns the vertical alignment for the window.  This setting affects how
the windows position is interpreted relative to its parent.
Returns
One of the VerticalAlignment enumerated values.
UDim CEGUI::Window::getWidth ( ) const

Get the window's width.

Gets the width of the area occupied by this window.
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Returns
UDim describing the width of the window area.
WindowRenderer* CEGUI::Window::getWindowRenderer ( void  ) const

Get the currently assigned WindowRenderer. (Look'N'Feel specification).

Returns
A pointer to the assigned window renderer object. 0 if no window renderer is assigned.
String CEGUI::Window::getWindowRendererName ( void  ) const

Get the factory name of the currently assigned WindowRenderer. (Look'N'Feel specification).

Returns
The factory name of the currently assigned WindowRenderer. If no WindowRenderer is assigned an empty string is returned.
const UDim& CEGUI::Window::getXPosition ( ) const

Get the window's X position.

Gets the x position (left edge) of the area occupied by this window.
The position is offset from the left edge of this windows parent window
or from the left edge of the display if this window has no parent
(i.e. it is the root window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Returns
UDim describing the x position of the window area.
const UDim& CEGUI::Window::getYPosition ( ) const

Get the window's Y position.

Gets the y position (top edge) of the area occupied by this window.
The position is offset from the top edge of this windows parent window
or from the top edge of the display if this window has no parent
(i.e. it is the root window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Returns
UDim describing the y position of the window area.
void CEGUI::Window::hide ( void  )
inline

hide the Window.

Note
If the window is the active window, it will become deactivated as a result of being hidden.
Returns
Nothing
bool CEGUI::Window::inheritsAlpha ( void  ) const
inline

return true if the Window inherits alpha from its parent(s).

Returns
  • true if the Window inherits alpha from its parent(s)
  • false if the alpha for this Window is independant from its parents.
bool CEGUI::Window::inheritsTooltipText ( void  ) const

Return whether this window inherits Tooltip text from its parent when its own tooltip text is not set.

Returns
  • true if the window inherits tooltip text from its parent when its own text is not set.
  • false if the window does not inherit tooltip text from its parent (and shows no tooltip when no text is set).
virtual void CEGUI::Window::initialiseComponents ( void  )
inlinevirtual

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 in CEGUI::MultiColumnList, CEGUI::Combobox, CEGUI::ScrollablePane, CEGUI::Listbox, CEGUI::MultiLineEditbox, CEGUI::Scrollbar, CEGUI::TabControl, CEGUI::ItemListBase, CEGUI::Slider, CEGUI::ScrolledItemListBase, CEGUI::ItemListbox, CEGUI::GroupBox, CEGUI::Spinner, CEGUI::FrameWindow, and CEGUI::ComboDropList.

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

Parameters
textString object holding the text that is to be inserted into the Window object's current text string.
positionThe characted index position where the string text should be inserted.
void CEGUI::Window::invalidate ( void  )

Invalidate this window causing at least this window to be redrawn during the next rendering pass.

Returns
Nothing
bool CEGUI::Window::isActive ( void  ) const

return true if this is the active Window. An active window is a window that may receive user inputs.

Mouse events are always sent to the window containing the mouse cursor
regardless of what this function reports (unless a window has captured
inputs).  The active state mainly determines where send other, for
example keyboard, inputs.
Returns
  • true if the window is active and may be sent inputs by the system.
  • false if the window is inactive and will not be sent inputs.
bool CEGUI::Window::isAlwaysOnTop ( void  ) const
inline

returns whether or not this Window is an always on top Window. Also known as a top-most window.

Returns
  • true if this Window is always drawn on top of other normal windows.
  • false if the Window has normal z-order behaviour.
bool CEGUI::Window::isAncestor ( const String name) const

return true if the specified Window is some ancestor of this Window

Parameters
nameString object holding the name of the Window to check for.
Returns
  • true if a Window named name is an ancestor (parent, or parent of parent, etc) of this Window.
  • false if a Window named name is in no way an ancestor of this window.
bool CEGUI::Window::isAncestor ( uint  ID) const

return true if any Window with the given ID is some ancestor of this Window.

Parameters
IDuint value specifying the ID to look for.
Returns
  • true if an ancestor (parent, or parent of parent, etc) was found with the ID code ID.
  • false if no ancestor window has the ID code ID.
bool CEGUI::Window::isAncestor ( const Window window) const

return true if the specified Window is some ancestor of this Window.

Parameters
windowPointer to the Window object to look for.
Returns
  • true if window was found to be an ancestor (parent, or parent of parent, etc) of this Window.
  • false if window is not an ancestor of this window.
bool CEGUI::Window::isCapturedByAncestor ( void  ) const
inline

return true if an ancestor window has captured inputs.

Returns
  • true if input is captured by a Window that is some ancestor (parent, parent of parent, etc) of this Window.
  • false if no ancestor of this window has captured input.
bool CEGUI::Window::isCapturedByChild ( void  ) const
inline

return true if a child window has captured inputs.

Returns
  • true if input is captured by a Window that is a child of this Window.
  • false if no child of this window has not captured input.
bool CEGUI::Window::isCapturedByThis ( void  ) const
inline

return true if this Window has input captured.

Returns
  • true if this Window has captured inputs.
  • false if some other Window, or no Window, has captured inputs.
bool CEGUI::Window::isChild ( const String name) const

returns whether a Window with the specified name is currently attached to this Window as a child.

Parameters
nameString object containing the name of the Window to look for.
Returns
  • true if a Window named name is currently attached to this Window.
  • false if no such child Window is attached.
bool CEGUI::Window::isChild ( uint  ID) const

returns whether at least one window with the given ID code is attached to this Window as a child.

Note
ID codes are client assigned and may or may not be unique, and as such, the return from this function will only have meaning to the client code.
Parameters
IDuint ID code to look for.
Returns
  • true if at least one child window was found with the ID code ID
  • false if no child window was found with the ID code ID.
bool CEGUI::Window::isChild ( const Window window) const

return true if the given Window is a child of this window.

Parameters
windowPointer to the Window object to look for.
Returns
  • true if Window object window is attached to this window as a child.
  • false if Window object window is not a child of this Window.
bool CEGUI::Window::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.

Note
ID codes are client assigned and may or may not be unique, and as such, the return from this function will only have meaning to the client code.

WARNING! This function can be very expensive and should only be used when you have no other option available. If you decide to use it anyway, make sure the window hierarchy from the entry point is small.

Parameters
IDuint ID code to look for.
Returns
  • true if at least one child window was found with the ID code ID
  • false if no child window was found with the ID code ID.
bool CEGUI::Window::isClippedByParent ( void  ) const
inline

return true if this Window is clipped so that its rendering will not pass outside of its parent Window area.

Returns
  • true if the window will be clipped by its parent Window.
  • false if the windows rendering may pass outside its parents area
bool CEGUI::Window::isDestroyedByParent ( void  ) const
inline

returns whether or not this Window is set to be destroyed when its parent window is destroyed.

Returns
  • true if the Window will be destroyed when its parent is destroyed.
  • false if the Window will remain when its parent is destroyed.
bool CEGUI::Window::isDisabled ( bool  localOnly = false) const

return whether the Window is currently disabled

Parameters
localOnlyStates whether to only return the state set for this window, and not to factor in inherited state from ancestor windows.
Returns
  • true if the window is disabled.
  • false if the window is enabled.
bool CEGUI::Window::isDragDropTarget ( ) const

Returns whether this Window object will receive events generated by the drag and drop support in the system.

Returns
  • true if the Window is enabled as a drag and drop target.
  • false if the window is not enabled as a drag and drop target.
virtual bool CEGUI::Window::isHit ( const Vector2 position,
const bool  allow_disabled = false 
) const
virtual

check if the given pixel position would hit this window.

Parameters
positionVector2 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 in CEGUI::FrameWindow, and CEGUI::Combobox.

Referenced by CEGUI::FrameWindow::isHit().

bool CEGUI::Window::isMouseAutoRepeatEnabled ( void  ) const

Return whether mouse button down event autorepeat is enabled for this window.

Returns
  • true if autorepeat of mouse button down events is enabled for this window.
  • false if autorepeat of mouse button down events is not enabled for this window.
bool CEGUI::Window::isMousePassThroughEnabled ( void  ) const
inline

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.

Returns
true if mouse pass through is enabled. false if mouse pass through is not enabled.
bool CEGUI::Window::isNonClientWindow ( ) const

Return whether the Window is a non-client window.

A non-client window is clipped, positioned and sized according to the
parent window's full area as opposed to just the inner rect area used
for normal client windows.
Returns
  • true if the window should is clipped, positioned and sized according to the full area rectangle of it's parent.
  • false if the window is be clipped, positioned and sized according to the inner rect area of it's parent.
bool CEGUI::Window::isRiseOnClickEnabled ( void  ) const
inline

Return whether this window will rise to the top of the z-order when clicked with the left mouse button.

Note
This is distinguished from the is/setZOrderingEnabled setting in that if rise on click is disabled it only affects the users ability to affect the z order of the Window by clicking the mouse; is still possible to programatically alter the Window z-order by calling the moveToFront or moveToBack member functions. Whereas if z ordering is disabled the functions moveToFront and moveToBack are also precluded from affecting the Window z position.
Returns
  • true if the window will come to the top of other windows when the left mouse button is pushed within its area.
  • false if the window does not change z-order position when the left mouse button is pushed within its area.
bool CEGUI::Window::isTopOfZOrder ( ) const
protected

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

Returns
  • true if the Window is at the top of the z-order in relation to sibling windows with the same 'always on top' setting.
  • false if the Window is not at the top of the z-order in relation to sibling windows with the same 'always on top' setting.
bool CEGUI::Window::isUserStringDefined ( const String name) const

Return whether a user string with the specified name exists.

Parameters
nameString object holding the name of the string to be checked.
Returns
  • true if a user string named name exists.
  • false if no such user string exists.
bool CEGUI::Window::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.

Returns
bool CEGUI::Window::isUsingDefaultTooltip ( void  ) const

Return whether this Window is using the system default Tooltip for its Tooltip window.

Returns
  • true if the Window will use the system default tooltip.
  • false if the window has a custom Tooltip object.
bool CEGUI::Window::isVisible ( bool  localOnly = false) const

return true if the Window is currently visible.

When true is returned from this function does not mean that the window
is not completely obscured by other windows, just that the window will
be processed when rendering, and is not explicitly marked as hidden.
Parameters
localOnlyStates whether to only return the state set for this window, and not to factor in inherited state from ancestor windows.
Returns
  • true if the window will be drawn.
  • false if the window is hidden and therefore ignored when rendering.
bool CEGUI::Window::isZOrderingEnabled ( void  ) const

Return whether z-order changes are enabled or disabled for this Window.

Note
This is distinguished from the is/setRiseOnClickEnabled setting in that if rise on click is disabled it only affects the users ability to affect the z order of the Window by clicking the mouse; is still possible to programatically alter the Window z-order by calling the moveToFront or moveToBack member functions. Whereas if z ordering is disabled the functions moveToFront and moveToBack are also precluded from affecting the Window z position.
Returns
  • true if z-order changes are enabled for this window. moveToFront/moveToBack work normally as expected.
  • false: z-order changes are disabled for this window. moveToFront/moveToBack are ignored for this window.
void CEGUI::Window::moveToBack ( )

Move the Window to the bottom of the Z order.

- If the window is non always-on-top the Window is sent to the very
  bottom of its sibling windows and the process repeated for all
  ancestors.
- If the window is always-on-top, the Window is sent to the bottom of
  all sibling always-on-top windows and the process repeated for all
  ancestors.
Returns
Nothing
void CEGUI::Window::moveToFront ( )

Move the Window to the top of the z order.

- If the Window is a non always-on-top window it is moved the the top of
  all other non always-on-top sibling windows, and the process repeated
  for all ancestors.
- If the Window is an always-on-top window it is moved to the of of all
  sibling Windows, and the process repeated for all ancestors.
Returns
Nothing
virtual bool CEGUI::Window::moveToFront_impl ( bool  wasClicked)
protectedvirtual

Implements move to front behavior.

Returns
Should return true if some action was taken, or false if there was nothing to be done.
void CEGUI::Window::notifyScreenAreaChanged ( bool  recursive = true)

Inform the window, and optionally all children, that screen area rectangles have changed.

Parameters
recursive
  • true to recursively call notifyScreenAreaChanged on attached child Window objects.
  • false to just process this Window.
virtual void CEGUI::Window::onActivated ( ActivationEventArgs e)
protectedvirtual

Handler called when this window has become the active window.

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

Reimplemented in CEGUI::Combobox, CEGUI::FrameWindow, CEGUI::Spinner, and CEGUI::ComboDropList.

virtual void CEGUI::Window::onAlphaChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's alpha blend value is changed.

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

Reimplemented in CEGUI::DragContainer, and CEGUI::PopupMenu.

virtual void CEGUI::Window::onAlwaysOnTopChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's always-on-top setting is changed.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onCaptureGained ( WindowEventArgs e)
protectedvirtual

Handler called when this window gains capture of mouse inputs.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onCaptureLost ( WindowEventArgs e)
protectedvirtual

Handler called when this window loses capture of mouse inputs.

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

Reimplemented in CEGUI::FrameWindow, CEGUI::MultiLineEditbox, CEGUI::Editbox, CEGUI::ListHeaderSegment, CEGUI::DragContainer, CEGUI::Thumb, CEGUI::ComboDropList, CEGUI::MenuItem, CEGUI::Titlebar, and CEGUI::ButtonBase.

virtual void CEGUI::Window::onCharacter ( KeyEventArgs e)
protectedvirtual

Handler called when a character-key has been pressed while this window has input focus.

Parameters
eKeyEventArgs object whose 'codepoint' field is set to the Unicode code point (encoded as utf32) for the character typed, and whose 'sysKeys' field represents the combination of SystemKey that were active when the event was generated. All other fields should be considered as 'junk'.

Reimplemented in CEGUI::MultiLineEditbox, and CEGUI::Editbox.

virtual void CEGUI::Window::onChildAdded ( WindowEventArgs e)
protectedvirtual

Handler called when a child window is added to this window.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that has been added.

Reimplemented in CEGUI::ScrolledContainer.

virtual void CEGUI::Window::onChildRemoved ( WindowEventArgs e)
protectedvirtual

Handler called when a child window is removed from this window.

Parameters
eWindowEventArgs object whose 'window' pointer field is set the window that has been removed.

Reimplemented in CEGUI::ScrolledContainer, and CEGUI::MenuBase.

virtual void CEGUI::Window::onClippingChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's setting for being clipped by it's parent is changed.

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

Reimplemented in CEGUI::DragContainer.

virtual void CEGUI::Window::onDeactivated ( ActivationEventArgs e)
protectedvirtual

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

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

Reimplemented in CEGUI::FrameWindow.

virtual void CEGUI::Window::onDestructionStarted ( WindowEventArgs e)
protectedvirtual

Handler called when this window's destruction sequence has begun.

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

Reimplemented in CEGUI::PopupMenu.

virtual void CEGUI::Window::onDisabled ( WindowEventArgs e)
protectedvirtual

Handler called when the window is disabled.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onDragDropItemDropped ( DragDropEventArgs e)
protectedvirtual

Handler called when a DragContainer is dragged over this window.

Parameters
eDragDropEventArgs object initialised as follows:
  • window field is normaly set to point to 'this' window.
  • dragDropItem is a pointer to a DragContainer window that triggered the event.
virtual void CEGUI::Window::onDragDropItemEnters ( DragDropEventArgs e)
protectedvirtual

Handler called when a DragContainer is dragged over this window.

Parameters
eDragDropEventArgs object initialised as follows:
  • window field is normaly set to point to 'this' window.
  • dragDropItem is a pointer to a DragContainer window that triggered the event.
virtual void CEGUI::Window::onDragDropItemLeaves ( DragDropEventArgs e)
protectedvirtual

Handler called when a DragContainer is dragged over this window.

Parameters
eDragDropEventArgs object initialised as follows:
  • window field is normaly set to point to 'this' window.
  • dragDropItem is a pointer to a DragContainer window that triggered the event.
virtual void CEGUI::Window::onEnabled ( WindowEventArgs e)
protectedvirtual

Handler called when the window is enabled.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onFontChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's font is changed.

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

Reimplemented in CEGUI::MultiColumnList, CEGUI::Combobox, CEGUI::TabControl, CEGUI::Spinner, and CEGUI::Titlebar.

virtual void CEGUI::Window::onHidden ( WindowEventArgs e)
protectedvirtual

Handler called when the window is hidden.

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

Reimplemented in CEGUI::PopupMenu.

virtual void CEGUI::Window::onHorizontalAlignmentChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the horizontal alignment setting for the window is changed.

Parameters
eWindowEventArgs object initialised as follows:
  • window field is set to point to the Window object whos alignment has changed (typically 'this').
virtual void CEGUI::Window::onIDChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's client assigned ID is changed.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onInheritsAlphaChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's setting for inheriting alpha-blending is changed.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onKeyDown ( KeyEventArgs e)
protectedvirtual

Handler called when a key as been depressed while this window has input focus.

Parameters
eKeyEventArgs object whose 'scancode' field is set to the Key::Scan value representing the key that was pressed, and whose 'sysKeys' field represents the combination of SystemKey that were active when the event was generated.

Reimplemented in CEGUI::MultiLineEditbox, CEGUI::Editbox, and CEGUI::ItemListbox.

virtual void CEGUI::Window::onKeyUp ( KeyEventArgs e)
protectedvirtual

Handler called when a key as been released while this window has input focus.

Parameters
eKeyEventArgs object whose 'scancode' field is set to the Key::Scan value representing the key that was released, and whose 'sysKeys' field represents the combination of SystemKey that were active when the event was generated. All other fields should be considered as 'junk'.
virtual void CEGUI::Window::onMouseButtonDown ( MouseEventArgs e)
protectedvirtual
virtual void CEGUI::Window::onMouseButtonUp ( MouseEventArgs e)
protectedvirtual
virtual void CEGUI::Window::onMouseClicked ( MouseEventArgs e)
protectedvirtual

Handler called when a mouse button has been clicked (that is depressed and then released, within a specified time) within this window's area.

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::ItemEntry.

virtual void CEGUI::Window::onMouseDoubleClicked ( MouseEventArgs e)
protectedvirtual

Handler called when a mouse button has been double-clicked within this window's area.

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::MultiLineEditbox, CEGUI::Editbox, CEGUI::ListHeaderSegment, and CEGUI::Titlebar.

virtual void CEGUI::Window::onMouseEnters ( MouseEventArgs e)
protectedvirtual

Handler called when the mouse cursor has entered this window's area.

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::Tooltip.

virtual void CEGUI::Window::onMouseLeaves ( MouseEventArgs e)
protectedvirtual

Handler called when the mouse cursor has left this window's area.

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::ListHeaderSegment, CEGUI::MenuItem, and CEGUI::ButtonBase.

virtual void CEGUI::Window::onMouseMove ( MouseEventArgs e)
protectedvirtual

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

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::Tree, CEGUI::Listbox, CEGUI::MultiLineEditbox, CEGUI::FrameWindow, CEGUI::Editbox, CEGUI::ListHeaderSegment, CEGUI::DragContainer, CEGUI::Thumb, CEGUI::ComboDropList, CEGUI::MenuItem, CEGUI::TabButton, CEGUI::Titlebar, CEGUI::GUISheet, and CEGUI::ButtonBase.

virtual void CEGUI::Window::onMouseTripleClicked ( MouseEventArgs e)
protectedvirtual

Handler called when a mouse button has been triple-clicked within this window's area.

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::MultiLineEditbox, and CEGUI::Editbox.

virtual void CEGUI::Window::onMouseWheel ( MouseEventArgs e)
protectedvirtual

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

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::MultiColumnList, CEGUI::Tree, CEGUI::Listbox, CEGUI::MultiLineEditbox, CEGUI::ScrollablePane, CEGUI::Scrollbar, CEGUI::Slider, CEGUI::ScrolledItemListBase, CEGUI::TabButton, and CEGUI::GUISheet.

virtual void CEGUI::Window::onMoved ( WindowEventArgs e)
protectedvirtual

Handler called when the window's position changes.

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

Reimplemented in CEGUI::DragContainer.

virtual void CEGUI::Window::onNonClientChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's non-client setting, affecting it's position and size relative to it's parent is changed.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onParentDestroyChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's setting for being destroyed automatically be it's parent is changed.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onParentSized ( WindowEventArgs e)
protectedvirtual

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.

Parameters
eWindowEventArgs object whose 'window' pointer field is set the the window that caused the event; this is typically either this window's parent window, or NULL to indicate the screen size has changed.

Reimplemented in CEGUI::ItemListBase, and CEGUI::ScrolledContainer.

virtual void CEGUI::Window::onRenderingEnded ( WindowEventArgs e)
protectedvirtual

Handler called when rendering for this window has ended.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onRenderingStarted ( WindowEventArgs e)
protectedvirtual

Handler called when rendering for this window has started.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onRotated ( WindowEventArgs e)
protectedvirtual

Handler called when the window's rotation factor is changed.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::onShown ( WindowEventArgs e)
protectedvirtual

Handler called when the window is shown (made visible).

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

Reimplemented in CEGUI::PopupMenu.

virtual void CEGUI::Window::onSized ( WindowEventArgs e)
protectedvirtual

Handler called when the window's size changes.

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

Reimplemented in CEGUI::MultiColumnList, CEGUI::Tree, CEGUI::Listbox, CEGUI::MultiLineEditbox, and CEGUI::ScrollablePane.

virtual void CEGUI::Window::onTextChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's text is changed.

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

Reimplemented in CEGUI::Combobox, CEGUI::MultiLineEditbox, CEGUI::FrameWindow, CEGUI::Editbox, CEGUI::Tooltip, CEGUI::Spinner, and CEGUI::MenuItem.

virtual void CEGUI::Window::onVerticalAlignmentChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the vertical alignment setting for the window is changed.

Parameters
eWindowEventArgs object initialised as follows:
  • window field is set to point to the Window object whos alignment has changed (typically 'this').
virtual void CEGUI::Window::onWindowRendererAttached ( WindowEventArgs e)
protectedvirtual

Handler called when a new window renderer object is attached.

Parameters
eWindowEventArgs object initialised as follows:
  • window field is set to point to the Window object that just got a new window renderer attached. (typically 'this').
virtual void CEGUI::Window::onWindowRendererDetached ( WindowEventArgs e)
protectedvirtual

Handler called when the currently attached window renderer object is detached.

Parameters
eWindowEventArgs object initialised as follows:
  • window field is set to point to the Window object that just got lost its window renderer. (typically 'this').
virtual void CEGUI::Window::onZChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the z-order position of this window has changed.

Parameters
eWindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.
virtual void CEGUI::Window::performChildWindowLayout ( )
virtual

method called to perform extended laying out of attached child windows.

The system may call this at various times (like when it is resized for
example), and it may be invoked directly where required.
Returns
Nothing.

Reimplemented in CEGUI::TabControl, and CEGUI::ItemListBase.

virtual void CEGUI::Window::populateGeometryBuffer ( )
inlineprotectedvirtual

Update the rendering cache.

Populates the Window's GeometryBuffer ready for rendering.

Reimplemented in CEGUI::Tree.

void CEGUI::Window::queueGeometry ( const RenderingContext ctx)
protected

Perform drawing operations concerned with positioning, clipping and queueing of window geometry to RenderingSurfaces.

Note
This function is a sub-function of drawSelf and is provided to make it easier to override drawSelf without needing to duplicate large sections of the code from the default implementation.
void CEGUI::Window::releaseInput ( void  )

Releases input capture from this Window. If this Window does not have inputs captured, nothing happens.

Returns
Nothing
void CEGUI::Window::removeChildWindow ( const String name)

Remove the named Window from this windows child list.

Parameters
nameString object holding the name of the Window to be removed. If the Window specified is not attached to this Window, nothing happens.
Returns
Nothing.
void CEGUI::Window::removeChildWindow ( Window window)

Remove the specified Window form this windows child list.

Parameters
windowPointer to the Window object to be removed. If the window is not attached to this Window, then nothing happens.
Returns
Nothing.
void CEGUI::Window::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.

Parameters
IDID number assigned to the Window to be removed. If no Window with ID code ID is attached, nothing happens.
Returns
Nothing.
void CEGUI::Window::removeWindowFromDrawList ( const Window wnd)
protected

Removes the window from the drawing list. If the window is not attached to the drawing list then nothing happens.

Parameters
wndWindow object to be removed from the drawing list.
Returns
Nothing.
void CEGUI::Window::rename ( const String new_name)

Renames the window.

Parameters
new_nameString object holding the new name for the window.
Exceptions
AlreadyExistsExceptionthrown if a Window named new_name already exists in the system.
void CEGUI::Window::render ( )

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

Returns
Nothing
bool CEGUI::Window::restoresOldCapture ( void  ) const
inline

Return whether this window is set to restore old input capture when it loses input capture.

This is only really useful for certain sub-components for widget
writers.
Returns
  • true if the window will restore the previous capture window when it loses input capture.
  • false if the window will set the capture window to NULL when it loses input capture (this is the default behaviour).
void CEGUI::Window::setAlpha ( float  alpha)

Set the current alpha value for this window.

Note
The alpha value set for any given window may or may not be the final alpha value that is used when rendering. All window objects, by default, inherit alpha from thier parent window(s) - this will blend child windows, relatively, down the line of inheritance. This behaviour can be overridden via the setInheritsAlpha() method. To return the true alpha value that will be applied when rendering, use the getEffectiveAlpha() method.
Parameters
alphaThe new alpha value for the window. Value should be between 0.0f and 1.0f.
Returns
Nothing
void CEGUI::Window::setAlwaysOnTop ( bool  setting)

Set whether this window is always on top, or not.

Parameters
setting
  • true to have the Window appear on top of all other non always on top windows
  • false to allow the window to be covered by other normal windows.
Returns
Nothing
void CEGUI::Window::setArea ( const UDim xpos,
const UDim ypos,
const UDim width,
const UDim height 
)

Set the window area.

Sets the area occupied by this window.  The defined area is offset from
the top-left corner of this windows parent window or from the top-left
corner of the display if this window has no parent (i.e. it is the root
window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
xposUDim describing the new x co-ordinate (left edge) of the window area.
yposUDim describing the new y co-ordinate (top-edge) of the window area.
widthUDim describing the new width of the window area.
heightUDim describing the new height of the window area.
void CEGUI::Window::setArea ( const UVector2 pos,
const UVector2 size 
)

Set the window area.

Sets the area occupied by this window.  The defined area is offset from
the top-left corner of this windows parent window or from the top-left
corner of the display if this window has no parent (i.e. it is the root
window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
posUVector2 describing the new position (top-left corner) of the window area.
sizeUVector2 describing the new size of the window area.
void CEGUI::Window::setArea ( const URect area)

Set the window area.

Sets the area occupied by this window.  The defined area is offset from
the top-left corner of this windows parent window or from the top-left
corner of the display if this window has no parent (i.e. it is the root
window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
areaURect describing the new area rectangle of the window area.
void CEGUI::Window::setArea_impl ( const UVector2 pos,
const UVector2 size,
bool  topLeftSizing = false,
bool  fireEvents = true 
)
protected

Implementation method to modify window area while correctly applying min / max size processing, and firing any appropriate events.

/note This is the implementation function for setting size and position. In order to simplify area management, from this point on, all modifications to window size and position (area rect) should come through here.

/param pos UVector2 object describing the new area position.

/param size UVector2 object describing the new area size.

/param topLeftSizing

  • true to indicate the the operation is a sizing operation on the top and/or left edges of the area, and so window movement should be inhibited if size is at max or min.
  • false to indicate the operation is not a strict sizing operation on the top and/or left edges and that the window position may change as required

/param fireEvents

  • true if events should be fired as normal.
  • false to inhibit firing of events (required, for example, if you need to call this from the onSize/onMove handlers).
void CEGUI::Window::setAutoRepeatDelay ( float  delay)

Set the current auto-repeat delay setting for this window.

Parameters
delayfloat value indicating the delay, in seconds, defore the first repeat mouse button down event should be triggered when autorepeat is enabled.
Returns
Nothing.
void CEGUI::Window::setAutoRepeatRate ( float  rate)

Set the current auto-repeat rate setting for this window.

Parameters
ratefloat value indicating the rate, in seconds, at which repeat mouse button down events should be generated after the initial delay has expired.
Returns
Nothing.
void CEGUI::Window::setClippedByParent ( bool  setting)

Set whether this Window will be clipped by its parent window(s).

Parameters
setting
  • true to have the Window clipped so that rendering is constrained to within the area of its parent(s).
  • false to have rendering constrained to the screen only.
Returns
Nothing
void CEGUI::Window::setDestroyedByParent ( bool  setting)

Set whether or not this Window will automatically be destroyed when its parent Window is destroyed.

Parameters
setting
  • true to have the Window auto-destroyed when its parent is destroyed (default behaviour)
  • false to have the Window remain after its parent is destroyed.
Returns
Nothing
void CEGUI::Window::setDistributesCapturedInputs ( bool  setting)

Set whether the window wants inputs passed to its attached child windows when the window has inputs captured.

Parameters
setting
  • true if System should pass captured input events to child windows.
  • false if System should pass captured input events to this window only.
void CEGUI::Window::setDragDropTarget ( bool  setting)

Specifies whether this Window object will receive events generated by the drag and drop support in the system.

Parameters
setting
  • true to enable the Window as a drag and drop target.
  • false to disable the Window as a drag and drop target.
void CEGUI::Window::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.

Parameters
setting
Returns
Nothing
void CEGUI::Window::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.

Parameters
typeNew look'n'feel of the widget
typeNew renderer of the widget
void CEGUI::Window::setFont ( Font font)

Set the font used by this Window.

Parameters
fontPointer to the Font object to be used by this Window. If font is NULL, the default font will be used.
Returns
Nothing
void CEGUI::Window::setFont ( const String name)

Set the font used by this Window.

Parameters
nameString object holding the name of the Font object to be used by this Window. If name == "", the default font will be used.
Returns
Nothing
Exceptions
UnknownObjectExceptionthrown if the specified Font is unknown within the system.
void CEGUI::Window::setHeight ( const UDim height)

Set the window's height.

Sets the height of the area occupied by this window.
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
heightUDim describing the new height of the window area.
void CEGUI::Window::setHorizontalAlignment ( const HorizontalAlignment  alignment)

Set the horizontal alignment.

Modifies the horizontal alignment for the window.  This setting affects
how the windows position is interpreted relative to its parent.
Parameters
alignmentOne of the HorizontalAlignment enumerated values.
Returns
Nothing.
void CEGUI::Window::setID ( uint  ID)

Set the current ID for the Window.

Parameters
IDClient assigned ID code for this Window. The GUI system assigns no meaning to any IDs, they are a device purely for client code usage.
Returns
Nothing
void CEGUI::Window::setInheritsAlpha ( bool  setting)

Sets whether this Window will inherit alpha from its parent windows.

Parameters
setting
  • true if the Window should use inherited alpha.
  • false if the Window should have an independant alpha value.
Returns
Nothing
void CEGUI::Window::setInheritsTooltipText ( bool  setting)

Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set.

Parameters
setting
  • true if the window should inherit tooltip text from its parent when its own text is not set.
  • false if the window should not inherit tooltip text from its parent (and so show no tooltip when no text is set).
Returns
Nothing.
virtual void CEGUI::Window::setLookNFeel ( const String look)
virtual

Set the LookNFeel that shoule be used for this window.

Parameters
lookString object holding the name of the look to be assigned to the window.
Returns
Nothing.
Exceptions
UnknownObjectExceptionthrown if the look'n'feel specified by look does not exist.
Note
Once a look'n'feel has been assigned it is locked - as in cannot be changed.

Reimplemented in CEGUI::Tree.

void CEGUI::Window::setMaxSize ( const UVector2 size)

Set the window's maximum size.

Sets the maximum size that this windows area may occupy (whether size
changes occur by user interaction, general system operation, or by
direct setting by client code).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
sizeUVector2 describing the new maximum size of the window area.
void CEGUI::Window::setMinSize ( const UVector2 size)

Set the window's minimum size.

Sets the minimum size that this windows area may occupy (whether size
changes occur by user interaction, general system operation, or by
direct setting by client code).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
sizeUVector2 describing the new minimum size of the window area.
void CEGUI::Window::setModalState ( bool  state)

Set the modal state for this Window.

Parameters
stateBoolean value defining if this Window should be the modal target.
  • true if this Window should be activated and set as the modal target.
  • false if the modal target should be cleared if this Window is currently the modal target.
Returns
Nothing.
void CEGUI::Window::setMouseAutoRepeatEnabled ( bool  setting)

Set whether mouse button down event autorepeat is enabled for this window.

Parameters
setting
  • true to enable autorepeat of mouse button down events.
  • false to disable autorepeat of mouse button down events.
Returns
Nothing.
void CEGUI::Window::setMouseCursor ( const Image image)
inline

Set the mouse cursor image to be used when the mouse enters this window.

Parameters
imagePointer to the Image object to use as the mouse cursor image when the mouse enters the area for this Window.
Returns
Nothing.
void CEGUI::Window::setMouseCursor ( MouseCursorImage  image)
inline

Set the mouse cursor image to be used when the mouse enters this window.

Parameters
imageOne of the MouseCursorImage enumerated values.
Returns
Nothing.
void CEGUI::Window::setMouseCursor ( const String imageset,
const String image_name 
)

Set the mouse cursor image to be used when the mouse enters this window.

Parameters
imagesetString object that contains the name of the Imageset that contains the image to be used.
image_nameString object that contains the name of the Image on imageset that is to be used.
Returns
Nothing.
Exceptions
UnknownObjectExceptionthrown if imageset is not known, or if imageset contains no Image named image_name.
void CEGUI::Window::setMousePassThroughEnabled ( bool  setting)
inline

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.

Parameters
settingtrue if mouse pass through is enabled. false if mouse pass through is not enabled.
void CEGUI::Window::setNonClientWindow ( const bool  setting)

Set whether the Window is a non-client window.

A non-client window is clipped, positioned and sized according to the
parent window's full area as opposed to just the inner rect area used
for normal client windows.
Parameters
setting
  • true if the window should be clipped, positioned and sized according to the full area rectangle of it's parent.
  • false if the window should be clipped, positioned and sized according to the inner rect area of it's parent.
void CEGUI::Window::setParent ( Window parent)
protected

Set the parent window for this window object.

Parameters
parentPointer to a Window object that is to be assigned as the parent to this Window.
Returns
Nothing
void CEGUI::Window::setPosition ( const UVector2 pos)

Set the window's position.

Sets the position of the area occupied by this window.  The position is
offset from the top-left corner of this windows parent window or from
the top-left corner of the display if this window has no parent
(i.e. it is the root window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
posUVector2 describing the new position (top-left corner) of the window area.
void CEGUI::Window::setRenderingSurface ( RenderingSurface surface)

Set the RenderingSurface to be associated with this Window, or 0 if none is required.

If this function is called, and the option for automatic use of an imagery caching RenderingSurface is enabled, any automatically created RenderingSurface will be released, and the affore mentioned option will be disabled.
If after having set a custom RenderingSurface you then subsequently enable the automatic use of an imagery caching RenderingSurface by calling setUsingAutoRenderingSurface, the previously set RenderingSurface will be disassociated from the Window. Note that the previous RenderingSurface is not destroyed or cleaned up at all - this is the job of whoever created that object initially.
Parameters
targetPointer to the RenderingSurface object to be associated with the window.
void CEGUI::Window::setRestoreCapture ( bool  setting)

Set whether this window will remember and restore the previous window that had inputs captured.

Parameters
setting
  • true: The window will remember and restore the previous capture window. The CaptureLost event is not fired on the previous window when this window steals input capture. When this window releases capture, the old capture window is silently restored.
  • false: Input capture works as normal, each window losing capture is signalled via CaptureLost, and upon the final release of capture, no previous setting is restored (this is the default behaviour).
Returns
Nothing
void CEGUI::Window::setRiseOnClickEnabled ( bool  setting)
inline

Set whether this window will rise to the top of the z-order when clicked with the left mouse button.

Note
This is distinguished from the is/setZOrderingEnabled setting in that if rise on click is disabled it only affects the users ability to affect the z order of the Window by clicking the mouse; is still possible to programatically alter the Window z-order by calling the moveToFront or moveToBack member functions. Whereas if z ordering is disabled the functions moveToFront and moveToBack are also precluded from affecting the Window z position.
Parameters
setting
  • true if the window should come to the top of other windows when the left mouse button is pushed within its area.
  • false if the window should not change z-order position when the left mouse button is pushed within its area.
Returns
Nothing.
void CEGUI::Window::setSize ( const UVector2 size)

Set the window's size.

Sets the size of the area occupied by this window.
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
sizeUVector2 describing the new size of the window area.
void CEGUI::Window::setText ( const String text)

Set the current text string for the Window.

Parameters
textString object containing the text that is to be set as the Window text.
Returns
Nothing
void CEGUI::Window::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.

Parameters
tooltipPointer to a valid Tooltip based object which should be used as the tooltip for this Window, or 0 to indicate that the Window should use the system default Tooltip object. Note that when passing a pointer to a Tooltip object, ownership of the Tooltip does not pass to this Window object.
Returns
Nothing.
void CEGUI::Window::setTooltipText ( const String tip)

Set the tooltip text for this window.

Parameters
tipString object holding the text to be displayed in the tooltip for this Window.
Returns
Nothing.
void CEGUI::Window::setTooltipType ( const String tooltipType)

Set the custom Tooltip to be used by this Window by specifying a Window type.

The Window will internally attempt to create an instance of the
specified window type (which must be derived from the base Tooltip
class).  If the Tooltip creation fails, the error is logged and the
Window will revert to using either the existing custom Tooltip or the
system default Tooltip.
Parameters
tooltipTypeString object holding the name of the Tooltip based Window type which should be used as the Tooltip for this Window.
Returns
Nothing.
void CEGUI::Window::setUserData ( void *  user_data)
inline

Set the user data set for this Window.

Each Window can have some client assigned data attached to it, this data
is not used by the GUI system in any way.  Interpretation of the data is
entirely application specific.
Parameters
user_datapointer to the user data that is to be set for this window.
Returns
Nothing.
void CEGUI::Window::setUserString ( const String name,
const String value 
)

Sets the value a named user string, creating it as required.

Parameters
nameString object holding the name of the string to be returned.
valueString object holding the value to be assigned to the user string.
Returns
Nothing.
void CEGUI::Window::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.

Note that this setting really only controls whether the Window automatically creates and manages the RenderingSurface, as opposed to the use of the RenderingSurface. If a RenderingSurfaceis set for the Window it will be used regardless of this setting.
Enabling this option will cause the Window to attempt to create a suitable RenderingSurface (which will actually be a RenderingWindow). If there is an existing RenderingSurface assocated with this Window, it will be removed as the Window's RenderingSurface but not destroyed; whoever created the RenderingSurface in the first place should take care of its destruction.
Disabling this option will cause any automatically created RenderingSurface to be released.
It is possible that the renderer in use may not support facilities for RenderingSurfaces that are suitable for full imagery caching. If this is the case, then calling getRenderingSurface after enabling this option will return 0. In these cases this option will still show as being 'enabled', this is because Window settings should not be influenced by capabilities the renderer in use; for example, this enables correct XML layouts to be written from a Window on a system that does not support such RenderingSurfaces, so that the layout will function as preferred on systems that do.
If this option is enabled, and the client subsequently assigns a different RenderingSurface to the Window, the existing automatically created RenderingSurface will be released and this setting will be disabled.
Parameters
setting
void CEGUI::Window::setVerticalAlignment ( const VerticalAlignment  alignment)

Set the vertical alignment.

Modifies the vertical alignment for the window.  This setting affects
how the windows position is interpreted relative to its parent.
Parameters
alignmentOne of the VerticalAlignment enumerated values.
Returns
Nothing.
void CEGUI::Window::setVisible ( bool  setting)

Set whether the Window is visible or hidden.

Parameters
setting
  • true to make the Window visible.
  • false to make the Window hidden.
Note
Hiding the active window will cause that window to become deactivated. Showing a window does not, however, automatically cause that window to become the active window (call Window::activate after making the window visible to activate it).
Returns
Nothing
void CEGUI::Window::setWantsMultiClickEvents ( bool  setting)

Set whether this window will receive multi-click events or multiple 'down' events instead.

Parameters
setting
  • true if the Window will receive double-click and triple-click events.
  • false if the Window will receive multiple mouse button down events instead of double/triple click events.
Returns
Nothing.
void CEGUI::Window::setWidth ( const UDim width)

Set the window's width.

Sets the width of the area occupied by this window.
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
widthUDim describing the new width of the window area.
void CEGUI::Window::setWindowRenderer ( const String name)

Assign the WindowRenderer to specify the Look'N'Feel specification to be used.

Parameters
nameThe factory name of the WindowRenderer to use.
Note
Once a window renderer has been assigned it is locked - as in cannot be changed.
void CEGUI::Window::setXPosition ( const UDim x)

Set the window's X position.

Sets the x position (left edge) of the area occupied by this window.
The position is offset from the left edge of this windows parent window
or from the left edge of the display if this window has no parent
(i.e. it is the root window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
xUDim describing the new x position of the window area.
void CEGUI::Window::setYPosition ( const UDim y)

Set the window's Y position.

Sets the y position (top edge) of the area occupied by this window.
The position is offset from the top edge of this windows parent window
or from the top edge of the display if this window has no parent
(i.e. it is the root window).
Note
This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
Parameters
yUDim describing the new y position of the window area.
void CEGUI::Window::setZOrderingEnabled ( bool  setting)

Set whether z-order changes are enabled or disabled for this Window.

Note
This is distinguished from the is/setRiseOnClickEnabled setting in that if rise on click is disabled it only affects the users ability to affect the z order of the Window by clicking the mouse; is still possible to programatically alter the Window z-order by calling the moveToFront or moveToBack member functions. Whereas if z ordering is disabled the functions moveToFront and moveToBack are also precluded from affecting the Window z position.
Parameters
setting
  • true if z-order changes are enabled for this window. moveToFront/moveToBack work normally as expected.
  • false: z-order changes are disabled for this window. moveToFront/moveToBack are ignored for this window.
Returns
Nothing.
void CEGUI::Window::show ( void  )
inline

show the Window.

Note
Showing a window does not automatically activate the window. If you want the window to also become active you will need to call the Window::activate member also.
Returns
Nothing
bool CEGUI::Window::testClassName ( const String class_name) const
inline

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

Parameters
class_nameThe class name that is to be checked.
Returns
true if this window was inherited from class_name. false if not.
virtual bool CEGUI::Window::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_nameThe class name that is to be checked.
Returns
true if this window was inherited from class_name. false if not.

Reimplemented in CEGUI::MultiColumnList, CEGUI::Combobox, CEGUI::ListHeader, CEGUI::Tree, CEGUI::Listbox, CEGUI::FrameWindow, CEGUI::MultiLineEditbox, CEGUI::Scrollbar, CEGUI::ItemListBase, CEGUI::ScrollablePane, CEGUI::Editbox, CEGUI::TabControl, CEGUI::ListHeaderSegment, CEGUI::Slider, CEGUI::DragContainer, CEGUI::Tooltip, CEGUI::Spinner, CEGUI::Thumb, CEGUI::MenuItem, CEGUI::ItemListbox, CEGUI::ItemEntry, CEGUI::PopupMenu, CEGUI::MenuBase, CEGUI::ProgressBar, CEGUI::ComboDropList, CEGUI::ScrolledItemListBase, CEGUI::RadioButton, CEGUI::ScrolledContainer, CEGUI::Checkbox, CEGUI::TabButton, CEGUI::Titlebar, CEGUI::ButtonBase, CEGUI::ClippedContainer, CEGUI::Menubar, CEGUI::PushButton, CEGUI::GroupBox, and CEGUI::GUISheet.

Referenced by CEGUI::GUISheet::testClassName_impl(), CEGUI::GroupBox::testClassName_impl(), CEGUI::ClippedContainer::testClassName_impl(), CEGUI::ButtonBase::testClassName_impl(), CEGUI::Titlebar::testClassName_impl(), CEGUI::ScrolledContainer::testClassName_impl(), CEGUI::ProgressBar::testClassName_impl(), CEGUI::ItemEntry::testClassName_impl(), CEGUI::Spinner::testClassName_impl(), CEGUI::Tooltip::testClassName_impl(), CEGUI::DragContainer::testClassName_impl(), CEGUI::Slider::testClassName_impl(), CEGUI::ListHeaderSegment::testClassName_impl(), CEGUI::TabControl::testClassName_impl(), CEGUI::Editbox::testClassName_impl(), CEGUI::ScrollablePane::testClassName_impl(), CEGUI::ItemListBase::testClassName_impl(), CEGUI::Scrollbar::testClassName_impl(), CEGUI::MultiLineEditbox::testClassName_impl(), CEGUI::FrameWindow::testClassName_impl(), CEGUI::Listbox::testClassName_impl(), CEGUI::Tree::testClassName_impl(), CEGUI::ListHeader::testClassName_impl(), CEGUI::Combobox::testClassName_impl(), and CEGUI::MultiColumnList::testClassName_impl().

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

Note
The update order is such that 'this' window is updated prior to any child windows, this is so that child windows that access the parent in their update code get the correct updated state.
Parameters
elapsedfloat value indicating the number of seconds passed since the last update.
Returns
Nothing.
virtual void CEGUI::Window::updateSelf ( float  elapsed)
protectedvirtual

Perform actual update processing for this Window.

Parameters
elapsedfloat value indicating the number of seconds elapsed since the last update call.
Returns
Nothing.

Reimplemented in CEGUI::Tooltip, and CEGUI::PopupMenu.

virtual bool CEGUI::Window::validateWindowRenderer ( const String name) const
protectedvirtual

Function used in checking if a WindowRenderer is valid for this window.

Returns
Returns true if the given WindowRenderer class name is valid for this window. False if not.

Reimplemented in CEGUI::MultiColumnList, CEGUI::ListHeader, CEGUI::Listbox, CEGUI::MultiLineEditbox, CEGUI::Scrollbar, CEGUI::ItemListBase, CEGUI::ScrollablePane, CEGUI::TabControl, CEGUI::Editbox, CEGUI::Slider, CEGUI::Tooltip, and CEGUI::ItemEntry.

bool CEGUI::Window::wantsMultiClickEvents ( void  ) const

Return whether this window will receive multi-click events or multiple 'down' events instead.

Returns
  • true if the Window will receive double-click and triple-click events.
  • false if the Window will receive multiple mouse button down events instead of double/triple click events.
virtual void CEGUI::Window::writeXMLToStream ( XMLSerializer xml_stream) const
virtual

Writes an xml representation of this window object to out_stream.

Parameters
xml_streamStream where xml data should be output.
Returns
Nothing.