Inheritance diagram for CEGUI::Window:
Public Member Functions | |
Window (const String &type, const String &name) | |
Constructor for Window base class. | |
virtual | ~Window (void) |
Destructor for Window base class. | |
const String & | getType (void) const |
return a String object holding the type name for this Window. | |
const String & | getName (void) const |
return a String object holding the name of this Window. | |
bool | isDestroyedByParent (void) const |
returns whether or not this Window is set to be destroyed when its parent is destroyed. | |
bool | isAlwaysOnTop (void) const |
returns whether or not this Window is an always on top (a.k.a 'topmost') Window. | |
bool | isDisabled (bool localOnly=false) const |
return true if the Window is currently disabled | |
bool | isVisible (bool localOnly=false) const |
return true if the Window is currently visible. | |
bool | isActive (void) const |
return true if this is the active Window (the window that receives inputs) | |
bool | isClippedByParent (void) const |
return true if this Window is clipped so that its rendering does not pass outside its parent windows area. | |
uint | getID (void) const |
return the ID code currently assigned to this Window by client code. | |
uint | getChildCount (void) const |
return the number of child Window objects currently attached to this Window. | |
bool | isChild (const String &name) const |
returns whether a Window with the specified name is currently attached to this Window as a child. | |
bool | isChild (uint ID) const |
returns whether at least one window with the given ID code is attached as a child. | |
bool | isChild (const Window *window) const |
return true if the given Window is a child of this window. | |
Window * | getChild (const String &name) const |
return a pointer to the child window with the specified name. | |
Window * | getChild (uint ID) const |
return a pointer to the first attached child window with the specified ID. | |
Window * | getChildAtIdx (uint idx) const |
return a pointer to the child window that is attached to 'this' at the given index. | |
Window * | getActiveChild (void) |
return a pointer to the Window that currently has input focus starting with this Window. | |
const Window * | getActiveChild (void) const |
bool | isAncestor (const String &name) const |
return true if the specified Window is some ancestor of this Window | |
bool | isAncestor (uint ID) const |
return true if any Window with the given ID is some ancestor of this Window. | |
bool | isAncestor (const Window *window) const |
return true if the specified Window is some ancestor of this Window. | |
const Font * | getFont (bool useDefault=true) const |
return the Font object active for the Window. | |
const String & | getText (void) const |
return the current text for the Window | |
bool | inheritsAlpha (void) const |
return true if the Window inherits alpha from its parent(s). | |
float | getAlpha (void) const |
return the current alpha value set for this Window | |
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. | |
Rect | getRect (void) const |
return a Rect object that describes the Window area. | |
virtual Rect | getPixelRect (void) const |
return a Rect object describing the Window area in screen space. | |
Rect | getInnerRect (void) const |
return a Rect object describing the clipped inner area for this window. | |
Rect | getUnclippedPixelRect (void) const |
return a Rect object describing the Window area unclipped, in screen space. | |
virtual Rect | getUnclippedInnerRect (void) const |
Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering. | |
bool | isCapturedByThis (void) const |
return true if this Window has input captured. | |
bool | isCapturedByAncestor (void) const |
return true if a child window has captured inputs. | |
bool | isCapturedByChild (void) const |
return true if an ancestor window has captured inputs. | |
virtual bool | isHit (const Point &position) const |
check if the given position would hit this window. | |
Window * | getChildAtPosition (const Point &position) const |
return the child Window that is 'hit' by the given position | |
MetricsMode | getMetricsMode (void) const |
return the current metrics mode employed by the Window | |
float | getXPosition (void) const |
return the x position of the window. Interpretation of return value depends upon the metric type in use by this window. | |
float | getYPosition (void) const |
return the y position of the window. Interpretation of return value depends upon the metric type in use by this window. | |
Point | getPosition (void) const |
return the position of the window. Interpretation of return value depends upon the metric type in use by this window. | |
float | getWidth (void) const |
return the width of the Window. Interpretation of return value depends upon the metric type in use by this window. | |
float | getHeight (void) const |
return the height of the Window. Interpretation of return value depends upon the metric type in use by this window. | |
Size | getSize (void) const |
return the size of the Window. Interpretation of return value depends upon the metric type in use by this window. | |
Window * | getParent (void) const |
return the parent of this Window. | |
Size | getMaximumSize (void) const |
Return the current maximum size for this window. | |
Size | getMinimumSize (void) const |
Return the current minimum size for this window. | |
const Image * | getMouseCursor (bool useDefault=true) const |
Return a pointer to the mouse cursor image to use when the mouse is within this window. | |
Rect | getRelativeRect (void) const |
Return the window area rect in relative metrics. | |
Point | getRelativePosition (void) const |
Return the window position in relative metrics. | |
float | getRelativeXPosition (void) const |
Return the window X position in relative metrics. | |
float | getRelativeYPosition (void) const |
Return the window Y position in relative metrics. | |
Size | getRelativeSize (void) const |
Return the window size in relative metrics. | |
float | getRelativeWidth (void) const |
Return the window width in relative metrics. | |
float | getRelativeHeight (void) const |
Return the window height in relative metrics. | |
Rect | getAbsoluteRect (void) const |
Return the window area rect in absolute metrics. | |
Point | getAbsolutePosition (void) const |
Return the window position in absolute metrics. | |
float | getAbsoluteXPosition (void) const |
Return the window X position in absolute metrics. | |
float | getAbsoluteYPosition (void) const |
Return the window Y position in absolute metrics. | |
Size | getAbsoluteSize (void) const |
Return the window size in absolute metrics. | |
float | getAbsoluteWidth (void) const |
Return the window width in absolute metrics. | |
float | getAbsoluteHeight (void) const |
Return the window height in absolute metrics. | |
void * | getUserData (void) const |
Return the user data set for this Window. | |
float | getXPosition (MetricsMode mode) const |
return the x position of the window using the specified metrics system. | |
float | getYPosition (MetricsMode mode) const |
return the y position of the window using the specified metrics system. | |
Point | getPosition (MetricsMode mode) const |
return the position of the window using the specified metrics system. | |
float | getWidth (MetricsMode mode) const |
return the width of the Window using the specified metrics system. | |
float | getHeight (MetricsMode mode) const |
return the height of the Window using the specified metrics system. | |
Size | getSize (MetricsMode mode) const |
return the size of the Window using the specified metrics system. | |
Rect | getRect (MetricsMode mode) const |
return a Rect object that describes the Window area using the specified metrics system. | |
bool | restoresOldCapture (void) const |
Return whether this window is set to restore old input capture when it loses input capture. | |
bool | isZOrderingEnabled (void) const |
Return whether z-order changes are enabled or disabled for this Window. | |
bool | wantsMultiClickEvents (void) const |
Return whether this window will receive multi-click events or multiple 'down' events instead. | |
bool | isMouseAutoRepeatEnabled (void) const |
Return whether mouse button down event autorepeat is enabled for this window. | |
float | getAutoRepeatDelay (void) const |
Return the current auto-repeat delay setting for this window. | |
float | getAutoRepeatRate (void) const |
Return the current auto-repeat rate setting for this window. | |
bool | distributesCapturedInputs (void) const |
Return whether the window wants inputs passed to its attached child windows when the window has inputs captured. | |
bool | isUsingDefaultTooltip (void) const |
Return whether this Window is using the system default Tooltip for its Tooltip window. | |
Tooltip * | getTooltip (void) const |
Return a pointer to the Tooltip object used by this Window. The value returned may point to the system default Tooltip, a custom Window specific Tooltip, or be NULL. | |
String | getTooltipType (void) const |
Return the custom tooltip type. | |
const String & | getTooltipText (void) const |
Return the current tooltip text set for this Window. | |
bool | inheritsTooltipText (void) const |
Return whether this window inherits Tooltip text from its parent when its own tooltip text is not set. | |
bool | isRiseOnClickEnabled (void) const |
Return whether this window will rise to the top of the z-order when clicked with the left mouse button. | |
bool | testClassName (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
VerticalAlignment | getVerticalAlignment () const |
Get the vertical alignment. | |
HorizontalAlignment | getHorizontalAlignment () const |
Get the horizontal alignment. | |
RenderCache & | getRenderCache () |
Return the RenderCache object for this Window. | |
const String & | getLookNFeel () |
Get the name of the LookNFeel assigned to this window. | |
bool | getModalState (void) const |
Get whether or not this Window is the modal target. | |
const String & | getUserString (const String &name) const |
Returns a named user string. | |
bool | isUserStringDefined (const String &name) const |
Return whether a user string with the specified name exists. | |
Window * | getActiveSibling () |
Returns the active sibling window. | |
void | rename (const String &new_name) |
Renames the window. | |
virtual void | initialise (void) |
Initialises the Window based object ready for use. | |
void | setDestroyedByParent (bool setting) |
Set whether or not this Window will automatically be destroyed when its parent Window is destroyed. | |
void | setAlwaysOnTop (bool setting) |
Set whether this window is always on top, or not. | |
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. | |
void | enable (void) |
enable the Window to allow interaction. | |
void | disable (void) |
disable the Window to prevent interaction. | |
void | setVisible (bool setting) |
Set whether the Window is visible or hidden. | |
void | show (void) |
show the Window | |
void | hide (void) |
hide the Window. | |
void | activate (void) |
Activate the Window giving it input focus and bringing it to the top of all non always-on-top Windows. | |
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. | |
void | setClippedByParent (bool setting) |
Set whether this Window will be clipped by its parent window(s). | |
void | setID (uint ID) |
Set the current ID for the Window. | |
void | setText (const String &text) |
Set the current text string for the Window. | |
void | setWidth (float width) |
Set the current width of the Window. Interpretation of the input value width is dependant upon the current metrics system set for the Window. | |
void | setHeight (float height) |
Set the current height of the Window. Interpretation of the input value height is dependant upon the current metrics system set for the Window. | |
void | setSize (const Size &size) |
Set the current size of the Window. Interpretation of the input value size is dependant upon the current metrics system set for the Window. | |
void | setXPosition (float x) |
Set the current 'x' position of the Window. Interpretation of the input value x is dependant upon the current metrics system set for the Window. | |
void | setYPosition (float y) |
Set the current 'y' position of the Window. Interpretation of the input value y is dependant upon the current metrics system set for the Window. | |
void | setPosition (const Point &position) |
Set the current position of the Window. Interpretation of the input value position is dependant upon the current metrics system set for the Window. | |
void | setAreaRect (const Rect &area) |
Set the current area for the Window, this allows for setting of position and size at the same time. Interpretation of the input value area is dependant upon the current metrics system set for the Window. | |
void | setFont (const Font *font) |
Set the font used by this Window. | |
void | setFont (const String &name) |
Set the font used by this Window. | |
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. | |
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. | |
void | removeChildWindow (const String &name) |
Remove the named Window from this windows child list. | |
void | removeChildWindow (Window *window) |
Remove the specified Window form this windows child list. | |
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. | |
void | moveToFront () |
Move the Window to the top of the z order. | |
void | moveToBack () |
Move the Window to the bottom of the Z order. | |
bool | captureInput (void) |
Captures input to this window. | |
void | releaseInput (void) |
Releases input capture from this Window. If this Window does not have inputs captured, nothing happens. | |
void | setRestoreCapture (bool setting) |
Set whether this window will remember and restore the previous window that had inputs captured. | |
void | setAlpha (float alpha) |
Set the current alpha value for this window. | |
void | setInheritsAlpha (bool setting) |
Sets whether this Window will inherit alpha from its parent windows. | |
void | requestRedraw (void) const |
Signal the System object to redraw (at least) this Window on the next render cycle. | |
void | setMetricsMode (MetricsMode mode) |
set the current metrics mode employed by the Window | |
void | setMinimumSize (const Size &sz) |
Set the minimum size for this window. | |
void | setMaximumSize (const Size &sz) |
Set the maximum size for this window. | |
void | setMouseCursor (const Image *image) |
Set the mouse cursor image to be used when the mouse enters this window. | |
void | setMouseCursor (MouseCursorImage image) |
Set the mouse cursor image to be used when the mouse enters this window. | |
void | setMouseCursor (const String &imageset, const String &image_name) |
Set the mouse cursor image to be used when the mouse enters this window. | |
void | setUserData (void *user_data) |
Set the user data set for this Window. | |
void | setXPosition (MetricsMode mode, float x) |
set the x position of the window using the specified metrics system. | |
void | setYPosition (MetricsMode mode, float y) |
set the y position of the window using the specified metrics system. | |
void | setPosition (MetricsMode mode, const Point &position) |
set the position of the window using the specified metrics system. | |
void | setWidth (MetricsMode mode, float width) |
set the width of the Window using the specified metrics system. | |
void | setHeight (MetricsMode mode, float height) |
set the height of the Window using the specified metrics system. | |
void | setSize (MetricsMode mode, const Size &size) |
set the size of the Window using the specified metrics system. | |
void | setRect (MetricsMode mode, const Rect &area) |
set the Rect that describes the Window area using the specified metrics system. | |
void | setZOrderingEnabled (bool setting) |
Set whether z-order changes are enabled or disabled for this Window. | |
void | setWantsMultiClickEvents (bool setting) |
Set whether this window will receive multi-click events or multiple 'down' events instead. | |
void | setMouseAutoRepeatEnabled (bool setting) |
Set whether mouse button down event autorepeat is enabled for this window. | |
void | setAutoRepeatDelay (float delay) |
Set the current auto-repeat delay setting for this window. | |
void | setAutoRepeatRate (float rate) |
Set the current auto-repeat rate setting for this window. | |
void | setDistributesCapturedInputs (bool setting) |
Set whether the window wants inputs passed to its attached child windows when the window has inputs captured. | |
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. | |
void | setTooltip (Tooltip *tooltip) |
Set the custom Tooltip object for this Window. This value may be NULL to indicate that the Window should use the system default Tooltip object. | |
void | setTooltipType (const String &tooltipType) |
Set the custom Tooltip to be used by this Window by specifying a Window type. | |
void | setTooltipText (const String &tip) |
Set the tooltip text for this window. | |
void | setInheritsTooltipText (bool setting) |
Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set. | |
void | setRiseOnClickEnabled (bool setting) |
Set whether this window will rise to the top of the z-order when clicked with the left mouse button. | |
void | setVerticalAlignment (const VerticalAlignment alignment) |
Set the vertical alignment. | |
void | setHorizontalAlignment (const HorizontalAlignment alignment) |
Set the horizontal alignment. | |
void | setLookNFeel (const String &falagardType, const String &look) |
Set the LookNFeel that shoule be used for this window. | |
void | setModalState (bool state) |
Set the modal state for this Window. | |
virtual void | performChildWindowLayout () |
method called to perform extended laying out of attached child windows. | |
void | setUserString (const String &name, const String &value) |
Sets the value a named user string, creating it as required. | |
float | absoluteToRelativeX (float val) const |
Convert the given X co-ordinate from absolute to relative metrics. | |
float | absoluteToRelativeY (float val) const |
Convert the given Y co-ordinate from absolute to relative metrics. | |
Point | absoluteToRelative (const Point &pt) const |
Convert the given position from absolute to relative metrics. | |
Size | absoluteToRelative (const Size &sze) const |
Convert the given size from absolute to relative metrics. | |
Rect | absoluteToRelative (const Rect &rect) const |
Convert the given area from absolute to relative metrics. | |
float | relativeToAbsoluteX (float val) const |
Convert the given X co-ordinate from relative to absolute metrics. | |
float | relativeToAbsoluteY (float val) const |
Convert the given Y co-ordinate from relative to absolute metrics. | |
Point | relativeToAbsolute (const Point &pt) const |
Convert the given position from relative to absolute metrics. | |
Size | relativeToAbsolute (const Size &sze) const |
Convert the given size from relative to absolute metrics. | |
Rect | relativeToAbsolute (const Rect &rect) const |
Convert the given area from relative to absolute metrics. | |
float | windowToScreenX (float x) const |
Convert a window co-ordinate value, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate. | |
float | windowToScreenY (float y) const |
Convert a window co-ordinate value, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate. | |
Point | windowToScreen (const Point &pt) const |
Convert a window co-ordinate position, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate position. | |
Size | windowToScreen (const Size &sze) const |
Convert a window size value, specified in whichever metrics mode is active, to a size in pixels. | |
Rect | windowToScreen (const Rect &rect) const |
Convert a window area, specified in whichever metrics mode is active, to a screen area. | |
float | screenToWindowX (float x) const |
Convert a screen relative pixel co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active. | |
float | screenToWindowY (float y) const |
Convert a screen relative pixel co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active. | |
Point | screenToWindow (const Point &pt) const |
Convert a screen relative pixel position to a window co-ordinate position, specified in whichever metrics mode is active. | |
Size | screenToWindow (const Size &sze) const |
Convert a pixel screen size to a window based size, specified in whichever metrics mode is active. | |
Rect | screenToWindow (const Rect &rect) const |
Convert a screen area to a window area, specified in whichever metrics mode is active. | |
float | unifiedToRelativeX (const UDim &val) const |
Convert the given X co-ordinate from unified to relative metrics. | |
float | unifiedToRelativeY (const UDim &val) const |
Convert the given Y co-ordinate from unified to relative metrics. | |
Vector2 | unifiedToRelative (const UVector2 &val) const |
Convert the given UVector2 value from unified to relative metrics. | |
Rect | unifiedToRelative (const URect &val) const |
Convert the given area from unfied to relative metrics. | |
float | unifiedToAbsoluteX (const UDim &val) const |
Convert the given X co-ordinate from unified to absolute metrics. | |
float | unifiedToAbsoluteY (const UDim &val) const |
Convert the given Y co-ordinate from unified to absolute metrics. | |
Vector2 | unifiedToAbsolute (const UVector2 &val) const |
Convert the given UVector2 value from unified to absolute metrics. | |
Rect | unifiedToAbsolute (const URect &val) const |
Convert the given area from unfied to absolute metrics. | |
float | windowToScreenX (const UDim &x) const |
Convert a window co-ordinate value, specified as a UDim, to a screen relative pixel co-ordinate. | |
float | windowToScreenY (const UDim &y) const |
Convert a window co-ordinate value, specified as a UDim, to a screen relative pixel co-ordinate. | |
Vector2 | windowToScreen (const UVector2 &vec) const |
Convert a window co-ordinate point, specified as a UVector2, to a screen relative pixel co-ordinate point. | |
Rect | windowToScreen (const URect &rect) const |
Convert a window area, specified as a URect, to a screen area. | |
float | screenToWindowX (const UDim &x) const |
Convert a screen relative UDim co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active. | |
float | screenToWindowY (const UDim &y) const |
Convert a screen relative UDim co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active. | |
Vector2 | screenToWindow (const UVector2 &vec) const |
Convert a screen relative UVector2 point to a window co-ordinate point, specified in whichever metrics mode is active. | |
Rect | screenToWindow (const URect &rect) const |
Convert a URect screen area to a window area, specified in whichever metrics mode is active. | |
void | setWindowArea (const UDim &xpos, const UDim &ypos, const UDim &width, const UDim &height) |
Set the window area. | |
void | setWindowArea (const UVector2 &pos, const UVector2 &size) |
Set the window area. | |
void | setWindowArea (const URect &area) |
Set the window area. | |
void | setWindowPosition (const UVector2 &pos) |
Set the window's position. | |
void | setWindowXPosition (const UDim &x) |
Set the window's X position. | |
void | setWindowYPosition (const UDim &y) |
Set the window's Y position. | |
void | setWindowSize (const UVector2 &size) |
Set the window's size. | |
void | setWindowWidth (const UDim &width) |
Set the window's width. | |
void | setWindowHeight (const UDim &height) |
Set the window's height. | |
void | setWindowMaxSize (const UVector2 &size) |
Set the window's maximum size. | |
void | setWindowMinSize (const UVector2 &size) |
Set the window's minimum size. | |
const URect & | getWindowArea () const |
Return the windows area. | |
const UVector2 & | getWindowPosition () const |
Get the window's position. | |
const UDim & | getWindowXPosition () const |
Get the window's X position. | |
const UDim & | getWindowYPosition () const |
Get the window's Y position. | |
UVector2 | getWindowSize () const |
Get the window's size. | |
UDim | getWindowWidth () const |
Get the window's width. | |
UDim | getWindowHeight () const |
Get the window's height. | |
const UVector2 & | getWindowMaxSize () const |
Get the window's maximum size. | |
const UVector2 & | getWindowMinSize () const |
Get the window's minimum size. | |
void | render (void) |
Causes the Window object to render itself and all of it's attached children. | |
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. | |
virtual void | writeXMLToStream (OutStream &out_stream) const |
Writes an xml representation of this window object to out_stream. | |
Static Public Member Functions | |
static Window * | getCaptureWindow (void) |
return the Window that currently has inputs captured. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
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 | EventMetricsModeChanged |
Active metrics mode has been modified. | |
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 | 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. | |
Protected Types | |
typedef std::vector< Window * > | ChildList |
typedef std::map< String, String > | UserStringMap |
Protected Member Functions | |
virtual void | onSized (WindowEventArgs &e) |
Handler called when the window's size changes. | |
virtual void | onMoved (WindowEventArgs &e) |
Handler called when the window's position changes. | |
virtual void | onTextChanged (WindowEventArgs &e) |
Handler called when the window's text is changed. | |
virtual void | onFontChanged (WindowEventArgs &e) |
Handler called when the window's font is changed. | |
virtual void | onAlphaChanged (WindowEventArgs &e) |
Handler called when the window's alpha blend value is changed. | |
virtual void | onIDChanged (WindowEventArgs &e) |
Handler called when the window's client assigned ID is changed. | |
virtual void | onShown (WindowEventArgs &e) |
Handler called when the window is shown (made visible). | |
virtual void | onHidden (WindowEventArgs &e) |
Handler called when the window is hidden. | |
virtual void | onEnabled (WindowEventArgs &e) |
Handler called when the window is enabled. | |
virtual void | onDisabled (WindowEventArgs &e) |
Handler called when the window is disabled. | |
virtual void | onMetricsChanged (WindowEventArgs &e) |
Handler called when the window's active metrics system is changed. | |
virtual void | onClippingChanged (WindowEventArgs &e) |
Handler called when the window's setting for being clipped by it's parent is changed. | |
virtual void | onParentDestroyChanged (WindowEventArgs &e) |
Handler called when the window's setting for being destroyed automatically be it's parent is changed. | |
virtual void | onInheritsAlphaChanged (WindowEventArgs &e) |
Handler called when the window's setting for inheriting alpha-blending is changed. | |
virtual void | onAlwaysOnTopChanged (WindowEventArgs &e) |
Handler called when the window's always-on-top setting is changed. | |
virtual void | onCaptureGained (WindowEventArgs &e) |
Handler called when this window gains capture of mouse inputs. | |
virtual void | onCaptureLost (WindowEventArgs &e) |
Handler called when this window loses capture of mouse inputs. | |
virtual void | onRenderingStarted (WindowEventArgs &e) |
Handler called when rendering for this window has started. | |
virtual void | onRenderingEnded (WindowEventArgs &e) |
Handler called when rendering for this window has ended. | |
virtual void | onZChanged (WindowEventArgs &e) |
Handler called when the z-order position of this window has changed. | |
virtual void | onDestructionStarted (WindowEventArgs &e) |
Handler called when this window's destruction sequence has begun. | |
virtual void | onActivated (ActivationEventArgs &e) |
Handler called when this window has become the active window. | |
virtual void | onDeactivated (ActivationEventArgs &e) |
Handler called when this window has lost input focus and has been deactivated. | |
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 screen size changes. | |
virtual void | onChildAdded (WindowEventArgs &e) |
Handler called when a child window is added to this window. | |
virtual void | onChildRemoved (WindowEventArgs &e) |
Handler called when a child window is removed from this window. | |
virtual void | onMouseEnters (MouseEventArgs &e) |
Handler called when the mouse cursor has entered this window's area. | |
virtual void | onMouseLeaves (MouseEventArgs &e) |
Handler called when the mouse cursor has left this window's area. | |
virtual void | onMouseMove (MouseEventArgs &e) |
Handler called when the mouse cursor has been moved within this window's area. | |
virtual void | onMouseWheel (MouseEventArgs &e) |
Handler called when the mouse wheel (z-axis) position changes within this window's area. | |
virtual void | onMouseButtonDown (MouseEventArgs &e) |
Handler called when a mouse button has been depressed within this window's area. | |
virtual void | onMouseButtonUp (MouseEventArgs &e) |
Handler called when a mouse button has been released within this window's area. | |
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. | |
virtual void | onMouseDoubleClicked (MouseEventArgs &e) |
Handler called when a mouse button has been double-clicked within this window's area. | |
virtual void | onMouseTripleClicked (MouseEventArgs &e) |
Handler called when a mouse button has been triple-clicked within this window's area. | |
virtual void | onKeyDown (KeyEventArgs &e) |
Handler called when a key as been depressed while this window has input focus. | |
virtual void | onKeyUp (KeyEventArgs &e) |
Handler called when a key as been released while this window has input focus. | |
virtual void | onCharacter (KeyEventArgs &e) |
Handler called when a character-key has been pressed while this window has input focus. | |
virtual void | onDragDropItemEnters (DragDropEventArgs &e) |
Handler called when a DragContainer is dragged over this window. | |
virtual void | onDragDropItemLeaves (DragDropEventArgs &e) |
Handler called when a DragContainer is dragged over this window. | |
virtual void | onDragDropItemDropped (DragDropEventArgs &e) |
Handler called when a DragContainer is dragged over this window. | |
virtual void | onVerticalAlignmentChanged (WindowEventArgs &e) |
Handler called when the vertical alignment setting for the window is changed. | |
virtual void | onHorizontalAlignmentChanged (WindowEventArgs &e) |
Handler called when the horizontal alignment setting for the window is changed. | |
virtual void | updateSelf (float elapsed) |
Perform actual update processing for this Window. | |
virtual void | drawSelf (float z) |
Perform the actual rendering for this Window. | |
virtual void | populateRenderCache () |
Update the rendering cache. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
void | setParent (Window *parent) |
Set the parent window for this window object. | |
float | getParentWidth (void) const |
Return the pixel Width of the parent element. This always returns a valid number. | |
float | getParentHeight (void) const |
Return the pixel Height of the parent element. This always returns a valid number. | |
Size | getParentSize (void) const |
Return the pixel size of the parent element. This always returns a valid object. | |
Rect | absoluteToRelative_impl (const Window *window, const Rect &rect) const |
Return a Rect object that describes, in values relative to window, the absolute area described by rect. | |
Size | absoluteToRelative_impl (const Window *window, const Size &sz) const |
Point | absoluteToRelative_impl (const Window *window, const Point &pt) const |
float | absoluteToRelativeX_impl (const Window *window, float x) const |
float | absoluteToRelativeY_impl (const Window *window, float y) const |
Rect | relativeToAbsolute_impl (const Window *window, const Rect &rect) const |
Return a Rect object that describes, in absolute values offset from window, the relative area described by rect. | |
Size | relativeToAbsolute_impl (const Window *window, const Size &sz) const |
Point | relativeToAbsolute_impl (const Window *window, const Point &pt) const |
float | relativeToAbsoluteX_impl (const Window *window, float x) const |
float | relativeToAbsoluteY_impl (const Window *window, float y) const |
Size | getWindowSize_impl (const Window *window) const |
MetricsMode | getInheritedMetricsMode (void) const |
Return the inherited metrics mode. This is either the metrics mode of our parent, or Relative if we have no parent. | |
void | generateAutoRepeatEvent (MouseButton button) |
Fires off a repeated mouse button down event for this window. | |
void | addStandardEvents (void) |
Add standard CEGUI::Window events. | |
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 void | moveToFront_impl (bool wasClicked) |
Implements move to fron behavior. | |
void | doRiseOnClick (void) |
Implementation of rise on click functionality. | |
void | setWindowArea_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. | |
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. | |
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. | |
virtual int | writePropertiesXML (OutStream &out_stream) const |
virtual int | writeChildWindowsXML (OutStream &out_stream) const |
Window (const Window &wnd) | |
Window & | operator= (const Window &wnd) |
Protected Attributes | |
ChildList | d_children |
The list of child Window objects attached to this. | |
ChildList | d_drawList |
Child window objects arranged in rendering order. | |
MetricsMode | d_metricsMode |
Holds the active metrics mode for this window. | |
Window * | d_oldCapture |
The Window that previously had capture (used for restoreOldCapture mode). | |
Window * | d_parent |
Holds pointer to the parent window. | |
const Font * | d_font |
Holds pointer to the Window objects current Font. | |
String | d_text |
Holds the text / label / caption for this Window. | |
uint | d_ID |
User ID assigned to this Window. | |
float | d_alpha |
Alpha transparency setting for the Window. | |
URect | d_area |
This Window objects area as defined by a URect. | |
Size | d_pixelSize |
Current constrained pixel size of the window. | |
const Image * | d_mouseCursor |
Holds pointer to the Window objects current mouse cursor image. | |
void * | d_userData |
Holds pointer to some user assigned data. | |
UserStringMap | d_userStrings |
Holds a collection of named user string values. | |
HorizontalAlignment | d_horzAlign |
Specifies the base for horizontal alignment. | |
VerticalAlignment | d_vertAlign |
Specifies the base for vertical alignment. | |
UVector2 | d_minSize |
current minimum size for the window. | |
UVector2 | d_maxSize |
current maximum size for the window. | |
bool | d_enabled |
true when Window is enabled | |
bool | d_visible |
true when Window is visible (that is it will be rendered, but may be obscured so no necesarily really visible) | |
bool | d_active |
true when Window is the active Window (receiving inputs). | |
bool | d_clippedByParent |
true when Window will be clipped by parent Window area Rect. | |
bool | d_destroyedByParent |
true when Window will be auto-destroyed by parent. | |
bool | d_alwaysOnTop |
true if Window will be drawn on top of all other Windows | |
bool | d_inheritsAlpha |
true if the Window inherits alpha from the parent Window | |
bool | d_restoreOldCapture |
true if the Window restores capture to the previous window when it releases capture. | |
bool | d_zOrderingEnabled |
true if the Window responds to z-order change requests. | |
bool | d_wantsMultiClicks |
true if the Window wishes to hear about multi-click mouse events. | |
bool | d_distCapturedInputs |
true if unhandled captured inputs should be distributed to child windows. | |
bool | d_riseOnClick |
True if the window should come to the front of the z order in respose to a left mouse button down event. | |
bool | d_autoRepeat |
true if button will auto-repeat mouse button down events while mouse button is held down, | |
float | d_repeatDelay |
seconds before first repeat event is fired | |
float | d_repeatRate |
secons between further repeats after delay has expired. | |
bool | d_repeating |
implements repeating - is true after delay has elapsed, | |
float | d_repeatElapsed |
implements repeating - tracks time elapsed. | |
MouseButton | d_repeatButton |
Button we're tracking (implication of this is that we only support one button at a time). | |
String | d_tooltipText |
Text string used as tip for this window. | |
Tooltip * | d_customTip |
Possible custom Tooltip for this window. | |
bool | d_weOwnTip |
true if this Window created the custom Tooltip. | |
bool | d_inheritsTipText |
true if the Window inherits tooltip text from its parent (when none set for itself). | |
RenderCache | d_renderCache |
Object which acts as a cache for Images to be drawn by this Window. | |
bool | d_needsRedraw |
true if window image cache needs to be regenerated. | |
String | d_lookName |
Name of the Look assigned to this window (if any). | |
const String | d_type |
String holding the type name for the Window (is also the name of the WindowFactory that created us). | |
String | d_name |
The name of the window (GUI system unique). | |
String | d_falagardType |
Type name of the window as defined in a Falagard mapping. | |
Static Protected Attributes | |
static Window * | d_captureWindow = NULL |
Window that has captured inputs. | |
static WindowProperties::AbsoluteHeight | d_absHeightProperty |
static WindowProperties::AbsoluteMaxSize | d_absMaxSizeProperty |
static WindowProperties::AbsoluteMinSize | d_absMinSizeProperty |
static WindowProperties::AbsolutePosition | d_absPositionProperty |
static WindowProperties::AbsoluteRect | d_absRectProperty |
static WindowProperties::AbsoluteSize | d_absSizeProperty |
static WindowProperties::AbsoluteWidth | d_absWidthProperty |
static WindowProperties::AbsoluteXPosition | d_absXPosProperty |
static WindowProperties::AbsoluteYPosition | d_absYPosProperty |
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::Height | d_heightProperty |
static WindowProperties::ID | d_IDProperty |
static WindowProperties::InheritsAlpha | d_inheritsAlphaProperty |
static WindowProperties::MetricsMode | d_metricsModeProperty |
static WindowProperties::MouseCursorImage | d_mouseCursorProperty |
static WindowProperties::Position | d_positionProperty |
static WindowProperties::Rect | d_rectProperty |
static WindowProperties::RelativeHeight | d_relHeightProperty |
static WindowProperties::RelativeMaxSize | d_relMaxSizeProperty |
static WindowProperties::RelativeMinSize | d_relMinSizeProperty |
static WindowProperties::RelativePosition | d_relPositionProperty |
static WindowProperties::RelativeRect | d_relRectProperty |
static WindowProperties::RelativeSize | d_relSizeProperty |
static WindowProperties::RelativeWidth | d_relWidthProperty |
static WindowProperties::RelativeXPosition | d_relXPosProperty |
static WindowProperties::RelativeYPosition | d_relYPosProperty |
static WindowProperties::RestoreOldCapture | d_restoreOldCaptureProperty |
static WindowProperties::Size | d_sizeProperty |
static WindowProperties::Text | d_textProperty |
static WindowProperties::Visible | d_visibleProperty |
static WindowProperties::Width | d_widthProperty |
static WindowProperties::XPosition | d_xPosProperty |
static WindowProperties::YPosition | d_yPosProperty |
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 |
Friends | |
class | System |
The Window base class is the only UI object class that the core of 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 for Window base class.
|
|
Convert the given area from absolute to relative metrics.
|
|
Convert the given size from absolute to relative metrics.
|
|
Convert the given position from absolute to relative metrics.
|
|
Return a Rect object that describes, in values relative to window, the absolute area described by rect.
|
|
Convert the given X co-ordinate from absolute to relative metrics.
|
|
Convert the given Y co-ordinate from absolute to relative metrics.
|
|
Activate the Window giving it input focus and bringing it to the top of all non always-on-top Windows.
|
|
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.
|
|
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.
|
|
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.
|
|
Captures input to this window.
|
|
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.
|
|
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.
|
|
disable the Window to prevent interaction.
|
|
Return whether the window wants inputs passed to its attached child windows when the window has inputs captured.
|
|
Perform the actual rendering for this Window.
Reimplemented in CEGUI::ButtonBase, CEGUI::DragContainer, CEGUI::GUISheet, CEGUI::ScrolledContainer, CEGUI::TabButton, and CEGUI::TabControl. |
|
enable the Window to allow interaction.
|
|
Return the window height in absolute metrics.
|
|
Return the window position in absolute metrics.
|
|
Return the window area rect in absolute metrics.
|
|
Return the window size in absolute metrics.
|
|
Return the window width in absolute metrics.
|
|
Return the window X position in absolute metrics.
|
|
Return the window Y position in absolute metrics.
|
|
return a pointer to the Window that currently has input focus starting with this Window.
|
|
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.
|
|
return the current alpha value set for this Window
|
|
Return the current auto-repeat delay setting for this window.
|
|
Return the current auto-repeat rate setting for this window.
|
|
return the Window that currently has inputs captured.
|
|
return a pointer to the first attached child window with the specified ID. 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.
|
|
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.
|
|
return a pointer to the child window that is attached to 'this' at the given index.
|
|
return the child Window that is 'hit' by the given position
|
|
return the number of child Window objects currently attached to this Window.
|
|
return the effective alpha value that will be used when rendering this window, taking into account inheritance of parent window(s) alpha.
|
|
return the Font object active for the Window.
|
|
return the height of the Window using the specified metrics system.
|
|
return the height of the Window. Interpretation of return value depends upon the metric type in use by this window.
|
|
Get the horizontal alignment. Returns the horizontal alignment for the window. This setting affects how the windows position is interpreted relative to its parent.
|
|
return the ID code currently assigned to this Window by client code.
|
|
return a Rect object describing the clipped inner area for this window.
|
|
Get the name of the LookNFeel assigned to this window.
|
|
Return the current maximum size for this window.
|
|
return the current metrics mode employed by the Window
|
|
Return the current minimum size for this window.
|
|
Get whether or not this Window is the modal target.
|
|
Return a pointer to the mouse cursor image to use when the mouse is within this window.
|
|
return a String object holding the name of this Window.
|
|
return the parent of this Window.
|
|
Return the pixel Height of the parent element. This always returns a valid number.
|
|
Return the pixel size of the parent element. This always returns a valid object.
|
|
Return the pixel Width of the parent element. This always returns a valid number.
|
|
return a Rect object describing the Window area in screen space.
|
|
return the position of the window using the specified metrics system.
|
|
return the position of the window. Interpretation of return value depends upon the metric type in use by this window.
|
|
return a Rect object that describes the Window area using the specified metrics system.
|
|
return a Rect object that describes the Window area.
|
|
Return the window height in relative metrics.
|
|
Return the window position in relative metrics.
|
|
Return the window area rect in relative metrics.
|
|
Return the window size in relative metrics.
|
|
Return the window width in relative metrics.
|
|
Return the window X position in relative metrics.
|
|
Return the window Y position in relative metrics.
|
|
Return the RenderCache object for this Window.
|
|
return the size of the Window using the specified metrics system.
|
|
return the size of the Window. Interpretation of return value depends upon the metric type in use by this window.
|
|
return the current text for the Window
|
|
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.
|
|
Return the current tooltip text set for this Window.
|
|
Return the custom tooltip type.
|
|
return a String object holding the type name for this Window.
|
|
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.
Reimplemented in CEGUI::ScrolledContainer, CEGUI::Static, and CEGUI::StaticText. |
|
return a Rect object describing the Window area unclipped, in screen space.
|
|
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 a named user string.
|
|
Get the vertical alignment. Returns the vertical alignment for the window. This setting affects how the windows position is interpreted relative to its parent.
|
|
return the width of the Window using the specified metrics system.
|
|
return the width of the Window. Interpretation of return value depends upon the metric type in use by this window.
|
|
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).
|
|
Get the window's height. Gets the height of the area occupied by this window.
|
|
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).
|
|
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).
|
|
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).
|
|
Get the window's size. Gets the size of the area occupied by this window.
|
|
Get the window's width. Gets the width of the area occupied by this window.
|
|
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).
|
|
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).
|
|
return the x position of the window using the specified metrics system.
|
|
return the x position of the window. Interpretation of return value depends upon the metric type in use by this window.
|
|
return the y position of the window using the specified metrics system.
|
|
return the y position of the window. Interpretation of return value depends upon the metric type in use by this window.
|
|
hide the Window.
|
|
return true if the Window inherits alpha from its parent(s).
|
|
Return whether this window inherits Tooltip text from its parent when its own tooltip text is not set.
|
|
Initialises the Window based object ready for use.
Reimplemented in CEGUI::Combobox, CEGUI::ComboDropList, CEGUI::FrameWindow, CEGUI::GUISheet, CEGUI::ItemListBase, CEGUI::Listbox, CEGUI::MultiColumnList, CEGUI::MultiLineEditbox, CEGUI::ScrollablePane, CEGUI::Scrollbar, CEGUI::Slider, CEGUI::Spinner, CEGUI::StaticText, and CEGUI::TabControl. |
|
return true if this is the active Window (the window that receives inputs) Mouse events are always sent to the window containing the mouse cursor regardless of what this reports (unless the window has captured inputs). This mainly refers to where other (keyboard) inputs are sent.
|
|
returns whether or not this Window is an always on top (a.k.a 'topmost') Window.
|
|
return true if the specified Window is some ancestor of this Window.
|
|
return true if any Window with the given ID is some ancestor of this Window.
|
|
return true if the specified Window is some ancestor of this Window
|
|
return true if a child window has captured inputs.
|
|
return true if an ancestor window has captured inputs.
|
|
return true if this Window has input captured.
|
|
return true if the given Window is a child of this window.
|
|
returns whether at least one window with the given ID code is attached as a child.
|
|
returns whether a Window with the specified name is currently attached to this Window as a child.
|
|
return true if this Window is clipped so that its rendering does not pass outside its parent windows area.
|
|
returns whether or not this Window is set to be destroyed when its parent is destroyed.
|
|
return true if the Window is currently disabled
|
|
check if the given position would hit this window.
Reimplemented in CEGUI::Combobox, and CEGUI::FrameWindow. |
|
Return whether mouse button down event autorepeat is enabled for this window.
|
|
Return whether this window will rise to the top of the z-order when clicked with the left mouse button.
|
|
Return whether a user string with the specified name exists.
|
|
Return whether this Window is using the system default Tooltip for its Tooltip window.
|
|
return true if the Window is currently visible. A true return from this function does not mean that the window is not completely obscured by other windows, just that the window is processed when rendering and is not hidden.
|
|
Return whether z-order changes are enabled or disabled for this Window.
|
|
Move the Window to the bottom of the Z order.
|
|
Move the Window to the top of the z order.
|
|
Handler called when this window has become the active window.
Reimplemented in CEGUI::Combobox, CEGUI::ComboDropList, CEGUI::FrameWindow, and CEGUI::Spinner. |
|
Handler called when the window's alpha blend value is changed.
Reimplemented in CEGUI::DragContainer, CEGUI::PopupMenu, CEGUI::Static, and CEGUI::StaticImage. |
|
Handler called when the window's always-on-top setting is changed.
|
|
Handler called when this window gains capture of mouse inputs.
|
|
Handler called when this window loses capture of mouse inputs.
Reimplemented in CEGUI::ButtonBase, CEGUI::ComboDropList, CEGUI::DragContainer, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::ListHeaderSegment, CEGUI::MenuItem, CEGUI::MultiLineEditbox, CEGUI::Thumb, and CEGUI::Titlebar. |
|
Handler called when a character-key has been pressed while this window has input focus.
Reimplemented in CEGUI::Editbox, and CEGUI::MultiLineEditbox. |
|
Handler called when a child window is added to this window.
Reimplemented in CEGUI::ScrolledContainer. |
|
Handler called when a child window is removed from this window.
Reimplemented in CEGUI::ScrolledContainer. |
|
Handler called when the window's setting for being clipped by it's parent is changed.
Reimplemented in CEGUI::DragContainer. |
|
Handler called when this window has lost input focus and has been deactivated.
Reimplemented in CEGUI::FrameWindow. |
|
Handler called when this window's destruction sequence has begun.
|
|
Handler called when the window is disabled.
|
|
Handler called when a DragContainer is dragged over this window.
|
|
Handler called when a DragContainer is dragged over this window.
|
|
Handler called when a DragContainer is dragged over this window.
|
|
Handler called when the window is enabled.
|
|
Handler called when the window's font is changed.
Reimplemented in CEGUI::Combobox, CEGUI::Spinner, CEGUI::StaticText, CEGUI::TabControl, and CEGUI::Titlebar. |
|
Handler called when the window is hidden.
|
|
Handler called when the horizontal alignment setting for the window is changed.
|
|
Handler called when the window's client assigned ID is changed.
|
|
Handler called when the window's setting for inheriting alpha-blending is changed.
|
|
Handler called when a key as been depressed while this window has input focus.
Reimplemented in CEGUI::Editbox, and CEGUI::MultiLineEditbox. |
|
Handler called when a key as been released while this window has input focus.
|
|
Handler called when the window's active metrics system is changed.
|
|
Handler called when a mouse button has been depressed within this window's area.
Reimplemented in CEGUI::ButtonBase, CEGUI::ComboDropList, CEGUI::DragContainer, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::Listbox, CEGUI::ListHeaderSegment, CEGUI::MenuItem, CEGUI::MultiColumnList, CEGUI::MultiLineEditbox, CEGUI::Scrollbar, CEGUI::Slider, CEGUI::Thumb, and CEGUI::Titlebar. |
|
Handler called when a mouse button has been released within this window's area.
Reimplemented in CEGUI::ButtonBase, CEGUI::Checkbox, CEGUI::ComboDropList, CEGUI::DragContainer, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::ListHeaderSegment, CEGUI::MenuItem, CEGUI::MultiLineEditbox, CEGUI::PushButton, CEGUI::RadioButton, CEGUI::TabButton, and CEGUI::Titlebar. |
|
Handler called when a mouse button has been clicked (that is depressed and then released, within a specified time) within this window's area.
|
|
Handler called when a mouse button has been double-clicked within this window's area.
Reimplemented in CEGUI::Editbox, CEGUI::ListHeaderSegment, CEGUI::MultiLineEditbox, and CEGUI::Titlebar. |
|
Handler called when the mouse cursor has entered this window's area.
Reimplemented in CEGUI::Tooltip. |
|
Handler called when the mouse cursor has left this window's area.
Reimplemented in CEGUI::ButtonBase, CEGUI::ListHeaderSegment, and CEGUI::MenuItem. |
|
Handler called when the mouse cursor has been moved within this window's area.
Reimplemented in CEGUI::ButtonBase, CEGUI::ComboDropList, CEGUI::DragContainer, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::Listbox, CEGUI::ListHeaderSegment, CEGUI::MenuItem, CEGUI::MultiLineEditbox, CEGUI::Thumb, and CEGUI::Titlebar. |
|
Handler called when a mouse button has been triple-clicked within this window's area.
Reimplemented in CEGUI::Editbox, and CEGUI::MultiLineEditbox. |
|
Handler called when the mouse wheel (z-axis) position changes within this window's area.
Reimplemented in CEGUI::Listbox, CEGUI::MultiColumnList, CEGUI::MultiLineEditbox, CEGUI::ScrollablePane, CEGUI::Scrollbar, CEGUI::Slider, and CEGUI::StaticText. |
|
Handler called when the window's position changes.
|
|
Handler called when the window's setting for being destroyed automatically be it's parent is changed.
|
|
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 screen size changes.
Reimplemented in CEGUI::ScrolledContainer. |
|
Handler called when rendering for this window has ended.
|
|
Handler called when rendering for this window has started.
|
|
Handler called when the window is shown (made visible).
|
|
Handler called when the window's size changes.
Reimplemented in CEGUI::ItemListBase, CEGUI::Listbox, CEGUI::MultiColumnList, CEGUI::MultiLineEditbox, CEGUI::PushButton, CEGUI::ScrollablePane, CEGUI::Static, CEGUI::StaticImage, and CEGUI::StaticText. |
|
Handler called when the window's text is changed.
Reimplemented in CEGUI::Combobox, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::MultiLineEditbox, CEGUI::Spinner, CEGUI::StaticText, CEGUI::TextItem, and CEGUI::Tooltip. |
|
Handler called when the vertical alignment setting for the window is changed.
|
|
Handler called when the z-order position of this window has changed.
|
|
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.
Reimplemented in CEGUI::TabControl. |
|
Update the rendering cache. Populates the Window's RenderCache with imagery to be sent to the renderer. Reimplemented in CEGUI::ItemListBase, CEGUI::Listbox, CEGUI::MultiColumnList, CEGUI::MultiLineEditbox, CEGUI::Static, CEGUI::StaticImage, CEGUI::StaticText, and CEGUI::TextItem. |
|
Convert the given area from relative to absolute metrics.
|
|
Convert the given size from relative to absolute metrics.
|
|
Convert the given position from relative to absolute metrics.
|
|
Return a Rect object that describes, in absolute values offset from window, the relative area described by rect.
|
|
Convert the given X co-ordinate from relative to absolute metrics.
|
|
Convert the given Y co-ordinate from relative to absolute metrics.
|
|
Releases input capture from this Window. If this Window does not have inputs captured, nothing happens.
|
|
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.
|
|
Remove the specified Window form this windows child list.
|
|
Remove the named Window from this windows child list.
|
|
Removes the window from the drawing list. If the window is not attached to the drawing list then nothing happens.
|
|
Renames the window.
|
|
Causes the Window object to render itself and all of it's attached children.
|
|
Signal the System object to redraw (at least) this Window on the next render cycle.
|
|
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.
|
|
Convert a URect screen area to a window area, specified in whichever metrics mode is active.
|
|
Convert a screen relative UVector2 point to a window co-ordinate point, specified in whichever metrics mode is active.
|
|
Convert a screen area to a window area, specified in whichever metrics mode is active.
|
|
Convert a pixel screen size to a window based size, specified in whichever metrics mode is active.
|
|
Convert a screen relative pixel position to a window co-ordinate position, specified in whichever metrics mode is active.
|
|
Convert a screen relative UDim co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active.
|
|
Convert a screen relative pixel co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active.
|
|
Convert a screen relative UDim co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active.
|
|
Convert a screen relative pixel co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active.
|
|
Set the current alpha value for this window.
|
|
Set whether this window is always on top, or not.
|
|
Set the current area for the Window, this allows for setting of position and size at the same time. Interpretation of the input value area is dependant upon the current metrics system set for the Window.
|
|
Set the current auto-repeat delay setting for this window.
|
|
Set the current auto-repeat rate setting for this window.
|
|
Set whether this Window will be clipped by its parent window(s).
|
|
Set whether or not this Window will automatically be destroyed when its parent Window is destroyed.
|
|
Set whether the window wants inputs passed to its attached child windows when the window has inputs captured.
|
|
Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering.
|
|
Set the font used by this Window.
|
|
Set the font used by this Window.
|
|
set the height of the Window using the specified metrics system.
|
|
Set the current height of the Window. Interpretation of the input value height is dependant upon the current metrics system set for the Window.
|
|
Set the horizontal alignment. Modifies the horizontal alignment for the window. This setting affects how the windows position is interpreted relative to its parent.
|
|
Set the current ID for the Window.
|
|
Sets whether this Window will inherit alpha from its parent windows.
|
|
Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set.
|
|
Set the LookNFeel that shoule be used for this window.
|
|
Set the maximum size for this window.
|
|
set the current metrics mode employed by the Window
|
|
Set the minimum size for this window.
|
|
Set the modal state for this Window.
|
|
Set whether mouse button down event autorepeat is enabled for this window.
|
|
Set the mouse cursor image to be used when the mouse enters this window.
|
|
Set the mouse cursor image to be used when the mouse enters this window.
|
|
Set the mouse cursor image to be used when the mouse enters this window.
|
|
Set the parent window for this window object.
|
|
set the position of the window using the specified metrics system.
|
|
Set the current position of the Window. Interpretation of the input value position is dependant upon the current metrics system set for the Window.
|
|
set the Rect that describes the Window area using the specified metrics system.
|
|
Set whether this window will remember and restore the previous window that had inputs captured.
|
|
Set whether this window will rise to the top of the z-order when clicked with the left mouse button.
|
|
set the size of the Window using the specified metrics system.
|
|
Set the current size of the Window. Interpretation of the input value size is dependant upon the current metrics system set for the Window.
|
|
Set the current text string for the Window.
|
|
Set the custom Tooltip object for this Window. This value may be NULL to indicate that the Window should use the system default Tooltip object.
|
|
Set the tooltip text for this window.
|
|
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.
|
|
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.
|
|
Sets the value a named user string, creating it as required.
|
|
Set the vertical alignment. Modifies the vertical alignment for the window. This setting affects how the windows position is interpreted relative to its parent.
|
|
Set whether the Window is visible or hidden.
|
|
Set whether this window will receive multi-click events or multiple 'down' events instead.
|
|
set the width of the Window using the specified metrics system.
|
|
Set the current width of the Window. Interpretation of the input value width is dependant upon the current metrics system set for the Window.
|
|
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).
|
|
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).
|
|
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).
|
|
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
/param fireEvents
|
|
Set the window's height. Sets the height of the area occupied by this window.
|
|
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).
|
|
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).
|
|
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).
|
|
Set the window's size. Sets the size of the area occupied by this window.
|
|
Set the window's width. Sets the width of the area occupied by this window.
|
|
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).
|
|
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).
|
|
set the x position of the window using the specified metrics system.
|
|
Set the current 'x' position of the Window. Interpretation of the input value x is dependant upon the current metrics system set for the Window.
|
|
set the y position of the window using the specified metrics system.
|
|
Set the current 'y' position of the Window. Interpretation of the input value y is dependant upon the current metrics system set for the Window.
|
|
Set whether z-order changes are enabled or disabled for this Window.
|
|
show the Window
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented in CEGUI::ButtonBase, CEGUI::Checkbox, CEGUI::Combobox, CEGUI::ComboDropList, CEGUI::DragContainer, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::GUISheet, CEGUI::ItemEntry, CEGUI::ItemListBase, CEGUI::Listbox, CEGUI::ListHeader, CEGUI::ListHeaderSegment, CEGUI::Menubar, CEGUI::MenuBase, CEGUI::MenuItem, CEGUI::MultiColumnList, CEGUI::MultiLineEditbox, CEGUI::PopupMenu, CEGUI::ProgressBar, CEGUI::PushButton, CEGUI::RadioButton, CEGUI::ScrollablePane, CEGUI::Scrollbar, CEGUI::ScrolledContainer, CEGUI::Slider, CEGUI::Spinner, CEGUI::Static, CEGUI::StaticImage, CEGUI::StaticText, CEGUI::TabButton, CEGUI::TabControl, CEGUI::TabPane, CEGUI::TextItem, CEGUI::Thumb, CEGUI::Titlebar, and CEGUI::Tooltip. |
|
Convert the given area from unfied to absolute metrics.
|
|
Convert the given UVector2 value from unified to absolute metrics.
|
|
Convert the given X co-ordinate from unified to absolute metrics.
|
|
Convert the given Y co-ordinate from unified to absolute metrics.
|
|
Convert the given area from unfied to relative metrics.
|
|
Convert the given UVector2 value from unified to relative metrics.
|
|
Convert the given X co-ordinate from unified to relative metrics.
|
|
Convert the given Y co-ordinate from unified to relative metrics.
|
|
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.
|
|
Perform actual update processing for this Window.
Reimplemented in CEGUI::PopupMenu, and CEGUI::Tooltip. |
|
Return whether this window will receive multi-click events or multiple 'down' events instead.
|
|
Convert a window area, specified as a URect, to a screen area.
|
|
Convert a window co-ordinate point, specified as a UVector2, to a screen relative pixel co-ordinate point.
|
|
Convert a window area, specified in whichever metrics mode is active, to a screen area.
|
|
Convert a window size value, specified in whichever metrics mode is active, to a size in pixels.
|
|
Convert a window co-ordinate position, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate position.
|
|
Convert a window co-ordinate value, specified as a UDim, to a screen relative pixel co-ordinate.
|
|
Convert a window co-ordinate value, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate.
|
|
Convert a window co-ordinate value, specified as a UDim, to a screen relative pixel co-ordinate.
|
|
Convert a window co-ordinate value, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate.
|
|
Writes an xml representation of this window object to out_stream.
|