MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Mezzanine::UI::VerticalContainer Class Reference

A layout container that aligns it's children along a common Y axis. More...

#include <verticalcontainer.h>

+ Inheritance diagram for Mezzanine::UI::VerticalContainer:
+ Collaboration diagram for Mezzanine::UI::VerticalContainer:

Public Member Functions

 VerticalContainer (Screen *Parent)
 Blank constructor. More...
 
 VerticalContainer (const String &RendName, Screen *Parent)
 Standard initialization constructor. More...
 
 VerticalContainer (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
 Rect constructor. More...
 
 VerticalContainer (const XML::Node &XMLNode, Screen *Parent)
 XML constructor. More...
 
virtual ~VerticalContainer ()
 Class destructor.
 
virtual const StringGetTypeName () const
 Gets the type of widget this is. 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 ProtoSerializeProperties (XML::Node &SelfRoot) const
 Convert the properties of this class to an XML::Node ready for serialization. More...
 
virtual void SetProviders (PageProvider *XProv, PageProvider *YProv)
 Sets the page providers for both axes. More...
 
virtual void SetScrollbarProvider (VerticalScrollbar *Prov)
 Convenience method for configuring a VerticalScrollbar as the page provider for this container. More...
 
virtual void SetSpinnerProvider (Spinner *Prov)
 Convenience method for configuring a Spinner as the page provider for this container. More...
 
virtual void SetXProvider (PageProvider *XProv)
 Sets the PageProvider for the X axis. More...
 
virtual void SetYProvider (PageProvider *YProv)
 Sets the PageProvider for the Y axis. More...
 
- Public Member Functions inherited from Mezzanine::UI::LinearContainer
 LinearContainer (Screen *Parent)
 Blank constructor. More...
 
 LinearContainer (const String &RendName, Screen *Parent)
 Standard initialization constructor. More...
 
 LinearContainer (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
 Rect constructor. More...
 
virtual ~LinearContainer ()
 Class destructor.
 
virtual void AddChild (Widget *Child)
 Adds a Widget to this as a child of this quad. More...
 
virtual const SizingInfoGetChildSize () const
 Gets the size to be given to children processed by this container if forced sizing is enabled. More...
 
virtual Whole GetChildSizeEnforcement () const
 Gets when the set child sizing will be applied to any given child. More...
 
virtual const UnifiedDimGetPadding () const
 Gets the spacing being split between both sides of each child quad on the relevant axis. More...
 
virtual UI::LinearAlignment GetVisibleChildAlignment () const
 Gets the alignment for visible children of this container when they don't take up all the visible space provided by the container. More...
 
virtual void SetChildSize (const SizingInfo &ForcedSize)
 Sets the size to be given to children processed by this container if forced sizing is enabled. More...
 
virtual void SetChildSizeEnforcement (const Whole Enforcement)
 Sets when the set child sizing will be applied to any given child. More...
 
virtual void SetChildSizing (const SizingInfo &ForcedSize, const Whole Enforcement)
 Sets both the size and enforcement rules for forced child sizing in this container. More...
 
virtual void SetPadding (const UnifiedDim &Padding)
 Sets the spacing to be split between both sides of each child quad on the relevant axis. More...
 
virtual void SetVisibleChildAlignment (const UI::LinearAlignment ChildAlign)
 Sets the alignment for visible children of this container when they don't take up all the visible space provided by the container. More...
 
- Public Member Functions inherited from Mezzanine::UI::PagedContainer
 PagedContainer (Screen *Parent)
 Blank constructor. More...
 
 PagedContainer (const String &RendName, Screen *Parent)
 Standard initialization constructor. More...
 
 PagedContainer (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
 Rect constructor. More...
 
virtual ~PagedContainer ()
 Class destructor.
 
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 _NotifyEvent (const EventArguments &Args)
 Notifies this subscriber of an event being fired. More...
 
virtual void _OnChildFocusGained (const String &ChildName)
 Self logic to be executed when focus is given to a child of this widget. More...
 
virtual Vector2 GetActualWorkAreaSize () const
 Gets the size of this containers work area in pixels. More...
 
virtual WidgetGetLastFocusedWidget () const
 Gets a pointer to the last focused child widget in this container. More...
 
virtual ProviderMode GetProviderConfig () const
 Gets the current provider configuration of this container. More...
 
virtual ProviderMode GetProviderConfig (const PageProvider *Prov) const
 Gets the role of the specified PageProvider in this container. More...
 
virtual const UnifiedVec2GetWorkAreaSize () const
 Gets the size of this containers work area. More...
 
virtual PageProviderGetXProvider () const
 Gets the PageProvider for the X axis. More...
 
virtual PageProviderGetYProvider () const
 Gets the PageProvider for the Y axis. More...
 
virtual void ProtoDeSerializePageData (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite the PageProvider data of this object with it. More...
 
virtual void ProtoSerializePageData (XML::Node &SelfRoot) const
 Convert the PageProvider data of this class to an XML::Node ready for serialization. More...
 
virtual void RemoveAllChildren ()
 Removes all child Widgets from this QuadRenderable. More...
 
virtual void RemoveChild (Widget *Child)
 Removes a child Widget by pointer. More...
 
virtual void SetWorkAreaSize (const UnifiedVec2 &Area)
 Sets the size of this containers work area. More...
 
virtual void UnbindProvider (PageProvider *Prov)
 Unbinds a provider being used by this container. 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::Widget
virtual bool _HandleInput (const Input::MetaCode &Code)
 Handles input passed to this widget. 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 _OnMouseDragging ()
 Self logic to be executed when the mouse cursor is 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...
 
WidgetGetBottomMostHoveredWidget ()
 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 RenderLayerGroupGetGroupBoundToState (const UInt32 BindState) const
 Gets the current RenderLayerGroup bound to a specified WidgetState. More...
 
WidgetGetHoveredSubWidget () const
 Gets the hovered sub-widget within this widget, if any. More...
 
RenderableType GetRenderableType () const
 Gets the type of renderable this is. More...
 
virtual Boolean GetVisible () const
 Gets the visibility setting of this renderable. More...
 
virtual Boolean HasFocus () const
 Gets whether or not this widget currently has focus. More...
 
virtual void Hide ()
 Forces this renderable to hide. More...
 
virtual Boolean IsBeingDragged () const
 Gets whether or not this widget is being dragged. More...
 
virtual Boolean IsHovered () const
 Gets the result of the last mouse hover check. More...
 
virtual Boolean 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 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 ProtoSerializeStateGroupBindings (XML::Node &SelfRoot) const
 Convert the state-group bindings of this class to an XML::Node ready for serialization. More...
 
virtual bool SetGroupFromState (const UInt32 BindState)
 Sets the group bound to the specified WidgetState as active. More...
 
virtual void SetVisible (Boolean CanSee)
 
virtual void Show ()
 Forces this renderable to be shown. More...
 
- Public Member Functions inherited from Mezzanine::UI::QuadRenderable
virtual void _AppendRenderData (ScreenRenderData &RenderData)
 Appends the vertices of this renderable to another vector. More...
 
virtual Boolean _HasAvailableRenderData () const
 Checks if there are available render data from this QuadRenderable (or it's subrenderables). 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 _SetZOrder (const UInt16 &Zorder)
 Ssts the ZOrder value for this renderable. More...
 
virtual void AddChild (Widget *Child, const UInt16 ZOrder)
 Adds a Widget to this as a child of this quad. More...
 
void AddLayerToGroup (RenderLayer *Layer, const UInt16 ZOrder, const String &GroupName)
 Adds a RenderLayer to the specified group. More...
 
void AddLayerToGroups (RenderLayer *Layer, const GroupOrderEntryVector &Entrys)
 Adds a RenderLayer to multiple groups. More...
 
virtual Boolean 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...
 
ImageLayerCreateImageLayer ()
 Creates an ImageLayer for this renderable. More...
 
ImageLayerCreateImageLayer (const UInt16 ZOrder, const String &GroupName)
 Creates an ImageLayer for this renderable and adds it to a RenderLayerGroup. More...
 
ImageLayerCreateImageLayer (const GroupOrderEntryVector &Entrys)
 Creates an ImageLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
 
MultiLineTextLayerCreateMultiLineTextLayer ()
 Creats a MultiLineTextLayer for this renderable. More...
 
MultiLineTextLayerCreateMultiLineTextLayer (const UInt16 ZOrder, const String &GroupName)
 Creats a MultiLineTextLayer for this renderable. More...
 
MultiLineTextLayerCreateMultiLineTextLayer (const GroupOrderEntryVector &Entrys)
 Creates a MultiLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
 
MultiLineTextLayerCreateMultiLineTextLayer (const String &FontName)
 Creats a MultiLineTextLayer for this renderable. More...
 
MultiLineTextLayerCreateMultiLineTextLayer (const String &FontName, const UInt16 ZOrder, const String &GroupName)
 Creats a MultiLineTextLayer for this renderable. More...
 
MultiLineTextLayerCreateMultiLineTextLayer (const String &FontName, const GroupOrderEntryVector &Entrys)
 Creates a MultiLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
 
MultiLineTextLayerCreateMultiLineTextLayer (const Real &LineHeight)
 Creats a MultiLineTextLayer for this renderable. More...
 
MultiLineTextLayerCreateMultiLineTextLayer (const Real &LineHeight, const UInt16 ZOrder, const String &GroupName)
 Creats a MultiLineTextLayer for this renderable. More...
 
MultiLineTextLayerCreateMultiLineTextLayer (const Real &LineHeight, const GroupOrderEntryVector &Entrys)
 Creates a MultiLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
 
RenderLayerGroupCreateOrRetrieveRenderLayerGroup (const String &Name)
 Gets the named RenderLayerGroup or creates one with the specified name if it does not exist. More...
 
RenderLayerGroupCreateRenderLayerGroup (const String &Name)
 Creates a new RenderLayerGroup that can have.

Exceptions
Thisfunction will throw an exception if a group already exists with the provided name.
More...
 
SingleLineTextLayerCreateSingleLineTextLayer ()
 Creats a SingleLineTextLayer for this renderable. More...
 
SingleLineTextLayerCreateSingleLineTextLayer (const UInt16 ZOrder, const String &GroupName)
 Creats a SingleLineTextLayer for this renderable. More...
 
SingleLineTextLayerCreateSingleLineTextLayer (const GroupOrderEntryVector &Entrys)
 Creates a SingleLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
 
SingleLineTextLayerCreateSingleLineTextLayer (const String &FontName)
 Creats a SingleLineTextLayer for this renderable. More...
 
SingleLineTextLayerCreateSingleLineTextLayer (const String &FontName, const UInt16 ZOrder, const String &GroupName)
 Creats a SingleLineTextLayer for this renderable. More...
 
SingleLineTextLayerCreateSingleLineTextLayer (const String &FontName, const GroupOrderEntryVector &Entrys)
 Creates a SingleLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
 
SingleLineTextLayerCreateSingleLineTextLayer (const Real &LineHeight)
 Creats a SingleLineTextLayer for this renderable. More...
 
SingleLineTextLayerCreateSingleLineTextLayer (const Real &LineHeight, const UInt16 ZOrder, const String &GroupName)
 Creats a SingleLineTextLayer for this renderable. More...
 
SingleLineTextLayerCreateSingleLineTextLayer (const Real &LineHeight, const GroupOrderEntryVector &Entrys)
 Creates a SingleLineTextLayer for this renderable and adds it to all the specified RenderLayerGroups at the provided ZOrders. More...
 
void DestroyAllRenderLayerGroups ()
 Destroy's all RenderLayerGroups being stored/managed by this QuadRenderable.
 
void DestroyAllRenderLayers ()
 Destroys all RenderLayers being stored by this renderable.
 
void DestroyRenderLayer (RenderLayer *ToBeDestroyed)
 Destroys a RenderLayer being stored by this renderable. More...
 
void DestroyRenderLayerGroup (const String &Name)
 Destroy's a RenderLayerGroup by name. More...
 
void DestroyRenderLayerGroup (RenderLayerGroup *ToBeDestroyed)
 Destroy's a RenderLayerGroup by pointer. More...
 
RenderLayerGroupGetActiveGroup () 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 WidgetGetChild (const UInt16 Zorder) const
 Gets a child by it's ZOrder. More...
 
virtual WidgetGetChild (const String &RendName) const
 Gets a child by it's name. More...
 
virtual UI::SizingRules 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 bool 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 bool GetMousePassthrough () const
 Gets whether or not Mouse Passthrough is enabled. More...
 
QuadRenderableGetNextSibling (Boolean 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...
 
QuadRenderableGetParent () const
 Gets the parent of this quad. More...
 
virtual const PositioningInfoGetPositioningPolicy () const
 Gets the current behavior this QuadRenderable will use when it is positioned. More...
 
virtual UI::PositioningFlags GetPositioningRules () const
 Gets the current behavior this quad will follow when it is positioned automatically. More...
 
QuadRenderableGetPrevSibling (Boolean 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...
 
RenderLayerGetRenderLayer (const UInt32 &Index) const
 Gets a RenderLayer belonging to this QuadRenderable by index. More...
 
RenderLayerGroupGetRenderLayerGroup (const String &Name) const
 Gets a RenderLayerGroup by name. More...
 
virtual UI::RenderPriority GetRenderPriority () const
 Gets the priority this QuadRenderable should be rendered with. More...
 
virtual const SizingInfoGetSizingPolicy () const
 Gets the current behavior this QuadRenderable will use when it is sized. More...
 
virtual QuadRenderableGetTopMostQuad ()
 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 UI::SizingRules GetVerticalSizingRules () const
 Gets the current behavior this quad will follow for the Y axis when it is resized. More...
 
virtual const UInt16GetZOrder () const
 Gets the currently set ZOrder of this QuadRenderable with it's parent. More...
 
virtual Boolean IsChildOfScreen () const
 Gets whether or not this QuadRenderable is a direct child of it's screen. More...
 
virtual Boolean IsInside (const Vector2 &Point) const
 Checks to see if a point in 2D space is inside this quad. More...
 
Boolean IsVertexCachingEnabled () const
 Gets whether or not vertex caching is enabled for 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...
 
void RemoveLayerFromAllGroups (RenderLayer *Layer)
 Removes a single RenderLayer from all RenderLayerGroups owned by this QuadRenderable. More...
 
void RemoveLayerFromGroup (RenderLayer *Layer, const String &GroupName)
 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...
 
Boolean RenderLayerGroupExists (const String &Name) const
 Checks to see if a RenderLayerGroup exists. More...
 
void SetActiveGroup (const String &Name)
 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 SetHorizontalSizingRules (const UI::SizingRules Rules)
 Sets the behavior this quad will have on the X axis when it is resized. More...
 
void SetLocalVertexCaching (Boolean Enable)
 Enables or disables caching of vertex's belonging to this and all child renderables. More...
 
virtual void SetManualTransformUpdates (Boolean 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 (Boolean 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 SetPositioningRules (const UI::PositioningFlags Rules)
 Sets the behavior this quad will have when it is positioned automatically. More...
 
virtual void SetRenderPriority (const UI::RenderPriority RP)
 Sets the priority this QuadRenderable should be rendered with. More...
 
virtual void SetRenderPriorityCascading (const UI::RenderPriority RP)
 Sets the priority this QuadRenderable and all it's children should be rendered with. 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 SetVerticalSizingRules (const UI::SizingRules 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 UpdateDimensions ()
 Updates the dimensions of this QuadRenderable based on the transform of it's parent. More...
 
- Public Member Functions inherited from Mezzanine::UI::Renderable
bool _IsDirty () const
 Gets whether or not this renderable is dirty. More...
 
const StringGetName () const
 Gets the name of this renderable. More...
 
ScreenGetScreen () const
 Gets the parent screen of this renderable. More...
 
- Public Member Functions inherited from Mezzanine::EventPublisher
 EventPublisher ()
 Class constructor.
 
virtual ~EventPublisher ()
 Class destructor.
 
EventGetEvent (const String &EventName) const
 Gets an event in this publisher. More...
 
EventGetEventExcept (const String &EventName) const
 Gets an event in this publisher.

Exceptions
Thisversion differs from the non-except version in that if it fails to find the event specified it will throw a "II_IDENTITY_NOT_FOUND_EXCEPTION".
More...
 
EventSubscriberSlotSubscribe (const String &EventName, EventSubscriber *Sub)
 Adds a subscriber to this event. More...
 
EventSubscriberSlotSubscribe (const String &EventName, FunctorSubscriberSlot::FunctorDefinition *Funct, Boolean CleanUpAfter)
 Subscribes a functor object to this event. More...
 
EventSubscriberSlotSubscribe (const String &EventName, CFunctionSubscriberSlot::SubscriberFunction *CFunct)
 Subscribes a C-style function to this event. More...
 
EventSubscriberSlotSubscribe (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 (FunctorSubscriberSlot::FunctorDefinition *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, FunctorSubscriberSlot::FunctorDefinition *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::LinearContainer
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::PagedContainer
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::Widget
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 TypeName = "VerticalContainer"
 String containing the type name for this class: "VerticalContainer".
 

Protected Member Functions

virtual void UpdateContainerDimensionsImpl (const Rect &OldSelfRect, const Rect &NewSelfRect)
 The container specific logic for updating it's dimensions. More...
 
- Protected Member Functions inherited from Mezzanine::UI::LinearContainer
virtual void UpdateInvisibleChild (const Rect &OldSelfRect, const Rect &NewSelfRect, QuadRenderable *InvisibleChild)
 Updates a child that hasn't been selected to be visible. More...
 
- Protected Member Functions inherited from Mezzanine::UI::PagedContainer
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::Widget
 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.
 
void ConstructWidget ()
 Contains all the common necessary startup initializations for this class. More...
 
virtual Boolean HandleInputImpl (const Input::MetaCode &Code)
 Consumes input for this widget's use. More...
 
- Protected 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...
 
void AppendLayerVertices (std::vector< VertexData > &Vertices)
 Adds all the vertices belonging to all the layers of this renderable to the provided vector. More...
 
void CleanLayers ()
 Redraws all dirty layers. 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
EventAddEvent (const String &EventName)
 Creates a new event this Publisher can fire. More...
 
void FireEvent (const EventArguments &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.
 

Additional Inherited Members

- Public Types inherited from Mezzanine::UI::LinearContainer
enum  SizeEnforcement { SE_None = 0, SE_OnAdd = 1, SE_OnUpdate = 2 }
 This enum is used to determine if and when a child should be forced to a specific size for this container. More...
 
- Protected Attributes inherited from Mezzanine::UI::LinearContainer
SizingInfo ChildSizing
 The size given to children layed out by this container. More...
 
Whole ForcedSizingRules
 The current enforcement for child size in this container. More...
 
UnifiedDim LinearPadding
 The amount of space to add to both sides of a child object on the relevant axis. More...
 
UI::LinearAlignment VisibleChildAlign
 The alignment to be given to the sequence of children visible in this container. More...
 

Detailed Description

A layout container that aligns it's children along a common Y axis.

Definition at line 56 of file verticalcontainer.h.

Constructor & Destructor Documentation

Mezzanine::UI::VerticalContainer::VerticalContainer ( Screen Parent)

Blank constructor.

Parameters
ParentThe parent Screen that created this widget.

Definition at line 58 of file verticalcontainer.cpp.

Mezzanine::UI::VerticalContainer::VerticalContainer ( const String RendName,
Screen Parent 
)

Standard initialization constructor.

Parameters
RendNameThe name to be given to this renderable.
ParentThe parent Screen that created this widget.

Definition at line 62 of file verticalcontainer.cpp.

Mezzanine::UI::VerticalContainer::VerticalContainer ( const String RendName,
const UnifiedRect RendRect,
Screen Parent 
)

Rect constructor.

Parameters
RendNameThe name to be given to this renderable.
RendRectThe rect describing this widget's transform relative to it's parent.
ParentThe parent screen that created this renderable.

Definition at line 66 of file verticalcontainer.cpp.

Mezzanine::UI::VerticalContainer::VerticalContainer ( const XML::Node XMLNode,
Screen Parent 
)

XML constructor.

Parameters
XMLNodeThe node of the xml document to construct from.
ParentThe screen the created VerticalContainer will belong to.

Definition at line 70 of file verticalcontainer.cpp.

Member Function Documentation

String Mezzanine::UI::VerticalContainer::GetSerializableName ( )
static

Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized.

Returns
A string containing the name of this class.

Definition at line 213 of file verticalcontainer.cpp.

const String & Mezzanine::UI::VerticalContainer::GetTypeName ( ) const
virtual

Gets the type of widget this is.

Returns
Returns a const String reference representing the type of widget this is.

Reimplemented from Mezzanine::UI::Widget.

Definition at line 172 of file verticalcontainer.cpp.

void Mezzanine::UI::VerticalContainer::ProtoDeSerializeProperties ( const XML::Node SelfRoot)
virtual

Take the data stored in an XML Node and overwrite the properties of this object with it.

Parameters
SelfRootAn XML::Node containing the data to populate this class with.

Reimplemented from Mezzanine::UI::LinearContainer.

Definition at line 208 of file verticalcontainer.cpp.

void Mezzanine::UI::VerticalContainer::ProtoSerializeProperties ( XML::Node SelfRoot) const
virtual

Convert the properties of this class to an XML::Node ready for serialization.

Parameters
SelfRootThe root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::UI::LinearContainer.

Definition at line 203 of file verticalcontainer.cpp.

void Mezzanine::UI::VerticalContainer::SetProviders ( PageProvider XProv,
PageProvider YProv 
)
virtual

Sets the page providers for both axes.

Parameters
XProvThe PageProvider controlling the current horizontal page.
YProvThe PageProvider controlling the current vertical page.

Implements Mezzanine::UI::PagedContainer.

Definition at line 175 of file verticalcontainer.cpp.

void Mezzanine::UI::VerticalContainer::SetScrollbarProvider ( VerticalScrollbar Prov)
virtual

Convenience method for configuring a VerticalScrollbar as the page provider for this container.

Parameters
ProvA pointer to the VerticalScrollbar which will determine which page this container is rendering.

Definition at line 191 of file verticalcontainer.cpp.

void Mezzanine::UI::VerticalContainer::SetSpinnerProvider ( Spinner Prov)
virtual

Convenience method for configuring a Spinner as the page provider for this container.

Parameters
ProvA pointer to the Spinner which will determine which page this container is rendering.

Definition at line 194 of file verticalcontainer.cpp.

void Mezzanine::UI::VerticalContainer::SetXProvider ( PageProvider XProv)
virtual

Sets the PageProvider for the X axis.

Parameters
XProvThe PageProvider controlling the current horizontal page.

Implements Mezzanine::UI::PagedContainer.

Definition at line 178 of file verticalcontainer.cpp.

void Mezzanine::UI::VerticalContainer::SetYProvider ( PageProvider YProv)
virtual

Sets the PageProvider for the Y axis.

Parameters
YProvThe PageProvider controlling the current vertical page.

Implements Mezzanine::UI::PagedContainer.

Definition at line 181 of file verticalcontainer.cpp.

void Mezzanine::UI::VerticalContainer::UpdateContainerDimensionsImpl ( const Rect OldSelfRect,
const Rect NewSelfRect 
)
protectedvirtual

The container specific logic for updating it's dimensions.

Implements Mezzanine::UI::PagedContainer.

Definition at line 77 of file verticalcontainer.cpp.


The documentation for this class was generated from the following files: