Crazy Eddie's GUI System  0.8.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::TabControl Class Reference

Base class for standard Tab Control widget. More...

+ Inheritance diagram for CEGUI::TabControl:
+ Collaboration diagram for CEGUI::TabControl:

Public Types

enum  TabPanePosition { Top, Bottom }
 

Public Member Functions

size_t getTabCount (void) const
 Return number of tabs. More...
 
TabPanePosition getTabPanePosition (void) const
 Return the positioning of the tab pane. More...
 
void setTabPanePosition (TabPanePosition pos)
 Change the positioning of the tab button pane. More...
 
void setSelectedTab (const String &name)
 
Set the selected tab by the name of the root window within it.
    Also ensures that the tab is made visible (tab pane is scrolled if required).
Exceptions
InvalidRequestExceptionthrown if there's no tab named name.

 
void setSelectedTab (uint ID)
 
Set the selected tab by the ID of the root window within it.
    Also ensures that the tab is made visible (tab pane is scrolled if required).
Exceptions
InvalidRequestExceptionthrown if index is out of range.

 
void setSelectedTabAtIndex (size_t index)
 
Set the selected tab by the index position in the tab control.
    Also ensures that the tab is made visible (tab pane is scrolled if required).
Exceptions
InvalidRequestExceptionthrown if index is out of range.

 
void makeTabVisible (const String &name)
 
Ensure that the tab by the name of the root window within it is visible.
Exceptions
InvalidRequestExceptionthrown if there's no tab named name.

 
void makeTabVisible (uint ID)
 
Ensure that the tab by the ID of the root window within it is visible.
Exceptions
InvalidRequestExceptionthrown if index is out of range.

 
void makeTabVisibleAtIndex (size_t index)
 
Ensure that the tab by the index position in the tab control is visible.
Exceptions
InvalidRequestExceptionthrown if index is out of range.

 
WindowgetTabContentsAtIndex (size_t index) const
 Return the Window which is the first child of the tab at index position index. More...
 
WindowgetTabContents (const String &name) const
 Return the Window which is the tab content with the given name. More...
 
WindowgetTabContents (uint ID) const
 Return the Window which is the tab content with the given ID. More...
 
bool isTabContentsSelected (Window *wnd) const
 Return whether the tab contents window is currently selected. More...
 
size_t getSelectedTabIndex () const
 Return the index of the currently selected tab. More...
 
const UDimgetTabHeight (void) const
 Return the height of the tabs.
 
const UDimgetTabTextPadding (void) const
 Return the amount of padding to add either side of the text in the tab.
 
virtual void initialiseComponents (void)
 Initialise the Window based object ready for use. More...
 
void setTabHeight (const UDim &height)
 Set the height of the tabs.
 
void setTabTextPadding (const UDim &padding)
 Set the amount of padding to add either side of the text in the tab.
 
void addTab (Window *wnd)
 Add a new tab to the tab control. More...
 
void removeTab (const String &name)
 Remove the named tab from the tab control. More...
 
void removeTab (uint ID)
 Remove the tab with the given ID from the tab control. More...
 
 TabControl (const String &type, const String &name)
 Constructor for TabControl base class.
 
virtual ~TabControl (void)
 Destructor for Listbox base class.
 
- Public Member Functions inherited from CEGUI::Window
 Window (const String &type, const String &name)
 Constructor for Window base class. More...
 
virtual ~Window (void)
 Destructor for Window base class.
 
const StringgetType (void) const
 return a String object holding the type name for this Window. More...
 
bool isDestroyedByParent (void) const
 returns whether or not this Window is set to be destroyed when its parent window is destroyed. More...
 
bool isAlwaysOnTop (void) const
 returns whether or not this Window is an always on top Window. Also known as a top-most window. More...
 
bool isDisabled () const
 return whether the Window is currently disabled More...
 
bool isEffectiveDisabled () const
 return whether the Window is currently disabled More...
 
bool isVisible () const
 return true if the Window is currently visible. More...
 
bool isEffectiveVisible () const
 return true if the Window is currently visible. More...
 
bool isActive (void) const
 return true if this is the active Window. An active window is a window that may receive user inputs. More...
 
bool isClippedByParent (void) const
 return true if this Window is clipped so that its rendering will not pass outside of its parent Window area. More...
 
uint getID (void) const
 return the ID code currently assigned to this Window by client code. More...
 
bool isChild (uint ID) const
 returns whether at least one window with the given ID code is attached to this Window as a child. More...
 
bool isChildRecursive (uint ID) const
 returns whether at least one window with the given ID code is attached to this Window or any of it's children as a child. More...
 
WindowgetChildAtIdx (size_t idx) const
 returns a pointer to the child window at the specified index. Idx is the index of the window in the child window list. It is based on the order in which the children were added and is stable. More...
 
WindowgetChild (const String &name_path) const
 return the attached child window that the given name path references. More...
 
WindowgetChildRecursive (const String &name) const
 return a pointer to the first attached child window with the specified name. Children are traversed recursively. More...
 
WindowgetChild (uint ID) const
 return a pointer to the first attached child window with the specified ID value. More...
 
WindowgetChildRecursive (uint ID) const
 return a pointer to the first attached child window with the specified ID value. Children are traversed recursively. 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 (uint ID) const
 return true if any Window with the given ID is some ancestor of this Window. More...
 
const 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...
 
const RectfgetOuterRectClipper () const
 Return a Rect that describes the rendering clipping rect based upon the outer rect area of the window. More...
 
const RectfgetInnerRectClipper () const
 Return a Rect that describes the rendering clipping rect based upon the inner rect area of the window. More...
 
const RectfgetClipRect (const bool non_client=false) const
 Return a Rect that describes the rendering clipping rect for the Window. More...
 
const RectfgetHitTestRect () 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...
 
WindowgetCaptureWindow () const
 return the Window that currently has inputs captured. More...
 
bool isCapturedByThis (void) const
 return true if this Window has input captured. More...
 
bool isCapturedByAncestor (void) const
 return true if an ancestor window has captured inputs. More...
 
bool isCapturedByChild (void) const
 return true if a child window has captured inputs. More...
 
virtual bool isHit (const Vector2f &position, const bool allow_disabled=false) const
 check if the given pixel position would hit this window. More...
 
WindowgetChildAtPosition (const Vector2f &position) const
 return the child Window that is hit by the given pixel position More...
 
WindowgetTargetChildAtPosition (const Vector2f &position, const bool allow_disabled=false) const
 return the child Window that is 'hit' by the given position, and is allowed to handle mouse events. More...
 
WindowgetParent () 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...
 
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...
 
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...
 
bool isMousePassThroughEnabled (void) const
 Returns whether this window should ignore mouse event and pass them through to and other windows behind it. In effect making the window transparent to the mouse. More...
 
bool isAutoWindow (void) const
 Returns whether this window is an auto window. More...
 
bool isWritingXMLAllowed (void) const
 Returns whether this window is allowed to write XML.
 
bool isDragDropTarget () const
 Returns whether this Window object will receive events generated by the drag and drop support in the system. More...
 
void getRenderingContext (RenderingContext &ctx) const
 Fill in the RenderingContext ctx with details of the RenderingSurface where this Window object should normally do it's rendering.
 
virtual void getRenderingContext_impl (RenderingContext &ctx) const
 implementation of the default getRenderingContext logic.
 
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 ()
 
void setDestroyedByParent (bool setting)
 Set whether or not this Window will automatically be destroyed when its parent Window is destroyed. More...
 
void setAlwaysOnTop (bool setting)
 Set whether this window is always on top, or not. More...
 
void setEnabled (bool setting)
 Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering. More...
 
void setDisabled (bool setting)
 Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering. More...
 
void enable (void)
 enable the Window to allow interaction. More...
 
void disable (void)
 disable the Window to prevent interaction. More...
 
void setVisible (bool setting)
 Set whether the Window is visible or hidden. More...
 
void show (void)
 show the Window. More...
 
void hide (void)
 hide the Window. More...
 
void activate (void)
 Activate the Window giving it input focus and bringing it to the top of all windows with the same always-on-top settig as this Window. More...
 
void deactivate (void)
 Deactivate the window. No further inputs will be received by the window until it is re-activated either programmatically or by the user interacting with the gui. More...
 
void setClippedByParent (bool setting)
 Set whether this Window will be clipped by its parent window(s). More...
 
void setID (uint ID)
 Set the current ID for the Window. More...
 
void setText (const String &text)
 Set the current text string for the Window. More...
 
void insertText (const String &text, const String::size_type position)
 Insert the text string text into the current text string for the Window object at the position specified by position. More...
 
void appendText (const String &text)
 Append the string text to the currect text string for the Window object. More...
 
void setFont (const Font *font)
 Set the font used by this Window. More...
 
void setFont (const String &name)
 Set the font used by this Window. More...
 
void removeChild (uint ID)
 Remove the first child Window with the specified ID. If there is more than one attached Window objects with the specified ID, only the fist one encountered will be removed. More...
 
WindowcreateChild (const String &type, const String &name="")
 Creates a child window attached to this window. More...
 
void destroyChild (Window *wnd)
 Destroys a child window of this window. More...
 
void destroyChild (const String &name_path)
 Destroys a child window of this window. More...
 
void moveToFront ()
 Move the Window to the top of the z order. More...
 
void moveToBack ()
 Move the Window to the bottom of the Z order. More...
 
void moveInFront (const Window *const window)
 Move this window immediately above it's sibling window in the z order. More...
 
void moveBehind (const Window *const window)
 Move this window immediately behind it's sibling window in the z order. More...
 
size_t getZIndex () const
 Return the (visual) z index of the window on it's parent. More...
 
bool isInFront (const Window &wnd) const
 Return whether /a this Window is in front of the given window. More...
 
bool isBehind (const Window &wnd) const
 Return whether /a this Window is behind the given window. More...
 
bool captureInput (void)
 Captures input to this window. More...
 
void releaseInput (void)
 Releases input capture from this Window. If this Window does not have inputs captured, nothing happens. More...
 
void setRestoreOldCapture (bool setting)
 Set whether this window will remember and restore the previous window that had inputs captured. More...
 
void setAlpha (const float alpha)
 Set the current alpha value for this window. More...
 
void setInheritsAlpha (bool setting)
 Sets whether this Window will inherit alpha from its parent windows. More...
 
void invalidate (void)
 Invalidate this window causing at least this window to be redrawn during the next rendering pass. More...
 
void invalidate (const bool recursive)
 Invalidate this window and - dependant upon recursive - all child content, causing affected windows to be redrawn during the next rendering pass. More...
 
void setMouseCursor (const Image *image)
 Set the mouse cursor image to be used when the mouse enters this window. More...
 
void setMouseCursor (const String &name)
 Set the mouse cursor image to be used when the mouse enters this window. More...
 
void setUserData (void *user_data)
 Set the user data set for this Window. More...
 
void setZOrderingEnabled (bool setting)
 Set whether z-order changes are enabled or disabled for this Window. More...
 
void setWantsMultiClickEvents (bool setting)
 Set whether this window will receive multi-click events or multiple 'down' events instead. More...
 
void setMouseAutoRepeatEnabled (bool setting)
 Set whether mouse button down event autorepeat is enabled for this window. More...
 
void setAutoRepeatDelay (float delay)
 Set the current auto-repeat delay setting for this window. More...
 
void setAutoRepeatRate (float rate)
 Set the current auto-repeat rate setting for this window. More...
 
void setDistributesCapturedInputs (bool setting)
 Set whether the window wants inputs passed to its attached child windows when the window has inputs captured. More...
 
void notifyDragDropItemEnters (DragContainer *item)
 Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
 
void notifyDragDropItemLeaves (DragContainer *item)
 Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
 
void notifyDragDropItemDropped (DragContainer *item)
 Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
 
virtual void destroy (void)
 Internal destroy method which actually just adds the window and any parent destructed child windows to the dead pool. More...
 
void setTooltip (Tooltip *tooltip)
 Set the custom Tooltip object for this Window. This value may be 0 to indicate that the Window should use the system default Tooltip object. More...
 
void setTooltipType (const String &tooltipType)
 Set the custom Tooltip to be used by this Window by specifying a Window type. More...
 
void setTooltipText (const String &tip)
 Set the tooltip text for this window. More...
 
void setInheritsTooltipText (bool setting)
 Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set. More...
 
void setRiseOnClickEnabled (bool setting)
 Set whether this window will rise to the top of the z-order when clicked with the left mouse button. More...
 
virtual void setLookNFeel (const String &look)
 Set the LookNFeel that shoule be used for this window. More...
 
void setModalState (bool state)
 Set the modal state for this Window. More...
 
void setUserString (const String &name, const String &value)
 Sets the value a named user string, creating it as required. More...
 
void render ()
 Causes the Window object to render itself and all of it's attached children. More...
 
virtual void update (float elapsed)
 Cause window to update itself and any attached children. Client code does not need to call this method; to ensure full, and proper updates, call the injectTimePulse methodname method provided by the System class. More...
 
virtual bool performCopy (Clipboard &clipboard)
 Asks the widget to perform a clipboard copy to the provided clipboard. More...
 
virtual bool performCut (Clipboard &clipboard)
 Asks the widget to perform a clipboard cut to the provided clipboard. More...
 
virtual bool performPaste (Clipboard &clipboard)
 Asks the widget to perform a clipboard paste from the provided clipboard. More...
 
virtual void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this window object to out_stream. More...
 
virtual void beginInitialisation (void)
 Sets the internal 'initialising' flag to true. This can be use to optimize initialisation of some widgets, and is called automatically by the layout XML handler when it has created a window. That is just after the window has been created, but before any children or properties are read.
 
virtual void endInitialisation (void)
 Sets the internal 'initialising' flag to false. This is called automatically by the layout XML handler when it is done creating a window. That is after all properties and children have been loaded and just before the next sibling gets created.
 
void setMousePassThroughEnabled (bool setting)
 Sets whether this window should ignore mouse events and pass them through to any windows behind it. In effect making the window transparent to the mouse. More...
 
void setWindowRenderer (const String &name)
 Assign the WindowRenderer type to be used when rendering this window. More...
 
WindowRenderergetWindowRenderer (void) const
 Get the currently assigned WindowRenderer. (Look'N'Feel specification). More...
 
const StringgetWindowRendererName () const
 Get the factory name of the currently assigned WindowRenderer. (Look'N'Feel specification). More...
 
void setWritingXMLAllowed (bool allow)
 Sets whether this window is allowed to write XML.
 
virtual void notifyScreenAreaChanged (bool recursive=true)
 Inform the window, and optionally all children, that screen area rectangles have changed. More...
 
void setFalagardType (const String &type, const String &rendererType="")
 Changes the widget's falagard type, thus changing its look'n'feel and optionally its renderer in the process. More...
 
void setDragDropTarget (bool setting)
 Specifies whether this Window object will receive events generated by the drag and drop support in the system. More...
 
void setRenderingSurface (RenderingSurface *surface)
 Set the RenderingSurface to be associated with this Window, or 0 if none is required. More...
 
void invalidateRenderingSurface ()
 Invalidate the chain of rendering surfaces from this window backwards to ensure they get properly redrawn - but doing the minimum amount of work possibe - next render.
 
void setUsingAutoRenderingSurface (bool setting)
 Sets whether automatic use of an imagery caching RenderingSurface (i.e. a RenderingWindow) is enabled for this window. The reason we emphasise 'atutomatic' is because the client may manually set a RenderingSurface that does exactlythe same job. More...
 
const 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
 
bool isTextParsingEnabled () const
 return whether text parsing is enabled for this window.
 
void setTextParsingEnabled (const bool setting)
 set whether text parsing is enabled for this window.
 
virtual void setMargin (const UBox &margin)
 set margin
 
const UBoxgetMargin () const
 retrieves currently set margin
 
Vector2f getUnprojectedPosition (const Vector2f &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.
 
void banPropertyFromXML (const String &property_name)
 Add the named property to the XML ban list for this window. More...
 
void unbanPropertyFromXML (const String &property_name)
 Remove the named property from the XML ban list for this window.
 
bool isPropertyBannedFromXML (const String &property_name) const
 Return whether the named property is banned from XML. More...
 
void banPropertyFromXML (const Property *property)
 Add the given property to the XML ban list for this window.
 
void unbanPropertyFromXML (const Property *property)
 Remove the given property from the XML ban list for this window.
 
bool isPropertyBannedFromXML (const Property *property) const
 Return whether given property is banned from XML. More...
 
void setUpdateMode (const WindowUpdateMode mode)
 Set the window update mode. This mode controls the behaviour of the Window::update member function such that updates are processed for this window (and therefore it's child content) according to the set mode. More...
 
WindowUpdateMode getUpdateMode () const
 Return the current window update mode that is set for this Window. This mode controls the behaviour of the Window::update member function such that updates are processed for this window (and therefore it's child content) according to the set mode. More...
 
void setMouseInputPropagationEnabled (const bool enabled)
 Set whether mouse input that is not directly handled by this Window (including it's event subscribers) should be propagated back to the Window's parent. More...
 
bool isMouseInputPropagationEnabled () const
 Return whether mouse input that is not directly handled by this Window (including it's event subscribers) should be propagated back to the Window's parent. More...
 
Windowclone (const bool deepCopy=true) const
 Clones this Window and returns the result. More...
 
virtual void clonePropertiesTo (Window &target) const
 copies this widget's properties to given target widget
 
virtual void cloneChildWidgetsTo (Window &target) const
 copies this widget's child widgets to given target widget
 
GUIContextgetGUIContext () const
 return the GUIContext this window is associated with.
 
void setGUIContext (GUIContext *context)
 function used internally. Do not call this from client code.
 
void syncTargetSurface ()
 ensure that the window will be rendered to the correct target surface.
 
void setAutoWindow (bool is_auto)
 Set whether this window is marked as an auto window. More...
 
bool isMouseContainedInArea () const
 Return whether Window thinks mouse is currently within its area. More...
 
const SizefgetRootContainerSize () const
 Return the size of the root container (such as screen size). More...
 
- Public Member Functions inherited from CEGUI::NamedElement
 NamedElement (const String &name="")
 Constructor. More...
 
virtual ~NamedElement ()
 Destructor.
 
virtual void setName (const String &name)
 Renames the element. More...
 
const StringgetName () const
 Return a String object holding the name of this Element.
 
String getNamePath () const
 Return a String object that describes the name path for this Element.
 
bool isChild (const String &name_path) const
 Checks whether given name path references a NamedElement that is attached to this Element. More...
 
bool isChildRecursive (const String &name) const
 returns whether at least one window with the given name is attached to this Window or any of it's children as a child. More...
 
bool isAncestor (const String &name) const
 Return true if the specified element name is a name of some ancestor of this Element. More...
 
NamedElementgetChildElement (const String &name_path) const
 Return the attached child element that the given name path references. More...
 
NamedElementgetChildElementRecursive (const String &name) const
 Find the first child with the given name, recursively and breadth-first. More...
 
void removeChild (const String &name_path)
 Remove the Element referenced by the given name path from this Element's child list. More...
 
- Public Member Functions inherited from CEGUI::Element
 Element ()
 Constructor.
 
virtual ~Element ()
 Destructor.
 
ElementgetParentElement () const
 Retrieves parent of this element. More...
 
virtual void setArea (const UVector2 &pos, const USize &size)
 Set the Element area. More...
 
void setArea (const UDim &xpos, const UDim &ypos, const UDim &width, const UDim &height)
 
void setArea (const URect &area)
 
const URectgetArea () const
 Return the element's area. More...
 
void setPosition (const UVector2 &pos)
 Set the element's position. More...
 
void setXPosition (const UDim &pos)
 
void setYPosition (const UDim &pos)
 
const UVector2getPosition () const
 Get the element's position. More...
 
const UDimgetXPosition () const
 
const UDimgetYPosition () const
 
virtual void setHorizontalAlignment (const HorizontalAlignment alignment)
 Set the horizontal alignment. More...
 
HorizontalAlignment getHorizontalAlignment () const
 Get the horizontal alignment. More...
 
virtual void setVerticalAlignment (const VerticalAlignment alignment)
 Set the vertical alignment. More...
 
VerticalAlignment getVerticalAlignment () const
 Get the vertical alignment. More...
 
void setSize (const USize &size)
 Set the element's size. More...
 
void setWidth (const UDim &width)
 
void setHeight (const UDim &height)
 
USize getSize () const
 Get the element's size. More...
 
UDim getWidth () const
 
UDim getHeight () const
 
void setMinSize (const USize &size)
 Set the element's minimum size. More...
 
const USizegetMinSize () const
 Get the element's minimum size. More...
 
void setMaxSize (const USize &size)
 Set the element's maximum size. More...
 
const USizegetMaxSize () const
 Get the element's maximum size. More...
 
void setAspectMode (const AspectMode mode)
 Sets current aspect mode and recalculates the area rect. More...
 
AspectMode getAspectMode () const
 Retrieves currently used aspect mode. More...
 
void setAspectRatio (const float ratio)
 Sets target aspect ratio. More...
 
float getAspectRatio () const
 Retrieves target aspect ratio. More...
 
void setPixelAligned (const bool setting)
 Sets whether this Element is pixel aligned (both position and size, basically the 4 "corners"). More...
 
bool isPixelAligned () const
 Checks whether this Element is pixel aligned. More...
 
const Vector2fgetPixelPosition () const
 Return the element's absolute (or screen, depending on the type of the element) position in pixels. More...
 
const SizefgetPixelSize () const
 Return the element's size in pixels. More...
 
Sizef calculatePixelSize (bool skipAllPixelAlignment=false) const
 Calculates this element's pixel size. More...
 
Sizef getParentPixelSize (bool skipAllPixelAlignment=false) const
 Return the pixel size of the parent element. More...
 
void setRotation (const Quaternion &rotation)
 sets rotation of this widget More...
 
const QuaterniongetRotation () const
 retrieves rotation of this widget More...
 
void addChild (Element *element)
 Add the specified Element as a child of this Element. More...
 
void removeChild (Element *element)
 Remove the Element Element's child list. More...
 
ElementgetChildElementAtIdx (size_t idx) const
 return a pointer to the child element that is attached to 'this' at the given index. More...
 
size_t getChildCount () const
 Returns number of child elements attached to this Element.
 
bool isChild (const Element *element) const
 Checks whether given element is attached to this Element.
 
bool isAncestor (const Element *element) const
 Checks whether the specified Element is an ancestor of this Element. More...
 
void setNonClient (const bool setting)
 Set whether the Element is non-client. More...
 
bool isNonClient () const
 Checks whether this element was set to be non client. More...
 
const CachedRectfgetUnclippedOuterRect () const
 Return a Rect that describes the unclipped outer rect area of the Element. More...
 
const CachedRectfgetUnclippedInnerRect () const
 Return a Rect that describes the unclipped inner rect area of the Element. More...
 
const CachedRectfgetUnclippedRect (const bool inner) const
 Return a Rect that describes the unclipped area covered by the Element. More...
 
virtual const CachedRectfgetClientChildContentArea () const
 Return a Rect that is used by client child elements as content area. More...
 
virtual const CachedRectfgetNonClientChildContentArea () const
 Return a Rect that is used by client child elements as content area. More...
 
const CachedRectfgetChildContentArea (const bool non_client=false) const
 Return a Rect that is used to position and size child elements. More...
 
- Public Member Functions inherited from CEGUI::PropertySet
 PropertySet (void)
 Constructs a new PropertySet object.
 
virtual ~PropertySet (void)
 Destructor for PropertySet objects.
 
void addProperty (Property *property)
 Adds a new Property to the PropertySet. More...
 
void removeProperty (const String &name)
 Removes a Property from the PropertySet. More...
 
PropertygetPropertyInstance (const String &name) const
 Retrieves a property instance (that was previously added) More...
 
void clearProperties (void)
 Removes all Property objects from the PropertySet. More...
 
bool isPropertyPresent (const String &name) const
 Checks to see if a Property with the given name is in the PropertySet. More...
 
const 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...
 
template<typename T >
PropertyHelper< T >::return_type getProperty (const String &name) const
 Gets the current value of the specified Property. More...
 
void setProperty (const String &name, const String &value)
 Sets the current value of a Property. More...
 
template<typename T >
void setProperty (const String &name, typename PropertyHelper< T >::pass_type value)
 Sets the current value of a Property. More...
 
bool isPropertyDefault (const String &name) const
 Returns whether a Property is at it's default value. More...
 
String getPropertyDefault (const String &name) const
 Returns the default value of a Property as a String. More...
 
PropertyIterator getPropertyIterator (void) const
 Return a PropertySet::PropertyIterator object to iterate over the available Properties.
 
- Public Member Functions inherited from CEGUI::EventSet
 EventSet ()
 Constructor for EventSet objects.
 
virtual ~EventSet (void)
 Destructor for EventSet objects.
 
void addEvent (const String &name)
 Creates a new Event object with the given name and adds it to the EventSet. More...
 
void addEvent (Event &event)
 Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...
 
void removeEvent (const String &name)
 Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...
 
void removeEvent (Event &event)
 Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...
 
void removeAllEvents (void)
 Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.
 
bool isEventPresent (const String &name)
 Checks to see if an Event with the given name is present in this EventSet. More...
 
virtual Event::Connection subscribeEvent (const String &name, Event::Subscriber subscriber)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
virtual Event::Connection subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
 Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
template<typename Arg1 , typename Arg2 >
Event::Connection subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
template<typename Arg1 , typename Arg2 >
Event::Connection subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
virtual Event::Connection subscribeScriptedEvent (const String &name, const String &subscriber_name)
 Subscribes the named Event to a scripted funtion. More...
 
virtual Event::Connection subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
 Subscribes the specified group of the named Event to a scripted funtion. More...
 
virtual void fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
 Fires the named event passing the given EventArgs object. More...
 
bool isMuted (void) const
 Return whether the EventSet is muted or not. More...
 
void setMutedState (bool setting)
 Set the mute state for this EventSet. More...
 
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...
 
EventIterator getEventIterator (void) const
 Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.
 

Static Public Attributes

static const String EventNamespace
 Namespace for global events.
 
static const String WidgetTypeName
 Window factory name.
 
static const String EventSelectionChanged
 
static const String ContentPaneName
 Widget name for the tab content pane component.
 
static const String TabButtonName
 Widget name for the tab button components.
 
static const String TabButtonPaneName
 Widget name for the tab button pane component.
 
static const String ButtonScrollLeft
 Widget name for the scroll tabs to right pane component.
 
static const String ButtonScrollRight
 Widget name for the scroll tabs to left pane component.
 
- Static Public Attributes inherited from CEGUI::Window
static const String EventNamespace
 Namespace for global events.
 
static const String EventUpdated
 
static const String EventTextChanged
 
static const String EventFontChanged
 
static const String EventAlphaChanged
 
static const String EventIDChanged
 
static const String EventActivated
 
static const String EventDeactivated
 
static const String EventShown
 
static const String EventHidden
 
static const String EventEnabled
 
static const String EventDisabled
 
static const String EventClippedByParentChanged
 
static const String EventDestroyedByParentChanged
 
static const String EventInheritsAlphaChanged
 
static const String EventAlwaysOnTopChanged
 
static const String EventInputCaptureGained
 
static const String EventInputCaptureLost
 
static const String EventInvalidated
 
static const String EventRenderingStarted
 
static const String EventRenderingEnded
 
static const String EventDestructionStarted
 
static const String EventDragDropItemEnters
 
static const String EventDragDropItemLeaves
 
static const String EventDragDropItemDropped
 
static const String EventWindowRendererAttached
 
static const String EventWindowRendererDetached
 
static const String EventTextParsingChanged
 
static const String EventMarginChanged
 
static const String EventMouseEntersArea
 
static const String EventMouseLeavesArea
 
static const String EventMouseEntersSurface
 
static const String EventMouseLeavesSurface
 
static const String EventMouseMove
 
static const String EventMouseWheel
 
static const String EventMouseButtonDown
 
static const String EventMouseButtonUp
 
static const String EventMouseClick
 
static const String EventMouseDoubleClick
 
static const String EventMouseTripleClick
 
static const String EventKeyDown
 
static const String EventKeyUp
 
static const String EventCharacterKey
 
static const String TooltipNameSuffix
 Widget name suffix for automatically created tooltip widgets.
 
static const String WindowXMLElementName
 
static const String AutoWindowXMLElementName
 
static const String UserStringXMLElementName
 
static const String WindowTypeXMLAttributeName
 
static const String WindowNameXMLAttributeName
 
static const String AutoWindowNamePathXMLAttributeName
 
static const String UserStringNameXMLAttributeName
 
static const String UserStringValueXMLAttributeName
 
- Static Public Attributes inherited from CEGUI::NamedElement
static const String EventNamespace
 Namespace for global events.
 
static const String EventNameChanged
 
- Static Public Attributes inherited from CEGUI::Element
static const String EventNamespace
 Namespace for global events.
 
static const String EventSized
 
static const String EventParentSized
 
static const String EventMoved
 
static const String EventHorizontalAlignmentChanged
 
static const String EventVerticalAlignmentChanged
 
static const String EventRotated
 
static const String EventChildAdded
 
static const String EventChildRemoved
 
static const String EventZOrderChanged
 
static const String EventNonClientChanged
 

Protected Types

typedef std::vector< TabButton
*CEGUI_VECTOR_ALLOC(TabButton *)> 
TabButtonVector
 
- Protected Types inherited from CEGUI::Window
typedef std::vector< Window
*CEGUI_VECTOR_ALLOC(Window *)> 
ChildDrawList
 definition of type used for the list of child windows to be drawn
 
typedef std::map< String,
String, StringFastLessCompare
CEGUI_MAP_ALLOC(String, String)> 
UserStringMap
 definition of type used for the UserString dictionary.
 
typedef std::set< String,
StringFastLessCompare
CEGUI_SET_ALLOC(String)> 
BannedXMLPropertySet
 definition of type used to track properties banned from writing XML.
 

Protected Member Functions

virtual void drawSelf (const RenderingContext &)
 Perform the actual rendering for this Window. More...
 
virtual void addButtonForTabContent (Window *wnd)
 Add a TabButton for the specified child Window.
 
virtual void removeButtonForTabContent (Window *wnd)
 Remove the TabButton for the specified child Window.
 
TabButtongetButtonForTabContents (Window *wnd) const
 
Return the TabButton associated with this Window.
Exceptions
InvalidRequestExceptionthrown if content is not found.

 
String makeButtonName (Window *wnd)
 Construct a button name to handle a window.
 
virtual void selectTab_impl (Window *wnd)
 Internal implementation of select tab. More...
 
virtual void makeTabVisible_impl (Window *wnd)
 Internal implementation of make tab visible. More...
 
WindowgetTabButtonPane () const
 Return a pointer to the tab button pane (Window)for this TabControl. More...
 
WindowgetTabPane () const
 Return a pointer to the content component widget for this TabControl. More...
 
void performChildWindowLayout (bool nonclient_sized_hint=false, bool client_sized_hint=false)
 Layout child window content. More...
 
int writeChildWindowsXML (XMLSerializer &xml_stream) const
 
virtual bool validateWindowRenderer (const WindowRenderer *renderer) const
 Function used in checking if a WindowRenderer is valid for this window. More...
 
TabButtoncreateTabButton (const String &name) const
 create and return a pointer to a TabButton widget for use as a clickable tab header More...
 
void removeTab_impl (Window *window)
 Implementation function to do main work of removing a tab.
 
virtual void onSelectionChanged (WindowEventArgs &e)
 Handler called internally when the currently selected item or items changes.
 
virtual void onFontChanged (WindowEventArgs &e)
 Handler called when the window's font is changed. More...
 
void calculateTabButtonSizePosition (size_t index)
 create and return a pointer to a TabButton widget for use as a clickable tab header More...
 
void addTabControlProperties (void)
 
void addChild_impl (Element *element)
 Add given element to child list at an appropriate position. More...
 
void removeChild_impl (Element *element)
 Remove given element from child list. More...
 
virtual NamedElementgetChildByNamePath_impl (const String &name_path) const
 Retrieves a child at name_path or 0 if none such exists. More...
 
bool handleContentWindowTextChanged (const EventArgs &args)
 
bool handleTabButtonClicked (const EventArgs &args)
 
bool handleScrollPane (const EventArgs &e)
 
bool handleDraggedPane (const EventArgs &e)
 
bool handleWheeledPane (const EventArgs &e)
 
- Protected Member Functions inherited from CEGUI::Window
virtual void onSized (ElementEventArgs &e)
 Handler called when the window's size changes. More...
 
virtual void onMoved (ElementEventArgs &e)
 Handler called when the window's position changes. More...
 
virtual void onRotated (ElementEventArgs &e)
 Handler called when the element's rotation is changed. More...
 
virtual void onTextChanged (WindowEventArgs &e)
 Handler called when the window's text is changed. More...
 
virtual void onAlphaChanged (WindowEventArgs &e)
 Handler called when the window's alpha blend value is changed. More...
 
virtual void onIDChanged (WindowEventArgs &e)
 Handler called when the window's client assigned ID is changed. More...
 
virtual void onShown (WindowEventArgs &e)
 Handler called when the window is shown (made visible). More...
 
virtual void onHidden (WindowEventArgs &e)
 Handler called when the window is hidden. More...
 
virtual void onEnabled (WindowEventArgs &e)
 Handler called when the window is enabled. More...
 
virtual void onDisabled (WindowEventArgs &e)
 Handler called when the window is disabled. More...
 
virtual void onClippingChanged (WindowEventArgs &e)
 Handler called when the window's setting for being clipped by it's parent is changed. More...
 
virtual void onParentDestroyChanged (WindowEventArgs &e)
 Handler called when the window's setting for being destroyed automatically be it's parent is changed. More...
 
virtual void onInheritsAlphaChanged (WindowEventArgs &e)
 Handler called when the window's setting for inheriting alpha-blending is changed. More...
 
virtual void onAlwaysOnTopChanged (WindowEventArgs &e)
 Handler called when the window's always-on-top setting is changed. More...
 
virtual void onCaptureGained (WindowEventArgs &e)
 Handler called when this window gains capture of mouse inputs. More...
 
virtual void onCaptureLost (WindowEventArgs &e)
 Handler called when this window loses capture of mouse inputs. More...
 
virtual void onInvalidated (WindowEventArgs &e)
 Handler called when this window gets invalidated. More...
 
virtual void onRenderingStarted (WindowEventArgs &e)
 Handler called when rendering for this window has started. More...
 
virtual void onRenderingEnded (WindowEventArgs &e)
 Handler called when rendering for this window has ended. More...
 
virtual void onZChanged (WindowEventArgs &e)
 Handler called when the z-order position of this window has changed. More...
 
virtual void onDestructionStarted (WindowEventArgs &e)
 Handler called when this window's destruction sequence has begun. More...
 
virtual void onActivated (ActivationEventArgs &e)
 Handler called when this window has become the active window. More...
 
virtual void onDeactivated (ActivationEventArgs &e)
 Handler called when this window has lost input focus and has been deactivated. More...
 
virtual void onParentSized (ElementEventArgs &e)
 Handler called when this window's parent window has been resized. If this window is the root / GUI Sheet window, this call will be made when the display size changes. More...
 
virtual void onChildAdded (ElementEventArgs &e)
 Handler called when a child window is added to this window. More...
 
virtual void onChildRemoved (ElementEventArgs &e)
 Handler called when a child window is removed from this window. More...
 
virtual void onMouseEntersArea (MouseEventArgs &e)
 Handler called when the mouse cursor has entered this window's area. More...
 
virtual void onMouseLeavesArea (MouseEventArgs &e)
 Handler called when the mouse cursor has left this window's area. More...
 
virtual void onMouseEnters (MouseEventArgs &e)
 Handler called when the mouse cursor has entered this window's area and is actually over some part of this windows surface and not, for instance over a child window - even though technically in those cases the mouse is also within this Window's area, the handler will not be called. More...
 
virtual void onMouseLeaves (MouseEventArgs &e)
 Handler called when the mouse cursor is no longer over this window's surface area. This will be called when the mouse is not over a part of this Window's actual surface - even though technically the mouse is still within the Window's area, for example if the mouse moves over a child window. More...
 
virtual void onMouseMove (MouseEventArgs &e)
 Handler called when the mouse cursor has been moved within this window's area. More...
 
virtual void 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 onWindowRendererAttached (WindowEventArgs &e)
 Handler called when a new window renderer object is attached. More...
 
virtual void onWindowRendererDetached (WindowEventArgs &e)
 Handler called when the currently attached window renderer object is detached. More...
 
virtual void onTextParsingChanged (WindowEventArgs &e)
 Handler called when the window's setting for whether text parsing is enabled is changed. More...
 
virtual void onMarginChanged (WindowEventArgs &e)
 
virtual void updateSelf (float elapsed)
 Perform actual update processing for this Window. More...
 
void bufferGeometry (const RenderingContext &ctx)
 Perform drawing operations concerned with generating and buffering window geometry. More...
 
void queueGeometry (const RenderingContext &ctx)
 Perform drawing operations concerned with positioning, clipping and queueing of window geometry to RenderingSurfaces. More...
 
virtual void populateGeometryBuffer ()
 Update the rendering cache. More...
 
virtual void setParent (Element *parent)
 Set the parent window for this window object. More...
 
void generateAutoRepeatEvent (MouseButton button)
 Fires off a repeated mouse button down event for this window.
 
bool isPropertyAtDefault (const Property *property) const
 Returns whether a property is at it's default value. This function is different from Property::isDefatult as it takes the assigned look'n'feel (if the is one) into account.
 
void notifyClippingChanged (void)
 Recursively inform all children that the clipping has changed and screen rects needs to be recached.
 
void allocateRenderingWindow ()
 helper to create and setup the auto RenderingWindow surface
 
void releaseRenderingWindow ()
 helper to clean up the auto RenderingWindow surface
 
void initialiseClippers (const RenderingContext &ctx)
 Helper to intialise the needed clipping for geometry and render surface.
 
virtual void setArea_impl (const UVector2 &pos, const USize &size, bool topLeftSizing=false, bool fireEvents=true)
 Implementation method to modify element area while correctly applying min / max size processing, and firing any appropriate events. More...
 
virtual void cleanupChildren (void)
 Cleanup child windows.
 
virtual void onZChange_impl (void)
 Notify 'this' and all siblings of a ZOrder change event.
 
void addWindowProperties (void)
 Add standard CEGUI::Window properties.
 
virtual bool moveToFront_impl (bool wasClicked)
 Implements move to front behavior. More...
 
void addWindowToDrawList (Window &wnd, bool at_back=false)
 Add the given window to the drawing list at an appropriate position for it's settings and the required direction. Basically, when at_back is false, the window will appear in front of all other windows with the same 'always on top' setting. When at_back is true, the window will appear behind all other windows wih the same 'always on top' setting. More...
 
void removeWindowFromDrawList (const Window &wnd)
 Removes the window from the drawing list. If the window is not attached to the drawing list then nothing happens. More...
 
bool isTopOfZOrder () const
 Return whether the window is at the top of the Z-Order. This will correctly take into account 'Always on top' windows as needed. More...
 
void updateGeometryRenderSettings ()
 Update position and clip region on this Windows geometry / rendering surface.
 
void transferChildSurfaces ()
 transfer RenderingSurfaces to be owned by our target RenderingSurface.
 
Rectf getParentElementClipIntersection (const Rectf &unclipped_area) const
 helper function for calculating clipping rectangles.
 
void invalidate_impl (const bool recursive)
 helper function to invalidate window and optionally child windows.
 
const WindowgetWindowAttachedToCommonAncestor (const Window &wnd) const
 Helper function to return the ancestor Window of /a wnd that is attached as a child to a window that is also an ancestor of /a this. Returns 0 if /a wnd and /a this are not part of the same hierachy.
 
virtual Rectf getUnclippedInnerRect_impl (bool skipAllPixelAlignment) const
 Default implementation of function to return Element's inner rect area.
 
virtual Rectf getOuterRectClipper_impl () const
 Default implementation of function to return Window outer clipper area.
 
virtual Rectf getInnerRectClipper_impl () const
 Default implementation of function to return Window inner clipper area.
 
virtual Rectf getHitTestRect_impl () const
 Default implementation of function to return Window hit-test area.
 
virtual int writePropertiesXML (XMLSerializer &xml_stream) const
 
virtual bool writeAutoChildWindowXML (XMLSerializer &xml_stream) const
 
virtual void banPropertiesForAutoWindow ()
 
virtual bool handleFontRenderSizeChange (const EventArgs &args)
 handler function for when font render size changes.
 
void markCachedWindowRectsInvalid ()
 
void layoutLookNFeelChildWidgets ()
 
WindowgetChildAtPosition (const Vector2f &position, bool(Window::*hittestfunc)(const Vector2f &, bool) const, bool allow_disabled=false) const
 
bool isHitTargetWindow (const Vector2f &position, bool allow_disabled) const
 
- Protected Member Functions inherited from CEGUI::NamedElement
virtual NamedElementgetChildByNameRecursive_impl (const String &name) const
 Finds a child by name or 0 if none such exists.
 
void addNamedElementProperties ()
 Add standard CEGUI::NamedElement properties.
 
virtual void onNameChanged (NamedElementEventArgs &e)
 Handler called when the element's name changes. More...
 
- Protected Member Functions inherited from CEGUI::Element
void addElementProperties ()
 Add standard CEGUI::Element properties.
 
bool isInnerRectSizeChanged () const
 helper to return whether the inner rect size has changed
 
virtual Rectf getUnclippedOuterRect_impl (bool skipAllPixelAlignment) const
 Default implementation of function to return Element's outer rect area.
 
void fireAreaChangeEvents (const bool moved, const bool sized)
 helper to fire events based on changes to area rect
 
void notifyChildrenOfSizeChange (const bool non_client, const bool client)
 
virtual void onHorizontalAlignmentChanged (ElementEventArgs &e)
 Handler called when the horizontal alignment setting for the element is changed. More...
 
virtual void onVerticalAlignmentChanged (ElementEventArgs &e)
 Handler called when the vertical alignment setting for the element is changed. More...
 
virtual void onNonClientChanged (ElementEventArgs &e)
 Handler called when the element's non-client setting, affecting it's position and size relative to it's parent is changed. More...
 
- Protected Member Functions inherited from CEGUI::EventSet
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
EventSetoperator= (EventSet &)
 

Protected Attributes

UDim d_tabHeight
 The height of the tabs in pixels.
 
UDim d_tabPadding
 The padding of the tabs relative to parent.
 
TabButtonVector d_tabButtonVector
 Sorting for tabs.
 
float d_firstTabOffset
 The offset in pixels of the first tab.
 
TabPanePosition d_tabPanePos
 The position of the tab pane.
 
float d_btGrabPos
 
std::map< Window
*, Event::ScopedConnection
d_eventConnections
 Container used to track event subscriptions to added tab windows.
 
- Protected Attributes inherited from CEGUI::Window
const String d_type
 type of Window (also the name of the WindowFactory that created us)
 
String d_falagardType
 Type name of the window as defined in a Falagard mapping.
 
bool d_autoWindow
 true when this window is an auto-window
 
bool d_initialising
 true when this window is currently being initialised (creating children etc)
 
bool d_destructionStarted
 true when this window is being destroyed.
 
bool d_enabled
 true when Window is enabled
 
bool d_visible
 is window visible (i.e. it will be rendered, but may still be obscured)
 
bool d_active
 true when Window is the active Window (receiving inputs).
 
ChildDrawList d_drawList
 Child window objects arranged in rendering order.
 
bool d_destroyedByParent
 true when Window will be auto-destroyed by parent.
 
bool d_clippedByParent
 true when Window will be clipped by parent Window area Rect.
 
String d_lookName
 Name of the Look assigned to this window (if any).
 
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.
 
const 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.
 
bool d_textParsingEnabled
 true if use of parser other than d_defaultStringParser is enabled
 
UBox d_margin
 Margin, only used when the Window is inside LayoutContainer class.
 
uint d_ID
 User ID assigned to this Window.
 
void * d_userData
 Holds pointer to some user assigned data.
 
UserStringMap d_userStrings
 Holds a collection of named user string values.
 
bool d_alwaysOnTop
 true if Window will be drawn on top of all other Windows
 
bool d_riseOnClick
 whether window should rise in the z order when left clicked.
 
bool d_zOrderingEnabled
 true if the Window responds to z-order change requests.
 
bool d_wantsMultiClicks
 true if the Window wishes to hear about multi-click mouse events.
 
bool d_mousePassThroughEnabled
 whether (most) mouse events pass through this window
 
bool d_autoRepeat
 whether pressed mouse button will auto-repeat the down event.
 
float d_repeatDelay
 seconds before first repeat event is fired
 
float d_repeatRate
 seconds between further repeats after delay has expired.
 
MouseButton d_repeatButton
 button we're tracking for auto-repeat purposes.
 
bool d_repeating
 implements repeating - is true after delay has elapsed,
 
float d_repeatElapsed
 implements repeating - tracks time elapsed.
 
bool d_dragDropTarget
 true if window will receive drag and drop related notifications
 
String d_tooltipText
 Text string used as tip for this window.
 
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.
 
Rectf d_outerRectClipper
 outer area clipping rect in screen pixels
 
Rectf d_innerRectClipper
 inner area clipping rect in screen pixels
 
Rectf d_hitTestRect
 area rect used for hit-testing against this window
 
bool d_outerRectClipperValid
 
bool d_innerRectClipperValid
 
bool d_hitTestRectValid
 
WindowUpdateMode d_updateMode
 The mode to use for calling Window::update.
 
bool d_propagateMouseInputs
 specifies whether mouse inputs should be propagated to parent(s)
 
GUIContextd_guiContext
 GUIContext. Set when this window is used as a root window.
 
bool d_containsMouse
 true when mouse is contained within this Window's area.
 
- Protected Attributes inherited from CEGUI::NamedElement
String d_name
 The name of the element, unique in the parent of this element.
 
- Protected Attributes inherited from CEGUI::Element
ChildList d_children
 The list of child element objects attached to this.
 
Elementd_parent
 Holds pointer to the parent element.
 
bool d_nonClient
 true if element is in non-client (outside InnerRect) area of parent.
 
URect d_area
 This element objects area as defined by a URect.
 
HorizontalAlignment d_horizontalAlignment
 Specifies the base for horizontal alignment.
 
VerticalAlignment d_verticalAlignment
 Specifies the base for vertical alignment.
 
USize d_minSize
 current minimum size for the element.
 
USize d_maxSize
 current maximum size for the element.
 
AspectMode d_aspectMode
 How to satisfy current aspect ratio.
 
float d_aspectRatio
 The target aspect ratio.
 
bool d_pixelAligned
 If true, the position and size are pixel aligned.
 
Sizef d_pixelSize
 Current constrained pixel size of the element.
 
Quaternion d_rotation
 Rotation of this element (relative to the parent)
 
CachedRectf d_unclippedOuterRect
 outer area rect in screen pixels
 
CachedRectf d_unclippedInnerRect
 inner area rect in screen pixels
 
- Protected Attributes inherited from CEGUI::EventSet
EventMap d_events
 
bool d_muted
 true if events for this EventSet have been muted.
 

Additional Inherited Members

- Static Protected Attributes inherited from CEGUI::Window
CEGUI::Window::WindowRendererProperty d_windowRendererProperty
 
CEGUI::Window::LookNFeelProperty d_lookNFeelProperty
 
static BasicRenderedStringParser d_basicStringParser
 Shared instance of a parser to be used in most instances.
 
static DefaultRenderedStringParser d_defaultStringParser
 Shared instance of a parser to be used when rendering text verbatim.
 

Detailed Description

Base class for standard Tab Control widget.

Member Function Documentation

void CEGUI::TabControl::addChild_impl ( Element element)
protectedvirtual

Add given element to child list at an appropriate position.

Reimplemented from CEGUI::Window.

void CEGUI::TabControl::addTab ( Window wnd)

Add a new tab to the tab control.

The new tab will be added with the same text as the window passed in.
Parameters
wndThe Window which will be placed in the content area of this new tab.
void CEGUI::TabControl::calculateTabButtonSizePosition ( size_t  index)
protected

create and return a pointer to a TabButton widget for use as a clickable tab header

Parameters
nameButton name
Returns
Pointer to a TabButton to be used for changing tabs.
Calculate the correct position and size of a tab button, based on the
index it is due to be placed at.
Parameters
indexThe index of the tab button
TabButton* CEGUI::TabControl::createTabButton ( const String name) const
protected

create and return a pointer to a TabButton widget for use as a clickable tab header

Parameters
nameButton name
Returns
Pointer to a TabButton to be used for changing tabs.
virtual void CEGUI::TabControl::drawSelf ( const RenderingContext )
inlineprotectedvirtual

Perform the actual rendering for this Window.

Parameters
zfloat value specifying the base Z co-ordinate that should be used when rendering
Returns
Nothing

Reimplemented from CEGUI::Window.

virtual NamedElement* CEGUI::TabControl::getChildByNamePath_impl ( const String name_path) const
protectedvirtual

Retrieves a child at name_path or 0 if none such exists.

Reimplemented from CEGUI::NamedElement.

size_t CEGUI::TabControl::getSelectedTabIndex ( ) const

Return the index of the currently selected tab.

Returns
index of the currently selected tab.
Window* CEGUI::TabControl::getTabButtonPane ( ) const
protected

Return a pointer to the tab button pane (Window)for this TabControl.

Returns
Pointer to a Window object.
Exceptions
UnknownObjectExceptionThrown if the component does not exist.
Window* CEGUI::TabControl::getTabContents ( const String name) const

Return the Window which is the tab content with the given name.

Parameters
nameName of the Window which was attached as a tab content.
Returns
Pointer to the named Window in the tab control.
Exceptions
InvalidRequestExceptionthrown if content is not found.
Window* CEGUI::TabControl::getTabContents ( uint  ID) const

Return the Window which is the tab content with the given ID.

Parameters
IDID of the Window which was attached as a tab content.
Returns
Pointer to the Window with the given ID in the tab control.
Exceptions
InvalidRequestExceptionthrown if content is not found.
Window* CEGUI::TabControl::getTabContentsAtIndex ( size_t  index) const

Return the Window which is the first child of the tab at index position index.

Parameters
indexZero based index of the item to be returned.
Returns
Pointer to the Window at index position index in the tab control.
Exceptions
InvalidRequestExceptionthrown if index is out of range.
size_t CEGUI::TabControl::getTabCount ( void  ) const

Return number of tabs.

Returns
the number of tabs currently present.
Window* CEGUI::TabControl::getTabPane ( ) const
protected

Return a pointer to the content component widget for this TabControl.

Returns
Pointer to a Window object.
Exceptions
UnknownObjectExceptionThrown if the component does not exist.
TabPanePosition CEGUI::TabControl::getTabPanePosition ( void  ) const
inline

Return the positioning of the tab pane.

Returns
The positioning of the tab window within the tab control.
virtual void CEGUI::TabControl::initialiseComponents ( void  )
virtual

Initialise the Window based object ready for use.

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

Reimplemented from CEGUI::Window.

bool CEGUI::TabControl::isTabContentsSelected ( Window wnd) const

Return whether the tab contents window is currently selected.

Parameters
wndThe tab contents window to query.
Returns
true if the tab is currently selected, false otherwise.
Exceptions
InvalidRequestExceptionthrown if wnd is not a valid tab contents window.
virtual void CEGUI::TabControl::makeTabVisible_impl ( Window wnd)
protectedvirtual

Internal implementation of make tab visible.

Parameters
wndPointer to a Window which is the root of the tab content to make visible
virtual void CEGUI::TabControl::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 from CEGUI::Window.

void CEGUI::TabControl::performChildWindowLayout ( bool  nonclient_sized_hint = false,
bool  client_sized_hint = false 
)
protectedvirtual

Layout child window content.

Laying out of child content includes:
    - ensuring content specified in any assigned WidgetLook has its area
      rectangles sychronised.
    - assigned WindowRenderer given the opportunity to update child
      content areas as needed.
    - All content is then potentially updated via the onParentSized
      notification as required by changes in non-client and client area
      rectangles.

The system may call this at various times (like when a window is resized
for example), and it may be invoked directly where required.
Parameters
nonclient_sized_hintHint that the non-client area rectangle has changed size.
client_sized_hintHint that the client area rectangle has changed size.
Note
The hint parameters are essentially a way to force onParentSized notifications for a given type (client / nonclient) of child window. Setting a hint to false does not mean a notification will not happen, instead it means that the function is to do its best to determine whether a given notification is required to be sent.

Reimplemented from CEGUI::Window.

void CEGUI::TabControl::removeChild_impl ( Element element)
protectedvirtual

Remove given element from child list.

Reimplemented from CEGUI::Window.

void CEGUI::TabControl::removeTab ( const String name)

Remove the named tab from the tab control.

The tab content will be destroyed.
void CEGUI::TabControl::removeTab ( uint  ID)

Remove the tab with the given ID from the tab control.

The tab content will be destroyed.
virtual void CEGUI::TabControl::selectTab_impl ( Window wnd)
protectedvirtual

Internal implementation of select tab.

Parameters
wndPointer to a Window which is the root of the tab content to select
void CEGUI::TabControl::setTabPanePosition ( TabPanePosition  pos)

Change the positioning of the tab button pane.

Parameters
posThe new positioning of the tab pane
virtual bool CEGUI::TabControl::validateWindowRenderer ( const WindowRenderer renderer) const
protectedvirtual

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

Parameters
rendererWindow renderer that will be checked (it can be null!)
Returns
Returns true if the given WindowRenderer class name is valid for this window. False if not.

Reimplemented from CEGUI::Window.

Member Data Documentation

float CEGUI::TabControl::d_btGrabPos
protected

The position on the button tab where user grabbed

const String CEGUI::TabControl::EventSelectionChanged
static

Event fired when a different tab is selected. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the TabControl that has a newly selected tab.