Mezzanine::UI::PagedContainer Class Reference

This is the base class for containers that have a render area and work area of different sizes. More...

#include <pagedcontainer.h>

Inheritance diagram for Mezzanine::UI::PagedContainer:

Collaboration diagram for Mezzanine::UI::PagedContainer:

Public Types
typedef VisibleChildContainer::const_iterator	ConstVisibleChildIterator
	Const Iterator type for Visible Widget instances stored by this class.
enum	ProviderMode {   PM_Error = 0, PM_Single_X = 1, PM_Single_Y = 2, PM_Single_XY = 3,   PM_Dual_XY = 4 }
	An enum describing how the providers for this container are configured and being used. More...
typedef std::vector< Widget * >	VisibleChildContainer
	Basic container type for Visible Widget storage by this class.
typedef VisibleChildContainer::iterator	VisibleChildIterator
	Iterator type for Visible Widget instances stored by this class.
Public Types inherited from Mezzanine::UI::Widget
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
	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	_OnChildSelected (const String &ChildName, const Boole Selected)
	Self logic to be executed when focus is given to a child of this widget. 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...
virtual void	ClearSelectedChild ()
	Forces the currently selected child to become deselected.
virtual void	DestroyAllChildren ()
	Destroys all child Widgets currently inside this QuadRenderable. More...
virtual void	DestroyChild (Widget *ToBeDestroyed)
	Destroys a child Widget currently inside this QuadRenderable. More...
virtual Widget *	GetLastSelectedChild () const
	Gets a pointer to the last selected 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 Boole	GetVisible () const
	Gets the visibility setting of this renderable. More...
virtual const Vector2 &	GetWorkAreaSize () const
	Gets the size of this containers work area. More...
virtual PageProvider *	GetXProvider () const
	Gets the PageProvider for the X axis. More...
virtual PageProvider *	GetYProvider () const
	Gets the PageProvider for the Y axis. More...
virtual void	Hide ()
	Forces this renderable to hide. More...
virtual Boole	IsVisible () const
	Gets whether or not this renderable is being drawn. 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	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	ProtoSerializePageData (XML::Node &SelfRoot) const
	Convert the PageProvider data 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	QuickUpdateWorkAreaSize (const UnifiedVec2 &ChildSize, Boole Adding)=0
	Quickly updates the work area size based on a single childs' dimensions. 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...
virtual void	SetProviders (PageProvider *XProv, PageProvider *YProv)=0
	Sets the page providers for both axes. More...
virtual void	SetVisible (Boole CanSee)
	Sets the visibility of this renderable. More...
virtual void	SetXProvider (PageProvider *XProv)=0
	Sets the PageProvider for the X axis. More...
virtual void	SetXYProvider (PageProvider *Prov)
	Sets a single PageProvider as the provider for both the X and Y axis. More...
virtual void	SetYProvider (PageProvider *YProv)=0
	Sets the PageProvider for the Y axis. More...
virtual void	Show ()
	Forces this renderable to be shown. 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...
virtual void	UpdateVisibleChildren ()
	Forces an update of the visible children in this container.
virtual void	UpdateWorkAreaSize ()=0
	Checks the size of every child in this container and updates the work area to match the size needed. More...
Public 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.
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	HasFocus () const
	Gets whether or not this widget currently has focus. 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 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 Boole	SetGroupFromState (const UInt32 BindState)
	Sets the group bound to the specified WidgetState as active. 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	_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...
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. Exceptions This function will throw an exception if a group already exists with the provided name. More...
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...
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 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...
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...
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. Exceptions This version 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...
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::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	EventChildSelected = "ChildSelected"
	Event name for when a child of this widget gets selected.
static const String	TypeName = "PagedContainer"
	String containing the type name for this class: "PagedContainer".
Static Public Attributes inherited from Mezzanine::UI::Widget
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
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 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...
virtual void	UpdateContainerDimensionsImpl (const Rect &OldSelfRect, const Rect &NewSelfRect)=0
	The container specific logic for updating it's dimensions. More...
Protected Member Functions inherited from Mezzanine::UI::Widget
void	ConstructWidget ()
	Contains all the common necessary startup initializations for this class. More...
