BlackTopp Studios inc
This is the base class for all widgets. More...
#include <widget.h>
Inheritance diagram for Mezzanine::UI::Widget: Collaboration diagram for Mezzanine::UI::Widget:Public Types | |
| typedef StateLayerGroupMap::const_iterator | ConstStateLayerGroupIterator |
| Const Iterator type for RenderLayerGroup instances stored in relation to widget states. | |
| typedef StateLayerGroupMap::iterator | StateLayerGroupIterator |
| Iterator type for RenderLayerGroup instances stored in relation to widget states. | |
| typedef std::map< UInt32, RenderLayerGroup * > | StateLayerGroupMap |
| Container class for storing RenderLayerGroup instances in relation to widget states. | |
| enum | WidgetGroupID { WG_Normal = 1, WG_Hovered = 2, WG_Focused = 3, WG_Dragged = 4, WG_Mezzanine_Reserved_1 = 9, WG_Mezzanine_Reserved_2 = 10, WG_Mezzanine_Reserved_3 = 11, WG_Mezzanine_Reserved_4 = 12, WG_User_Group_1 = 17, WG_User_Group_2 = 18, WG_User_Group_3 = 19, WG_User_Group_4 = 20 } |
| Enum used to conveniently track the pre-made RenderLayerGroups used by Widgets. | |
| enum | WidgetState { WS_Untouched = 0, WS_Hovered = 1, WS_Focused = 2, WS_Dragged = 4, WS_Mezzanine_Reserved_1 = 8, WS_Mezzanine_Reserved_2 = 16, WS_Mezzanine_Reserved_3 = 32, WS_Mezzanine_Reserved_4 = 64, WS_User_State_1 = 128, WS_User_State_2 = 256, WS_User_State_3 = 512, WS_User_State_4 = 1024 } |
| Enum describing the current state of the widget. | |
| Public Types inherited from Mezzanine::UI::QuadRenderable | |
| typedef std::vector< Widget * > | ChildContainer |
| Basic container type for Widget storage by this class. | |
| typedef ChildContainer::iterator | ChildIterator |
| Iterator type for Widget instances stored by this class. | |
| typedef ChildContainer::const_iterator | ConstChildIterator |
| Const Iterator type for Widget instances stored by this class. | |
| typedef RenderLayerGroupContainer::const_iterator | ConstRenderLayerGroupIterator |
| Const Iterator type for RenderLayerGroup instances stored by this class. | |
| typedef RenderLayerContainer::const_iterator | ConstRenderLayerIterator |
| Const Iterator type for RenderLayer instances stored by this class. | |
| typedef ChildContainer::const_reverse_iterator | ConstReverseChildIterator |
| Const Reverse Iterator type for Widget instances stored by this class. | |
| typedef std::vector< RenderLayer * > | RenderLayerContainer |
| Basic container type for RenderLayer storage by this class. | |
| typedef std::vector< RenderLayerGroup * > | RenderLayerGroupContainer |
| Basic container type for RenderLayerGroup storage by this class. | |
| typedef RenderLayerGroupContainer::iterator | RenderLayerGroupIterator |
| Iterator type for RenderLayerGroup instances stored by this class. | |
| typedef RenderLayerContainer::iterator | RenderLayerIterator |
| Iterator type for RenderLayer instances stored by this class. | |
| typedef ChildContainer::reverse_iterator | ReverseChildIterator |
| Reverse Iterator type for Widget instances stored by this class. | |
| Public Types inherited from Mezzanine::UI::Renderable | |
| enum | RenderableType { RT_LineList, RT_Screen, RT_Widget } |
| A small enum to describe the type of renderable this is. | |
| Public Types inherited from Mezzanine::EventPublisher | |
| typedef EventContainer::const_iterator | ConstEventIterator |
| Const Iterator type for Event instances stored by this class. | |
| typedef std::map< String, Event * > | EventContainer |
| Basic container type for Event storage by this class. | |
| typedef EventContainer::iterator | EventIterator |
| Iterator type for Event instances stored by this class. | |
Public Member Functions | |||
| Widget (Screen *Parent) | |||
| Blank constructor. More... | |||
| Widget (const String &RendName, Screen *Parent) | |||
| Standard initialization constructor. More... | |||
| Widget (const String &RendName, const UnifiedRect &RendRect, Screen *Parent) | |||
| Rect constructor. More... | |||
| Widget (const XML::Node &XMLNode, Screen *Parent) | |||
| XML constructor. More... | |||
| virtual | ~Widget () | ||
| Standard destructor. | |||
| virtual Boole | _HandleInput (const Input::MetaCode &Code) | ||
| Handles input passed to this widget. More... | |||
| virtual void | _NotifyChildStateChange (Widget *Child, const UInt32 &OldState, const UInt32 &NewState) | ||
| Notifies this widget that a child (or grandchild) has had it's state updated. More... | |||
| virtual void | _NotifyEvent (EventArgumentsPtr Args) | ||
| Notifies this subscriber of an event being fired. More... | |||
| virtual void | _OnFocusGained () | ||
| Self logic to be executed when focus is given to this widget. More... | |||
| virtual void | _OnFocusLocked () | ||
| Self logic to be executed when focus is locked to this widget. More... | |||
| virtual void | _OnFocusLost () | ||
| Self logic to be executed when focus is removed from this widget. More... | |||
| virtual void | _OnFocusUnlocked () | ||
| Self logic to be executed when focus is no longer locked to this widget. More... | |||
| virtual void | _OnMouseDragEnd () | ||
| Self logic to be executed when the mouse cursor stops dragging across the bounds of this widget. More... | |||
| virtual void | _OnMouseDragStart () | ||
| Self logic to be executed when the mouse cursor starts dragging across the bounds of this widget. More... | |||
| virtual void | _OnMouseEnter () | ||
| Self logic to be executed when the mouse cursor enters the bounds of this widget. More... | |||
| virtual void | _OnMouseExit () | ||
| Self logic to be executed when the mouse cursor leaves the bounds of thiw widget. More... | |||
| virtual void | _OnVisibilityHidden () | ||
| Self logic to be executed when this widget becomes invisible. | |||
| virtual void | _OnVisibilityShown () | ||
| Self logic to be executed when this widget becomes visible. | |||
| virtual void | BindGroupToState (const UInt32 BindState, RenderLayerGroup *ToBind) | ||
| Binds a RenderLayerGroup to a WidgetState. More... | |||
| virtual void | ForceState (const UInt32 NewState) | ||
| Forces a new state of this Widget. More... | |||
| Widget * | GetBottomMostHoveredWidget () | ||
| Gets a pointer to the Widget at the bottom of the hovered SubWidget chain. More... | |||
| virtual String | GetDerivedSerializableName () const | ||
| Gets the most derived serializable name of this Renderable. More... | |||
| virtual RenderLayerGroup * | GetGroupBoundToState (const UInt32 BindState) const | ||
| Gets the current RenderLayerGroup bound to a specified WidgetState. More... | |||
| Widget * | GetHoveredSubWidget () const | ||
| Gets the hovered sub-widget within this widget, if any. More... | |||
| virtual RenderableType | GetRenderableType () const | ||
| Gets the type of renderable this is. More... | |||
| virtual UInt32 | GetState () const | ||
| Gets the current state of this Widget. More... | |||
| virtual const String & | GetTypeName () const | ||
| Gets the type of widget this is. More... | |||
| virtual Boole | GetVisible () const | ||
| Gets the visibility setting of this renderable. More... | |||
| virtual Boole | HasFocus () const | ||
| Gets whether or not this widget currently has focus. More... | |||
| virtual void | Hide () | ||
| Forces this renderable to hide. More... | |||
| virtual Boole | IsDragged () const | ||
| Gets whether or not the system mouse is being dragged over this widget. More... | |||
| virtual Boole | IsHovered () const | ||
| Gets the result of the last mouse hover check. More... | |||
| virtual Boole | IsVisible () const | ||
| Gets whether or not this renderable is being drawn. More... | |||
| virtual void | ProtoDeSerializeEvents (const XML::Node &SelfRoot) | ||
| Take the data stored in an XML Node and overwrite the Events of this object with it. More... | |||
| virtual void | ProtoDeSerializeProperties (const XML::Node &SelfRoot) | ||
| Take the data stored in an XML Node and overwrite the properties of this object with it. More... | |||
| virtual void | ProtoDeSerializeStateGroupBindings (const XML::Node &SelfRoot) | ||
| Take the data stored in an XML Node and overwrite the state-group bindings of this object with it. More... | |||
| virtual void | ProtoSerializeEvents (XML::Node &SelfRoot) const | ||
| Convert the Events of this class to an XML::Node ready for serialization. More... | |||
| virtual void | ProtoSerializeProperties (XML::Node &SelfRoot) const | ||
| Convert the properties of this class to an XML::Node ready for serialization. More... | |||
| virtual void | ProtoSerializeStateGroupBindings (XML::Node &SelfRoot) const | ||
| Convert the state-group bindings of this class to an XML::Node ready for serialization. More... | |||
| virtual Boole | SetGroupFromState (const UInt32 BindState) | ||
| Sets the group bound to the specified WidgetState as active. More... | |||
| virtual void | SetVisible (Boole CanSee) | ||
| Sets the visibility of this renderable. More... | |||
| virtual void | Show () | ||
| Forces this renderable to be shown. More... | |||
| Public Member Functions inherited from Mezzanine::UI::QuadRenderable | |||
| QuadRenderable (Screen *Parent) | |||
| Blank constructor. More... | |||
| QuadRenderable (const String &RendName, Screen *Parent) | |||
| Class constructor. More... | |||
| QuadRenderable (const String &RendName, const UnifiedRect &RendRect, Screen *Parent) | |||
| Parent-less constructor. More... | |||
| virtual | ~QuadRenderable () | ||
| Class destructor. More... | |||
| virtual void | _AppendRenderData (ScreenRenderData &RenderData) | ||
| Appends the vertices of this renderable to another vector. More... | |||
| virtual void | _AppendRenderDataCascading (ScreenRenderData &RenderData) | ||
| Appends the vertices of this renderable to another vector, and then does the same for this renderable's children. More... | |||
| virtual void | _Clean () | ||
| Refreshes the render data of this renderable. More... | |||
| virtual void | _MarkAllChildrenDirty () | ||
| Tells this QuadRenderable to mark each of it's children (and their children) as dirty. More... | |||
| virtual void | _MarkAllLayersDirty () | ||
| Tells this QuadRenderable that all of it's layers are dirty. More... | |||
| virtual void | _MarkDirty () | ||
| Marks this renderable as dirty, and informs other renderables if needed. More... | |||
| virtual void | _NotifyParenthood (QuadRenderable *NewParent) | ||
| Notifies this QuadRenderable that it has been added to another QuadRenderable. More... | |||
| virtual void | _SetLayoutStrat (LayoutStrategy *ToSet) | ||
| Sets a new LayoutStrategy for this quad to use. More... | |||
| virtual void | _SetZOrder (const UInt16 &Zorder) | ||
| Ssts the ZOrder value for this renderable. More... | |||
| virtual void | AddChild (Widget *Child) | ||
| Adds a Widget to this as a child of this quad. More... | |||
| virtual void | AddChild (Widget *Child, const UInt16 ZOrder) | ||
| Adds a Widget to this as a child of this quad. More... | |||
| void | AddLayerToExistingGroup (RenderLayer *Layer, const UInt16 LayerZOrder, const UInt16 GroupID) | ||
| Adds a RenderLayer to the specified group. More... | |||
| void | AddLayerToGroup (RenderLayer *Layer, const UInt16 LayerZOrder, const UInt16 GroupID) | ||
| Adds a RenderLayer to the specified group. More... | |||
| void | AddLayerToGroup (RenderLayer *Layer, const GroupOrderEntry &GroupAndZ) | ||
| Adds a RenderLayer to the specified group. More... | |||
| void | AddLayerToGroups (RenderLayer *Layer, const GroupOrderEntryVector &Entrys) | ||
| Adds a RenderLayer to multiple groups. More... | |||
| virtual Boole | CheckOverlap (const QuadRenderable *Quad) const | ||
| Checks to see if another Quad is overlapping with this one. More... | |||
| ChildIterator | ChildrenBegin () | ||
| Gets an iterator to the first child Widget. More... | |||
| ConstChildIterator | ChildrenBegin () const | ||
| Gets a const iterator to the first child Widget. More... | |||
| ChildIterator | ChildrenEnd () | ||
| Gets an iterator to one passed the last child Widget. More... | |||
| ConstChildIterator | ChildrenEnd () const | ||
| Gets an iterator to one passed the last child Widget. More... | |||
| MultiImageLayer * | CreateMultiImageLayer () | ||
| Creates an MultiImageLayer for this renderable. More... | |||
| MultiImageLayer * | CreateMultiImageLayer (const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creates an MultiImageLayer for this renderable. More... | |||
| MultiImageLayer * | CreateMultiImageLayer (const GroupOrderEntry &GroupAndZ) | ||
| Creates an MultiImageLayer for this renderable and adds it to a RenderLayerGroup. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer () | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const GroupOrderEntry &GroupAndZ) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const String &FontName) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const String &FontName, const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| MultiLineTextLayer * | CreateMultiLineTextLayer (const String &FontName, const GroupOrderEntry &GroupAndZ) | ||
| Creats a MultiLineTextLayer for this renderable. More... | |||
| RenderLayerGroup * | CreateOrRetrieveRenderLayerGroup (const UInt16 GroupID) | ||
| Gets the named RenderLayerGroup or creates one with the specified ID if it does not exist. More... | |||
| RenderLayerGroup * | CreateRenderLayerGroup (const UInt16 GroupID) | ||
Creates a new RenderLayerGroup that can have.
| |||
| SingleImageLayer * | CreateSingleImageLayer () | ||
| Creates a SingleImageLayer for this renderable. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creates a SingleImageLayer for this renderable. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const GroupOrderEntry &GroupAndZ) | ||
| Creates a SingleImageLayer for this renderable and adds it to a RenderLayerGroup. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const String &SpriteName) | ||
| Creates a SingleImageLayer for this renderable. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const String &SpriteName, const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creates a SingleImageLayer for this renderable. More... | |||
| SingleImageLayer * | CreateSingleImageLayer (const String &SpriteName, const GroupOrderEntry &GroupAndZ) | ||
| Creates a SingleImageLayer for this renderable and adds it to a RenderLayerGroup. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer () | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const GroupOrderEntry &GroupAndZ) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const String &FontName) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const String &FontName, const UInt16 NormalZ, const UInt16 HoveredZ) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| SingleLineTextLayer * | CreateSingleLineTextLayer (const String &FontName, const GroupOrderEntry &GroupAndZ) | ||
| Creats a SingleLineTextLayer for this renderable. More... | |||
| virtual void | DestroyAllChildren () | ||
| Destroys all child Widgets currently inside this QuadRenderable. | |||
| void | DestroyAllRenderLayerGroups () | ||
| Destroy's all RenderLayerGroups being stored/managed by this QuadRenderable. | |||
| void | DestroyAllRenderLayers () | ||
| Destroys all RenderLayers being stored by this renderable. | |||
| virtual void | DestroyChild (Widget *ToBeDestroyed) | ||
| Destroys a child Widget currently inside this QuadRenderable. More... | |||
| void | DestroyRenderLayer (RenderLayer *ToBeDestroyed) | ||
| Destroys a RenderLayer being stored by this renderable. More... | |||
| void | DestroyRenderLayerGroup (const UInt16 GroupID) | ||
| Destroy's a RenderLayerGroup by ID. More... | |||
| void | DestroyRenderLayerGroup (RenderLayerGroup *ToBeDestroyed) | ||
| Destroy's a RenderLayerGroup by pointer. More... | |||
| RenderLayerGroup * | GetActiveGroup () const | ||
| Gets the current RenderLayerGroup used for rendering. More... | |||
| virtual Vector2 | GetActualPosition () const | ||
| Gets the pixel position of this widget. More... | |||
| virtual Vector2 | GetActualSize () const | ||
| Gets the pixel size of this widget. More... | |||
| virtual UI::AspectRatioLock | GetAspectRationLock () const | ||
| Gets how (and if) the aspect ratio of this quad is locked. More... | |||
| virtual Widget * | GetChild (const UInt16 Zorder) const | ||
| Gets a child by it's ZOrder. More... | |||
| virtual Widget * | GetChild (const String &RendName) const | ||
| Gets a child by it's name. More... | |||
| Widget * | GetClosestChild (Widget *Child) | ||
| Gets a pointer to the child of this QuadRenderable that is storing a child, or another quad that is. More... | |||
| virtual UInt16 | GetHighestChildZOrder () const | ||
| Gets the highest ZOrder among the children of this QuadRenderable. More... | |||
| virtual Whole | GetHorizontalPositioningRules () const | ||
| Gets the current behavior this quad will follow when it is positioned automatically on the X axis. More... | |||
| virtual Whole | GetHorizontalSizingRules () const | ||
| Gets the current behavior this quad will follow for the X axis when it is resized. More... | |||
| virtual Real | GetIdealHeightForText () const | ||
| Gets the height needed for this quadrenderable to be able to completely display text in it's child text layers. More... | |||
| virtual UInt16 | GetLowestChildZOrder () const | ||
| Gets the lowest ZOrder among the children of this QuadRenderable. More... | |||
| virtual Boole | GetManualTransformUpdates () const | ||
| Gets whether or not this quad will be automatically updated when parent transforms are updated. More... | |||
| virtual UnifiedVec2 | GetMaxSize () const | ||
| Gets the currently set maximum size for this quad. More... | |||
| virtual UnifiedVec2 | GetMinSize () const | ||
| Gets the currently set minimum size for this quad. More... | |||
| virtual Boole | GetMousePassthrough () const | ||
| Gets whether or not Mouse Passthrough is enabled. More... | |||
| QuadRenderable * | GetNextSibling (Boole Wrap=true) | ||
| Gets the QuadRenderable after this one among the QuadRenderables owned by it's parent. More... | |||
| virtual Whole | GetNumChildren () const | ||
| Gets the number of children in this QuadRenderable. More... | |||
| UInt32 | GetNumRenderLayerGroups () const | ||
| Gets the number of RenderLayerGroup's created for this renderable. More... | |||
| UInt32 | GetNumRenderLayers () const | ||
| Gets the number of RenderLayers created for this renderable. More... | |||
| UInt32 | GetNumVisibleRenderLayers () const | ||
| Gets the number of RenderLayers that are visible in this renderable. More... | |||
| QuadRenderable * | GetParent () const | ||
| Gets the parent of this quad. More... | |||
| virtual const PositioningInfo & | GetPositioningPolicy () const | ||
| Gets the current behavior this QuadRenderable will use when it is positioned. More... | |||
| QuadRenderable * | GetPrevSibling (Boole Wrap=true) | ||
| Gets the QuadRenderable before this one among the QuadRenderables owned by it's parent. More... | |||
| virtual Rect | GetRect () const | ||
| Gets this QuadRenderables' Rect. More... | |||
| RenderLayer * | GetRenderLayer (const UInt32 &Index) const | ||
| Gets a RenderLayer belonging to this QuadRenderable by index. More... | |||
| RenderLayer * | GetRenderLayer (const Whole Which, const UI::RenderLayerType Type) | ||
| Gets a RenderLayer belonging to this QuadRenderable by it's type. More... | |||
| RenderLayerGroup * | GetRenderLayerGroup (const UInt16 GroupID) const | ||
| Gets a RenderLayerGroup by ID. More... | |||
| virtual const SizingInfo & | GetSizingPolicy () const | ||
| Gets the current behavior this QuadRenderable will use when it is sized. More... | |||
| QuadRenderable * | GetTopMostQuad () | ||
| Gets the QuadRenderable that is both an ancestor of this quad, and a direct child of the screen. More... | |||
| virtual UnifiedVec2 | GetUnifiedPosition () const | ||
| Gets the position of this QuadRenderable as a Unified Vector2. More... | |||
| virtual UnifiedRect | GetUnifiedRect () const | ||
| Gets the Unified positiona nd size of this QuadRenderable as a unified rect. More... | |||
| virtual UnifiedVec2 | GetUnifiedSize () const | ||
| Gets the size of this QuadRenderable as a Unified Vector2. More... | |||
| virtual Whole | GetVerticalPositioningRules () const | ||
| Gets the current behavior this quad will follow when it is positioned automatically on the Y axis. More... | |||
| virtual Whole | GetVerticalSizingRules () const | ||
| Gets the current behavior this quad will follow for the Y axis when it is resized. More... | |||
| virtual const UInt16 & | GetZOrder () const | ||
| Gets the currently set ZOrder of this QuadRenderable with it's parent. More... | |||
| virtual Boole | IsChildOfScreen () const | ||
| Gets whether or not this QuadRenderable is a direct child of it's screen. More... | |||
| virtual Boole | IsInside (const Vector2 &Point) const | ||
| Checks to see if a point in 2D space is inside this quad. More... | |||
| Boole | IsVertexCachingEnabled () const | ||
| Gets whether or not vertex caching is enabled for this Quad. More... | |||
| virtual void | PopulateTextLinesInLayers (const Real MaxWidth) | ||
| Populates all text lines in all text layers owned by this quad. More... | |||
| virtual void | ProtoDeSerialize (const XML::Node &SelfRoot) | ||
| Take the data stored in an XML Node and overwrite this object with it. More... | |||
| virtual void | ProtoDeSerializeChildQuads (const XML::Node &SelfRoot) | ||
| Take the data stored in an XML Node and overwrite the ChildQuads of this object with it. More... | |||
| virtual void | ProtoDeSerializeRenderLayerGroups (const XML::Node &SelfRoot) | ||
| Take the data stored in an XML Node and overwrite the RenderLayerGroups of this object with it. More... | |||
| virtual void | ProtoDeSerializeRenderLayers (const XML::Node &SelfRoot) | ||
| Take the data stored in an XML Node and overwrite the RenderLayers of this object with it. More... | |||
| virtual void | ProtoSerialize (XML::Node &ParentNode) const | ||
| Convert this class to an XML::Node ready for serialization. More... | |||
| virtual void | ProtoSerializeChildQuads (XML::Node &SelfRoot) const | ||
| Convert the child quads of this class to an XML::Node ready for serialization. More... | |||
| virtual void | ProtoSerializeRenderLayerGroups (XML::Node &SelfRoot) const | ||
| Convert the RenderLayerGroups of this class to an XML::Node ready for seriailization. More... | |||
| virtual void | ProtoSerializeRenderLayers (XML::Node &SelfRoot) const | ||
| Convert the RenderLayers of this class to an XML::Node ready for serialization. More... | |||
| ReverseChildIterator | RChildrenBegin () | ||
| Gets an iterator to the last Widget. More... | |||
| ConstReverseChildIterator | RChildrenBegin () const | ||
| Gets a const iterator to the last Widget. More... | |||
| ReverseChildIterator | RChildrenEnd () | ||
| Gets an iterator to one before the first child Widget. More... | |||
| ConstReverseChildIterator | RChildrenEnd () const | ||
| Gets a const iterator to one before the first child Widget. More... | |||
| virtual void | RemoveAllChildren () | ||
| Removes all child Widgets from this QuadRenderable. More... | |||
| virtual void | RemoveChild (Widget *ToBeRemoved) | ||
| Removes a child Widget from this quadrenderable. More... | |||
| void | RemoveLayerFromAllGroups (RenderLayer *Layer) | ||
| Removes a single RenderLayer from all RenderLayerGroups owned by this QuadRenderable. More... | |||
| void | RemoveLayerFromGroup (RenderLayer *Layer, const UInt16 GroupID) | ||
| Removes a single RenderLayer from a specified RenderLayerGroup. More... | |||
| RenderLayerIterator | RenderLayerBegin () | ||
| Gets an iterator to the first RenderLayer. More... | |||
| ConstRenderLayerIterator | RenderLayerBegin () const | ||
| Gets a const iterator to the first RenderLayer. More... | |||
| RenderLayerIterator | RenderLayerEnd () | ||
| Gets an iterator to one passed the last RenderLayer. More... | |||
| ConstRenderLayerIterator | RenderLayerEnd () const | ||
| Gets an iterator to one passed the last RenderLayer. More... | |||
| RenderLayerGroupIterator | RenderLayerGroupBegin () | ||
| Gets an iterator to the first RenderLayerGroup. More... | |||
| ConstRenderLayerGroupIterator | RenderLayerGroupBegin () const | ||
| Gets a const iterator to the first RenderLayerGroup. More... | |||
| RenderLayerGroupIterator | RenderLayerGroupEnd () | ||
| Gets an iterator to one passed the last RenderLayerGroup. More... | |||
| ConstRenderLayerGroupIterator | RenderLayerGroupEnd () const | ||
| Gets an iterator to one passed the last RenderLayerGroup. More... | |||
| Boole | RenderLayerGroupExists (const UInt16 GroupID) const | ||
| Checks to see if a RenderLayerGroup exists. More... | |||
| void | SetActiveGroup (const UInt16 GroupID) | ||
| Sets the RenderLayerGroup that will be used to render this renderable. More... | |||
| void | SetActiveGroup (RenderLayerGroup *Group) | ||
| Sets the RenderLayerGroup that will be used to render this renderable. More... | |||
| virtual void | SetAspectRatioLock (const UI::AspectRatioLock Lock) | ||
| Sets how (and if) the aspect ratio of this quad is locked. More... | |||
| virtual void | SetHorizontalPositioningRules (const Whole Rules) | ||
| Sets the behavior this quad will have when it is positioned automatically on the X axis. More... | |||
| virtual void | SetHorizontalSizingRules (const Whole Rules) | ||
| Sets the behavior this quad will have on the X axis when it is resized. More... | |||
| void | SetLocalVertexCaching (Boole Enable) | ||
| Enables or disables caching of vertex's belonging to this and all child renderables. More... | |||
| virtual void | SetManualTransformUpdates (Boole Enable) | ||
| Sets whether or not this quad has specific behaviors for it's transform updates and they should not be done automatically. More... | |||
| virtual void | SetMaxSize (const UnifiedVec2 &Max) | ||
| Sets the maximum size this quad is allowed to have. More... | |||
| virtual void | SetMinSize (const UnifiedVec2 &Min) | ||
| Sets the minimum size this quad is allowed to have. More... | |||
| virtual void | SetMousePassthrough (Boole Enable) | ||
| Sets whether or not this quad should be skipped when determining if the mouse is hovered over this quad. More... | |||
| virtual void | SetPositioningPolicy (const PositioningInfo &Policy) | ||
| Sets the behavior to be used when this QuadRenderable is positioned. More... | |||
| virtual void | SetSizingPolicy (const SizingInfo &Policy) | ||
| Sets the behavior to be used when this QuadRenderable is sized. More... | |||
| virtual void | SetUnifiedPosition (const UnifiedVec2 &Position) | ||
| Sets the position this QuadRenderable will have within it's parent. More... | |||
| virtual void | SetUnifiedSize (const UnifiedVec2 &Size) | ||
| Sets the size this QuadRenderable will have within it's parent. More... | |||
| virtual void | SetVerticalPositioningRules (const Whole Rules) | ||
| Sets the behavior this quad will have when it is positioned automatically on the Y axis. More... | |||
| virtual void | SetVerticalSizingRules (const Whole Rules) | ||
| Sets the behavior this quad will have on the Y axis when it is resized. More... | |||
| virtual void | UpdateChildDimensions () | ||
| Updates the dimensions of the children in this QuadRenderable. More... | |||
| virtual void | UpdateChildOrder () | ||
| Updates the order of children in this QuadRenderable based on the ZOrder set on each child. | |||
| virtual void | UpdateDimensions () | ||
| Updates the dimensions of this QuadRenderable based on the transform of it's parent. More... | |||
| virtual void | UpdateDimensions (const Rect &OldSelfRect, const Rect &NewSelfRect) | ||
| Updates the dimensions of this QuadRenderable based on the transform of it's parent. More... | |||
| Public Member Functions inherited from Mezzanine::UI::Renderable | |||
| Boole | _IsDirty () const | ||
| Gets whether or not this renderable is dirty. More... | |||
| const String & | GetName () const | ||
| Gets the name of this renderable. More... | |||
| Screen * | GetScreen () const | ||
| Gets the parent screen of this renderable. More... | |||
| Boole | IsScreen () const | ||
| Gets whether or not this renderable is a Screen. More... | |||
| Boole | IsWidget () const | ||
| Gets whether or not this renderable is a Widget. More... | |||
| Public Member Functions inherited from Mezzanine::EventPublisher | |||
| EventPublisher () | |||
| Class constructor. | |||
| virtual | ~EventPublisher () | ||
| Class destructor. | |||
| Event * | GetEvent (const String &EventName) const | ||
| Gets an event in this publisher. More... | |||
| Event * | GetEventExcept (const String &EventName) const | ||
Gets an event in this publisher.
| |||
| Boole | GetMuteEvents () const | ||
| Gets whether or not event firings by this publisher will be suppressed. More... | |||
| void | SetMuteEvents (const Boole Mute) | ||
| Sets whether or not event firings by this publisher will be suppressed. More... | |||
| EventSubscriberSlot * | Subscribe (const String &EventName, EventSubscriber *Sub) | ||
| Adds a subscriber to this event. More... | |||
| EventSubscriberSlot * | Subscribe (const String &EventName, FunctorEventSubscriber *Funct, Boole CleanUpAfter) | ||
| Subscribes a functor object to this event. More... | |||
| EventSubscriberSlot * | Subscribe (const String &EventName, CFunctionSubscriberSlot::SubscriberFunction *CFunct) | ||
| Subscribes a C-style function to this event. More... | |||
| EventSubscriberSlot * | Subscribe (const String &EventName, Scripting::iScript *SubScript) | ||
| Subscribes a script to this event. More... | |||
| void | Unsubscribe (EventSubscriber *Subscriber) | ||
| Unsubscribes a single subscriber all events in this publisher. More... | |||
| void | Unsubscribe (FunctorEventSubscriber *Funct) | ||
| Unsubscribes a single subscriber all events in this publisher. More... | |||
| void | Unsubscribe (CFunctionSubscriberSlot::SubscriberFunction *CFunct) | ||
| Unsubscribes a single subscriber from all events in this publisher. More... | |||
| void | Unsubscribe (Scripting::iScript *SubScript) | ||
| Unsubscribes a single subscriber from all events in this publisher. More... | |||
| void | Unsubscribe (EventSubscriberSlot *SubSlot) | ||
| Unsubscribes a single subscriber from all events in this publisher. More... | |||
| void | Unsubscribe (const String &EventName, EventSubscriber *Subscriber) | ||
| Unsubscribes a single subscriber from the named event. More... | |||
| void | Unsubscribe (const String &EventName, FunctorEventSubscriber *Funct) | ||
| Unsubscribes a single subscriber from the named event. More... | |||
| void | Unsubscribe (const String &EventName, CFunctionSubscriberSlot::SubscriberFunction *CFunct) | ||
| Unsubscribes a single subscriber from the named event. More... | |||
| void | Unsubscribe (const String &EventName, Scripting::iScript *SubScript) | ||
| Unsubscribes a single subscriber from the named event. More... | |||
| void | Unsubscribe (const String &EventName, EventSubscriberSlot *SubSlot) | ||
| Unsubscribes a single subscriber from the named event. More... | |||
| Whole | UnsubscribeAll () | ||
| Unsubscribes all subscribers from all events in this publisher. More... | |||
| Whole | UnsubscribeAll (const String &EventName) | ||
| Unsubscribes all subscribers from the named Event. More... | |||
Static Public Member Functions | |
| static String | GetSerializableName () |
| Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More... | |
| Static Public Member Functions inherited from Mezzanine::UI::QuadRenderable | |
| static String | GetSerializableName () |
| Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More... | |
| Static Public Member Functions inherited from Mezzanine::UI::Renderable | |
| static String | GetSerializableName () |
| Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More... | |
Static Public Attributes | |
| static const String | EventFocusGained = "FocusGained" |
| Event name for when this widget gains focus. | |
| static const String | EventFocusLocked = "FocusLocked" |
| Event name for when the system locks focus on this widget. | |
| static const String | EventFocusLost = "FocusLost" |
| Event name for when this widget loses focus. | |
| static const String | EventFocusUnlocked = "FocusUnlocked" |
| Event name fow when the system removes the focus lock from this widget. | |
| static const String | EventMouseDragEnd = "MouseDragEnd" |
| Event name for when the mouse stops dragging this widget. | |
| static const String | EventMouseDragStart = "MouseDragStart" |
| Event name for when the mouse starts dragging this widget. | |
| static const String | EventMouseEnter = "MouseEnter" |
| Event name for when the mouse enters this widget. | |
| static const String | EventMouseExit = "MouseExit" |
| Event name for when the mouse leaves this widget. | |
| static const String | EventVisibilityHidden = "VisibilityHidden" |
| Event name for when this widget is switched from being shown to being hidden. | |
| static const String | EventVisibilityShown = "VisibilityShown" |
| Event name for when this widget is switched from being hidden to being shown. | |
| static const String | TypeName = "GenericWidget" |
| String containing the type name for this class: "GenericWidget". | |
Protected Member Functions | |
| void | ConstructWidget () |
| Contains all the common necessary startup initializations for this class. More... | |
| virtual void | HandleChildStateChangeImpl (Widget *Child, const UInt32 &OldState, const UInt32 &NewState) |
| Handles the logic to execute when a child of this widget has it's state updated. More... | |
| virtual Boole | HandleInputImpl (const Input::MetaCode &Code) |
| Consumes input for this widget's use. More... | |
| virtual void | ProtoDeSerializeImpl (const XML::Node &SelfRoot) |
| Implementation method for deseriailizing additional sets of data. More... | |
| virtual void | ProtoSerializeImpl (XML::Node &SelfRoot) const |
| Implementation method for serializing additional sets of data. More... | |
| Protected Member Functions inherited from Mezzanine::UI::QuadRenderable | |
| void | AppendLayerVertices (std::vector< VertexData > &Vertices) |
| Adds all the vertices belonging to all the layers of this renderable to the provided vector. More... | |
| RenderLayerGroup * | CreateRenderLayerGroupNoCheck (const UInt16 ID) |
| Creates a new RenderLayerGroup with the provided ID, without checking if it is unique. More... | |
| void | ResizeLayers (const Whole NewSize) |
| Resizes the container for RenderLayers in this QuadRenderable. More... | |
| Protected Member Functions inherited from Mezzanine::UI::Renderable | |
| Renderable (Screen *Parent) | |
| Blank constructor. More... | |
| Renderable (const String &RendName, Screen *Parent) | |
| Class constructor. More... | |
| virtual | ~Renderable () |
| Class destructor. | |
| Protected Member Functions inherited from Mezzanine::EventPublisher | |
| Event * | AddEvent (const String &EventName) |
| Creates a new event this Publisher can fire. More... | |
| void | FireEvent (EventArgumentsPtr Args) |
| Fires an event. More... | |
| void | RemoveAllEvents () |
| Removes all events in this Publisher. More... | |
| void | RemoveEvent (const String &EventName) |
| Removes an existing event in this Publisher. More... | |
| Protected Member Functions inherited from Mezzanine::EventSubscriber | |
| EventSubscriber () | |
| Class constructor. | |
| virtual | ~EventSubscriber () |
| Class destructor. | |
Protected Attributes | |
| Widget * | HoveredSubWidget |
| The child widget of this widget the mouse is over, if any. More... | |
| UInt32 | State |
| UInt32 describing the current state of this widget. More... | |
| StateLayerGroupMap | StateGroupBindings |
| Map containing all the RenderLayerGroups bound to specific widget states. More... | |
| Protected Attributes inherited from Mezzanine::UI::QuadRenderable | |
| Rect | ActDims |
| The actual (pixel) position and size of this Quad on the screen it belongs to. More... | |
| RenderLayerGroup * | ActiveGroup |
| This is a pointer to the group of RenderLayers currently being used for rendering. More... | |
| Boole | AllLayersDirty |
| Determines whether or not this Quad needs all of it's layers refreshed. Usually after a transform update. More... | |
| ChildContainer | ChildWidgets |
| This is a container storing all the children that belong to this Quad. More... | |
| LayoutStrategy * | LayoutStrat |
| This is a pointer to the strategy being used by this Quad to determine the positions and sizes of children during transform updates. More... | |
| Boole | ManualTransformUpdates |
| Controls whether or not this Quad and it's children will recieve automatic transform updates. More... | |
| Boole | MousePassthrough |
| Controls whether or not this Quad will be considered for mouse hover checks. More... | |
| QuadRenderable * | ParentQuad |
| This is a pointer to the Quad that owns this Quad and is responsible for transform updates applied to this Quad. More... | |
| PositioningInfo | PositioningPolicy |
| This stores all the information needed to determine the specific behaviors this Quad should have when it's position is being updated. More... | |
| RenderLayerGroupContainer | RenderLayerGroups |
| This is a container storing all the RenderLayerGroup instances created by and belonging to this Quad. More... | |
| RenderLayerContainer | RenderLayers |
| This is a container storing all the RenderLayer instances created by and belonging to this Quad. More... | |
| SizingInfo | SizingPolicy |
| This stores all the information needed to determine the specific behaviors this Quad should have when it's size is being updated. More... | |
| ScreenRenderData * | VertexCache |
| This is a pointer to the optional cache of vertex's belonging to this Quad and all of it's children. More... | |
| UInt16 | ZOrder |
| This is the ZOrder of this Quad in relation to all other Quads in it's parent. More... | |
| Protected Attributes inherited from Mezzanine::UI::Renderable | |
| Boole | Dirty |
| Stores whether this Renderables vertices need to be regenerated. More... | |
| String | Name |
| The unique name of this Renderable. More... | |
| Screen * | ParentScreen |
| A pointer to the Screen that created this Renderable. More... | |
| Boole | Visible |
| Stores whether this Renderable is to be rendered (also dependent on parent visibility). More... | |
| Protected Attributes inherited from Mezzanine::EventPublisher | |
| EventContainer | Events |
| A container storing all the Events published by this class by name. More... | |
| Boole | MuteEvents |
| Stores whether or not events will actually be fired when requested. More... | |
This is the base class for all widgets.
A widget is really a mechanism for implementing not-so-generic UI behaviors. They are control stuctures allowing UI elements to interact with each other and potentially classes outside the UI system(through the event system).
This class automatically creates a "Normal" and "Hovered" RenderLayerGroup that are used with the events of this class, these groups should be used and additional groups only made for special cases.
Instances of the Widget base class use the base LayoutStrategy.
| Mezzanine::UI::Widget::Widget | ( | Screen * | Parent | ) |
Blank constructor.
| Parent | The parent Screen that created this widget. |
Definition at line 70 of file widget.cpp.
Standard initialization constructor.
| RendName | The name to be given to this widget. |
| Parent | The parent Screen that created this widget. |
Definition at line 76 of file widget.cpp.
| Mezzanine::UI::Widget::Widget | ( | const String & | RendName, |
| const UnifiedRect & | RendRect, | ||
| Screen * | Parent | ||
| ) |
Rect constructor.
| RendName | The name to be given to this widget. |
| RendRect | The rect describing this widget's transform relative to it's parent. |
| Parent | The parent screen that created this widget. |
Definition at line 82 of file widget.cpp.
XML constructor.
| XMLNode | The node of the xml document to construct from. |
| Parent | The screen the created Widget will belong to. |
Definition at line 88 of file widget.cpp.
|
virtual |
Handles input passed to this widget.
| Code | The MetaCode to be processed. |
Definition at line 540 of file widget.cpp.
|
virtual |
Notifies this widget that a child (or grandchild) has had it's state updated.
| Child | A pointer to the child that was updated. |
| OldState | The pre-update state of the child. |
| NewState | The post-update state of the child. |
Definition at line 551 of file widget.cpp.
|
virtual |
Notifies this subscriber of an event being fired.
| Args | The arguments containing specific information regarding this event. |
Implements Mezzanine::EventSubscriber.
Reimplemented in Mezzanine::UI::Spinner, Mezzanine::UI::Scrollbar, and Mezzanine::UI::DropDownList.
Definition at line 558 of file widget.cpp.
|
virtual |
Self logic to be executed when focus is given to this widget.
Reimplemented in Mezzanine::UI::EditBox.
Definition at line 485 of file widget.cpp.
|
virtual |
Self logic to be executed when focus is locked to this widget.
Definition at line 507 of file widget.cpp.
|
virtual |
Self logic to be executed when focus is removed from this widget.
Reimplemented in Mezzanine::UI::EditBox.
Definition at line 496 of file widget.cpp.
|
virtual |
Self logic to be executed when focus is no longer locked to this widget.
Definition at line 513 of file widget.cpp.
|
virtual |
Self logic to be executed when the mouse cursor stops dragging across the bounds of this widget.
Reimplemented in Mezzanine::UI::EditBox.
Definition at line 474 of file widget.cpp.
|
virtual |
Self logic to be executed when the mouse cursor starts dragging across the bounds of this widget.
Reimplemented in Mezzanine::UI::EditBox.
Definition at line 463 of file widget.cpp.
|
virtual |
Self logic to be executed when the mouse cursor enters the bounds of this widget.
Reimplemented in Mezzanine::UI::Button.
Definition at line 441 of file widget.cpp.
|
virtual |
Self logic to be executed when the mouse cursor leaves the bounds of thiw widget.
Reimplemented in Mezzanine::UI::Button.
Definition at line 452 of file widget.cpp.
|
virtual |
Binds a RenderLayerGroup to a WidgetState.
| BindState | The WidgetState to be bound to. |
| ToBind | The RenderLayerGroup to be bound to the specified state. |
Definition at line 189 of file widget.cpp.
|
protected |
Contains all the common necessary startup initializations for this class.
Definition at line 122 of file widget.cpp.
|
virtual |
Forces a new state of this Widget.
| NewState | The new state to be applied. |
Definition at line 168 of file widget.cpp.
| Widget * Mezzanine::UI::Widget::GetBottomMostHoveredWidget | ( | ) |
Gets a pointer to the Widget at the bottom of the hovered SubWidget chain.
Definition at line 220 of file widget.cpp.
|
virtual |
Gets the most derived serializable name of this Renderable.
Reimplemented from Mezzanine::UI::QuadRenderable.
Definition at line 428 of file widget.cpp.
|
virtual |
Gets the current RenderLayerGroup bound to a specified WidgetState.
| BindState | The WidgetState bound to the RenderLayerGroup being retrieved. |
Definition at line 194 of file widget.cpp.
| Widget * Mezzanine::UI::Widget::GetHoveredSubWidget | ( | ) | const |
Gets the hovered sub-widget within this widget, if any.
Definition at line 215 of file widget.cpp.
|
virtual |
Gets the type of renderable this is.
Implements Mezzanine::UI::Renderable.
Definition at line 153 of file widget.cpp.
|
static |
Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized.
Definition at line 433 of file widget.cpp.
|
virtual |
Gets the current state of this Widget.
Definition at line 181 of file widget.cpp.
|
virtual |
Gets the type of widget this is.
Reimplemented in Mezzanine::UI::GridContainer, Mezzanine::UI::Spinner, Mezzanine::UI::Button, Mezzanine::UI::RadioButton, Mezzanine::UI::ListBox, Mezzanine::UI::MenuEntry, Mezzanine::UI::EditBox, Mezzanine::UI::CheckBox, Mezzanine::UI::TabSet, Mezzanine::UI::DropDownList, Mezzanine::UI::HorizontalContainer, Mezzanine::UI::HorizontalScrollbar, Mezzanine::UI::VerticalContainer, Mezzanine::UI::VerticalScrollbar, and Mezzanine::UI::StackButton.
Definition at line 156 of file widget.cpp.
|
virtual |
Gets the visibility setting of this renderable.
Implements Mezzanine::UI::Renderable.
Reimplemented in Mezzanine::UI::PagedContainer.
Definition at line 243 of file widget.cpp.
|
protectedvirtual |
Handles the logic to execute when a child of this widget has it's state updated.
| Child | A pointer to the child that was updated. |
| OldState | The pre-update state of the child. |
| NewState | The post-update state of the child. |
Reimplemented in Mezzanine::UI::PagedContainer.
Definition at line 117 of file widget.cpp.
|
protectedvirtual |
Consumes input for this widget's use.
| Code | The input to be processed. |
Reimplemented in Mezzanine::UI::Scrollbar, Mezzanine::UI::Button, Mezzanine::UI::ListBox, and Mezzanine::UI::EditBox.
Definition at line 112 of file widget.cpp.
|
virtual |
Gets whether or not this widget currently has focus.
Definition at line 162 of file widget.cpp.
|
virtual |
Forces this renderable to hide.
Implements Mezzanine::UI::Renderable.
Reimplemented in Mezzanine::UI::PagedContainer, Mezzanine::UI::MenuEntry, Mezzanine::UI::DropDownList, Mezzanine::UI::TabSet, Mezzanine::UI::HorizontalScrollbar, and Mezzanine::UI::VerticalScrollbar.
Definition at line 266 of file widget.cpp.
|
virtual |
Gets whether or not the system mouse is being dragged over this widget.
Definition at line 165 of file widget.cpp.
|
virtual |
Gets the result of the last mouse hover check.
Definition at line 159 of file widget.cpp.
|
virtual |
Gets whether or not this renderable is being drawn.
This function will check the visibility of all parent objects to see if it is being drawn. This will not tell you whether or not this renderable has it's own visibility setting enabled. For that see: GetVisible().
Implements Mezzanine::UI::Renderable.
Reimplemented in Mezzanine::UI::PagedContainer.
Definition at line 248 of file widget.cpp.
|
virtual |
Take the data stored in an XML Node and overwrite the Events of this object with it.
| SelfRoot | An XML::Node containing the data to populate this class with. |
Definition at line 397 of file widget.cpp.
|
protectedvirtual |
Implementation method for deseriailizing additional sets of data.
| SelfRoot | An XML::Node containing the data to populate this class with. |
Reimplemented from Mezzanine::UI::QuadRenderable.
Reimplemented in Mezzanine::UI::GridContainer, Mezzanine::UI::PagedContainer, Mezzanine::UI::RadioButton, Mezzanine::UI::TabSet, and Mezzanine::UI::PageProvider.
Definition at line 105 of file widget.cpp.
|
virtual |
Take the data stored in an XML Node and overwrite the properties of this object with it.
| SelfRoot | An XML::Node containing the data to populate this class with. |
Reimplemented from Mezzanine::UI::QuadRenderable.
Reimplemented in Mezzanine::UI::GridContainer, Mezzanine::UI::PagedContainer, Mezzanine::UI::Spinner, Mezzanine::UI::ListBox, Mezzanine::UI::Scrollbar, Mezzanine::UI::Button, Mezzanine::UI::RadioButton, Mezzanine::UI::MenuEntry, Mezzanine::UI::EditBox, Mezzanine::UI::TabSet, Mezzanine::UI::DropDownList, Mezzanine::UI::LinearContainer, Mezzanine::UI::CheckBox, Mezzanine::UI::HorizontalContainer, Mezzanine::UI::VerticalContainer, Mezzanine::UI::LayoutContainer, Mezzanine::UI::StackButton, and Mezzanine::UI::StackedContainer.
Definition at line 337 of file widget.cpp.
|
virtual |
Take the data stored in an XML Node and overwrite the state-group bindings of this object with it.
| SelfRoot | An XML::Node containing the data to populate this class with. |
Definition at line 357 of file widget.cpp.
|
virtual |
Convert the Events of this class to an XML::Node ready for serialization.
| SelfRoot | The root node containing all the serialized data for this instance. |
Definition at line 315 of file widget.cpp.
|
protectedvirtual |
Implementation method for serializing additional sets of data.
| SelfRoot | The root node containing all the serialized data for this instance. |
Reimplemented from Mezzanine::UI::QuadRenderable.
Reimplemented in Mezzanine::UI::GridContainer, Mezzanine::UI::PagedContainer, Mezzanine::UI::RadioButton, Mezzanine::UI::TabSet, and Mezzanine::UI::PageProvider.
Definition at line 97 of file widget.cpp.
|
virtual |
Convert the properties of this class to an XML::Node ready for serialization.
| SelfRoot | The root node containing all the serialized data for this instance. |
Reimplemented from Mezzanine::UI::QuadRenderable.
Reimplemented in Mezzanine::UI::GridContainer, Mezzanine::UI::PagedContainer, Mezzanine::UI::Spinner, Mezzanine::UI::ListBox, Mezzanine::UI::Scrollbar, Mezzanine::UI::Button, Mezzanine::UI::MenuEntry, Mezzanine::UI::RadioButton, Mezzanine::UI::EditBox, Mezzanine::UI::TabSet, Mezzanine::UI::DropDownList, Mezzanine::UI::LinearContainer, Mezzanine::UI::CheckBox, Mezzanine::UI::HorizontalContainer, Mezzanine::UI::VerticalContainer, Mezzanine::UI::LayoutContainer, Mezzanine::UI::StackButton, and Mezzanine::UI::StackedContainer.
Definition at line 278 of file widget.cpp.
|
virtual |
Convert the state-group bindings of this class to an XML::Node ready for serialization.
| SelfRoot | The root node containing all the serialized data for this instance. |
Definition at line 292 of file widget.cpp.
Sets the group bound to the specified WidgetState as active.
| BindState | The WidgetState bound to the RenderLayerGroup being set. |
Definition at line 201 of file widget.cpp.
|
virtual |
Sets the visibility of this renderable.
| CanSee | Boole determining whether or not this renderable should be visible. |
Implements Mezzanine::UI::Renderable.
Reimplemented in Mezzanine::UI::PagedContainer, Mezzanine::UI::MenuEntry, Mezzanine::UI::DropDownList, Mezzanine::UI::TabSet, Mezzanine::UI::HorizontalScrollbar, and Mezzanine::UI::VerticalScrollbar.
Definition at line 229 of file widget.cpp.
|
virtual |
Forces this renderable to be shown.
Implements Mezzanine::UI::Renderable.
Reimplemented in Mezzanine::UI::PagedContainer, Mezzanine::UI::MenuEntry, Mezzanine::UI::DropDownList, Mezzanine::UI::TabSet, Mezzanine::UI::HorizontalScrollbar, and Mezzanine::UI::VerticalScrollbar.
Definition at line 257 of file widget.cpp.
|
protected |
|
protected |
|
protected |
1.8.9.1. Thanks to the
Open Icon Library
for help with some of the icons.