virtual Boole	HandleInputImpl (const Input::MetaCode &Code)
	Consumes input for this widget's use. 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 *	LastSelectedChild
	A pointer to the last child widget that was selected within this container. More...
VisibleChildContainer	VisibleChildren
	A container of children that meet the criteria for rendering in this container. More...
Vector2	WorkAreaSize
	Vector2 storing the size for all pages of this container. More...
PageProvider *	XProvider
	A pointer to the X axis provider. More...
PageProvider *	YProvider
	A pointer to the Y axis provider. More...
Protected Attributes inherited from Mezzanine::UI::Widget
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...

Detailed Description

This is the base class for containers that have a render area and work area of different sizes.

The central premise of all PagedLayoutContainers is that their render dimensions does not accurately express their total dimensions, or "work area" where widgets can be placed. The work area of a PagedLayoutContainer can be nagivated via a small selection of specific widgets.

Definition at line 121 of file pagedcontainer.h.

Member Enumeration Documentation

enum Mezzanine::UI::PagedContainer::ProviderMode

An enum describing how the providers for this container are configured and being used.

Depending on the method returning the values, these values can mean slightly different things. The documentation provided below describes the meaning when querying the overall configuration first, and the second description describes what it means when an individual provider is queried on a given container.

Enumerator
PM_Error	The PageProvider configuration is invalid, or the queried PageProvider isn't in use by the container.
PM_Single_X	There is only one PageProvider providing pages for the X axis of this container, or the queried provider is being used only for the X axis by the container.
PM_Single_Y	There is only one PageProvider providing pages for the Y axis of this container, or the queried provider is being used only for the Y axis by the container.
PM_Single_XY	There is only one PageProvider providing pages for both the X and Y axes of this container, or the queried provider is being used for both the X and Y axes be the container.
PM_Dual_XY	There are two different PageProviders each providing pages for their respective axis. This value isn't returned by a provider query.

Definition at line 135 of file pagedcontainer.h.

Constructor & Destructor Documentation

Mezzanine::UI::PagedContainer::PagedContainer

(

Screen *

Parent

)

Blank constructor.

Parameters

Parent

The parent Screen that created this widget.

Definition at line 62 of file pagedcontainer.cpp.

Mezzanine::UI::PagedContainer::PagedContainer	(	const String &	RendName,
		Screen *	Parent
	)

Standard initialization constructor.

Parameters

RendName	The name to be given to this renderable.
Parent	The parent Screen that created this widget.

Definition at line 69 of file pagedcontainer.cpp.

Mezzanine::UI::PagedContainer::PagedContainer	(	const String &	RendName,
		const UnifiedRect &	RendRect,
		Screen *	Parent
	)

Rect constructor.

Parameters

RendName	The name to be given to this renderable.
RendRect	The rect describing this widget's transform relative to it's parent.
Parent	The parent screen that created this renderable.

Definition at line 76 of file pagedcontainer.cpp.

Member Function Documentation

void Mezzanine::UI::PagedContainer::_AppendRenderDataCascading ( ScreenRenderData &  RenderData )

virtual

Appends the vertices of this renderable to another vector, and then does the same for this renderable's children.

Parameters

RenderData

The vector of vertex's to append to.

Reimplemented from Mezzanine::UI::QuadRenderable.

Definition at line 496 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::_OnChildSelected ( const String &  ChildName, const Boole  Selected  )

virtual

Self logic to be executed when focus is given to a child of this widget.

Parameters

ChildName	The name of the child that has gained focus.
Selected	A Boole indicating whether the child is being selected or deselected.

Definition at line 487 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::AddChild ( Widget *  Child )

virtual

Adds a Widget to this as a child of this quad.

Warning

Unless this method is being called from a Screen or LayoutContainer (or it's derived classes) this method is not intended for casual use. Different QuadRenderable implementations have different expectations on their children and may need a specific quantity, or have them inserted in a specific order to achieve the behavior designed for them. Use with care.

Parameters

Child

A pointer to the Widget that is to become a child of this.

Reimplemented from Mezzanine::UI::QuadRenderable.

Reimplemented in Mezzanine::UI::LinearContainer.

Definition at line 267 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::AddChild ( Widget *  Child, const UInt16  ZOrder  )

virtual

Adds a Widget to this as a child of this quad.

Warning

Unless this method is being called from a Screen or LayoutContainer (or it's derived classes) this method is not intended for casual use. Different QuadRenderable implementations have different expectations on their children and may need a specific quantity, or have them inserted in a specific order to achieve the behavior designed for them. Use with care.

Parameters

Child	A pointer to the Widget that is to become a child of this.
ZOrder	The ZOrder to assign to the child renderable.

Reimplemented from Mezzanine::UI::QuadRenderable.

Reimplemented in Mezzanine::UI::LinearContainer.

Definition at line 273 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::DestroyAllChildren ( )

virtual

Destroys all child Widgets currently inside this QuadRenderable.

Reimplemented from Mezzanine::UI::QuadRenderable.

Reimplemented in Mezzanine::UI::GridContainer.

Definition at line 319 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::DestroyChild ( Widget *  ToBeDestroyed )

virtual

Destroys a child Widget currently inside this QuadRenderable.

Parameters

ToBeDestroyed

A pointer to the child to be destroyed.

Reimplemented from Mezzanine::UI::QuadRenderable.

Reimplemented in Mezzanine::UI::GridContainer.

Definition at line 305 of file pagedcontainer.cpp.

Widget * Mezzanine::UI::PagedContainer::GetLastSelectedChild ( ) const

virtual

Gets a pointer to the last selected child widget in this container.

Returns

Returns a pointer to the child widget that was selected last.

Definition at line 147 of file pagedcontainer.cpp.

PagedContainer::ProviderMode Mezzanine::UI::PagedContainer::GetProviderConfig ( ) const

virtual

Gets the current provider configuration of this container.

Returns

Returns an enum describing the the provider configuration for this container.

Definition at line 161 of file pagedcontainer.cpp.

PagedContainer::ProviderMode Mezzanine::UI::PagedContainer::GetProviderConfig ( const PageProvider *  Prov ) const

virtual

Gets the role of the specified PageProvider in this container.

Parameters

Prov	The PageProvider to check this container for.

Returns

Returns a ProviderMode enum value representing how the specified PageProvider is providing for this container.

Definition at line 174 of file pagedcontainer.cpp.

String Mezzanine::UI::PagedContainer::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 479 of file pagedcontainer.cpp.

Boole Mezzanine::UI::PagedContainer::GetVisible ( ) const

virtual

Gets the visibility setting of this renderable.

Returns

Returns a bool that is the current visibility setting of this renderable.

Reimplemented from Mezzanine::UI::Widget.

Definition at line 204 of file pagedcontainer.cpp.

const Vector2 & Mezzanine::UI::PagedContainer::GetWorkAreaSize ( ) const

virtual

Gets the size of this containers work area.

Returns

Returns a const reference to a Vector2 containing this containers work area size in pixels.

Definition at line 124 of file pagedcontainer.cpp.

PageProvider * Mezzanine::UI::PagedContainer::GetXProvider ( ) const

virtual

Gets the PageProvider for the X axis.

Returns

Returns a pointer to the PageProvider for the X axis of this container.

Definition at line 242 of file pagedcontainer.cpp.

PageProvider * Mezzanine::UI::PagedContainer::GetYProvider ( ) const

virtual

Gets the PageProvider for the Y axis.

Returns

Returns a pointer to the PageProvider for the Y axis of this container.

Definition at line 245 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::HandleChildStateChangeImpl ( Widget *  Child, const UInt32 &  OldState, const UInt32 &  NewState  )

protectedvirtual

Handles the logic to execute when a child of this widget has it's state updated.

Parameters

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 from Mezzanine::UI::Widget.

Definition at line 103 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::Hide ( )

virtual

Forces this renderable to hide.

Reimplemented from Mezzanine::UI::Widget.

Definition at line 227 of file pagedcontainer.cpp.

Boole Mezzanine::UI::PagedContainer::IsVisible ( ) const

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().

Returns

Returns a bool representing the visibility of this renderable.

Reimplemented from Mezzanine::UI::Widget.

Definition at line 209 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::ProtoDeSerializeImpl ( const XML::Node &  SelfRoot )

protectedvirtual

Implementation method for deseriailizing additional sets of data.

Parameters

SelfRoot

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

Reimplemented from Mezzanine::UI::Widget.

Reimplemented in Mezzanine::UI::GridContainer.

Definition at line 97 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::ProtoDeSerializePageData ( const XML::Node &  SelfRoot )

virtual

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

Parameters

SelfRoot

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

Todo:

This is a blind cast and can cause some issues if the configuration is edited externally such that the named widget isn't a provider. Some check may being added may be warrented.

Todo:

This is a blind cast and can cause some issues if the configuration is edited externally such that the named widget isn't a provider. Some check may being added may be warrented.

Definition at line 388 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::ProtoDeSerializeProperties ( const XML::Node &  SelfRoot )

virtual

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

Parameters

SelfRoot

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

Reimplemented from Mezzanine::UI::Widget.

Reimplemented in Mezzanine::UI::GridContainer, Mezzanine::UI::LinearContainer, Mezzanine::UI::HorizontalContainer, and Mezzanine::UI::VerticalContainer.

Definition at line 460 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::ProtoSerializeImpl ( XML::Node &  SelfRoot ) const

protectedvirtual

Implementation method for serializing additional sets of data.

Parameters

SelfRoot

The root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::UI::Widget.

Reimplemented in Mezzanine::UI::GridContainer.

Definition at line 91 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::ProtoSerializePageData ( XML::Node &  SelfRoot ) const

virtual

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

Parameters

SelfRoot

The root node containing all the serialized data for this instance.

Definition at line 336 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::ProtoSerializeProperties ( XML::Node &  SelfRoot ) const

virtual

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

Parameters

SelfRoot

The root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::UI::Widget.

Reimplemented in Mezzanine::UI::GridContainer, Mezzanine::UI::LinearContainer, Mezzanine::UI::HorizontalContainer, and Mezzanine::UI::VerticalContainer.

Definition at line 371 of file pagedcontainer.cpp.

virtual void Mezzanine::UI::PagedContainer::QuickUpdateWorkAreaSize ( const UnifiedVec2 &  ChildSize, Boole  Adding  )

pure virtual

Quickly updates the work area size based on a single childs' dimensions.

Note

The work area size is automatically updated when a child is added or removed from a container. You should only need to call this method manually if a childs size isn't determined yet when it is added to the container.

Parameters

ChildSize	The Unified dimensions describing the childs size.
Adding	Should be true if the child in question is being added to the container, false if it is being removed.

Implemented in Mezzanine::UI::GridContainer, Mezzanine::UI::HorizontalContainer, and Mezzanine::UI::VerticalContainer.

void Mezzanine::UI::PagedContainer::RemoveAllChildren ( )

virtual

Removes all child Widgets from this QuadRenderable.

Note

The chilren are NOT destroyed.

Reimplemented from Mezzanine::UI::QuadRenderable.

Reimplemented in Mezzanine::UI::GridContainer.

Definition at line 292 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::RemoveChild ( Widget *  ToBeRemoved )

virtual

Removes a child Widget from this quadrenderable.

Note

The child is NOT destroyed.

Parameters

ToBeRemoved

A pointer to the child to be removed.

Reimplemented from Mezzanine::UI::QuadRenderable.

Reimplemented in Mezzanine::UI::GridContainer.

Definition at line 278 of file pagedcontainer.cpp.

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

pure virtual

Sets the page providers for both axes.

Parameters

XProv	The PageProvider controlling the current horizontal page.
YProv	The PageProvider controlling the current vertical page.

Implemented in Mezzanine::UI::GridContainer, Mezzanine::UI::HorizontalContainer, and Mezzanine::UI::VerticalContainer.

void Mezzanine::UI::PagedContainer::SetVisible ( Boole  CanSee )

virtual

Sets the visibility of this renderable.

Parameters

CanSee

Boole determining whether or not this renderable should be visible.

Reimplemented from Mezzanine::UI::Widget.

Definition at line 190 of file pagedcontainer.cpp.

virtual void Mezzanine::UI::PagedContainer::SetXProvider ( PageProvider *  XProv )

pure virtual

Sets the PageProvider for the X axis.

Parameters

XProv

The PageProvider controlling the current horizontal page.

Implemented in Mezzanine::UI::GridContainer, Mezzanine::UI::HorizontalContainer, and Mezzanine::UI::VerticalContainer.

void Mezzanine::UI::PagedContainer::SetXYProvider ( PageProvider *  Prov )

virtual

Sets a single PageProvider as the provider for both the X and Y axis.

Parameters

Prov	The PageProvider to be set for the X and Y axes.

Definition at line 239 of file pagedcontainer.cpp.

virtual void Mezzanine::UI::PagedContainer::SetYProvider ( PageProvider *  YProv )

pure virtual

Sets the PageProvider for the Y axis.

Parameters

YProv

The PageProvider controlling the current vertical page.

Implemented in Mezzanine::UI::GridContainer, Mezzanine::UI::HorizontalContainer, and Mezzanine::UI::VerticalContainer.

void Mezzanine::UI::PagedContainer::Show ( )

virtual

Forces this renderable to be shown.

Reimplemented from Mezzanine::UI::Widget.

Definition at line 218 of file pagedcontainer.cpp.

void Mezzanine::UI::PagedContainer::UnbindProvider ( PageProvider *  Prov )

virtual

Unbinds a provider being used by this container.

Parameters

Prov	A pointer to the PageProvider to be unbound if it is used by this container.

Definition at line 248 of file pagedcontainer.cpp.

virtual void Mezzanine::UI::PagedContainer::UpdateContainerDimensionsImpl ( const Rect &  OldSelfRect, const Rect &  NewSelfRect  )

protectedpure virtual

The container specific logic for updating it's dimensions.

Parameters

OldSelfRect	The pre-update size of this widget.
NewSelfRect	The post-update size of this widget.

Implemented in Mezzanine::UI::GridContainer, Mezzanine::UI::HorizontalContainer, and Mezzanine::UI::VerticalContainer.

void Mezzanine::UI::PagedContainer::UpdateDimensions ( const Rect &  OldSelfRect, const Rect &  NewSelfRect  )

virtual

Updates the dimensions of this QuadRenderable based on the transform of it's parent.

This function is called automatically by this objects parent when it changes in size or position, and should only need to be called manually if the positioning or sizing rules were updated manually.

Parameters

OldSelfRect	The previous dimensions of this quad prior to it's dimensions being updated.
NewSelfRect	The updated and current dimensions of this quad.

Reimplemented from Mezzanine::UI::QuadRenderable.

Definition at line 129 of file pagedcontainer.cpp.

virtual void Mezzanine::UI::PagedContainer::UpdateWorkAreaSize ( )

pure virtual

Checks the size of every child in this container and updates the work area to match the size needed.

Note

The work area size is automatically updated when a child is added or removed from a container. You should only need to call this method manually if a childs size isn't determined yet when it is added to the container.

Implemented in Mezzanine::UI::GridContainer, Mezzanine::UI::HorizontalContainer, and Mezzanine::UI::VerticalContainer.

Member Data Documentation

Widget* Mezzanine::UI::PagedContainer::LastSelectedChild

protected

A pointer to the last child widget that was selected within this container.

Definition at line 157 of file pagedcontainer.h.

VisibleChildContainer Mezzanine::UI::PagedContainer::VisibleChildren

protected

A container of children that meet the criteria for rendering in this container.

Definition at line 151 of file pagedcontainer.h.

Vector2 Mezzanine::UI::PagedContainer::WorkAreaSize

protected

Vector2 storing the size for all pages of this container.

Definition at line 154 of file pagedcontainer.h.

PageProvider* Mezzanine::UI::PagedContainer::XProvider

protected

A pointer to the X axis provider.

Definition at line 160 of file pagedcontainer.h.

PageProvider* Mezzanine::UI::PagedContainer::YProvider

protected

A pointer to the Y axis provider.

Definition at line 163 of file pagedcontainer.h.

---

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

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/UI/pagedcontainer.h
• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/UI/pagedcontainer.cpp