Mezzanine::UI::Spinner Class Reference

This is a simple widget for a numeric variable in a box. More...

#include <spinner.h>

Inheritance diagram for Mezzanine::UI::Spinner:

Collaboration diagram for Mezzanine::UI::Spinner:

Public Member Functions
	Spinner (Screen *Parent)
	Blank constructor. More...
	Spinner (const String &RendName, const SpinnerStyle SpinStyle, FontData *EditFont, Screen *Parent)
	Standard initialization constructor. More...
	Spinner (const String &RendName, const SpinnerStyle SpinStyle, const String &EditFontName, Screen *Parent)
	Standard initialization constructor. More...
	Spinner (const String &RendName, const UnifiedRect &RendRect, const SpinnerStyle SpinStyle, FontData *EditFont, Screen *Parent)
	Rect constructor. More...
	Spinner (const String &RendName, const UnifiedRect &RendRect, const SpinnerStyle SpinStyle, const String &EditFontName, Screen *Parent)
	Rect constructor. More...
	Spinner (const XML::Node &XMLNode, Screen *Parent)
	XML constructor. More...
virtual	~Spinner ()
	Class destructor.
virtual void	_NotifyContainerUpdated ()
	Notifies this provider that the container it is providing page data to has been updated. More...
virtual void	_NotifyEvent (EventArgumentsPtr Args)
	Notifies this subscriber of an event being fired. More...
virtual void	_OnSpinValueChanged (const Real OldValue, const Real NewValue)
	Self logic to be executed when this Spinner has it's spin value updated. More...
virtual Real	GetCurrentXPage () const
	Gets the current page position on the X axis. More...
virtual Real	GetCurrentYPage () const
	Gets the current page position on the Y axis. More...
virtual Button *	GetDecrement () const
	Gets the decrement Button of this Spinner. More...
virtual Button *	GetIncrement () const
	Gets the increment Button of this Spinner. More...
virtual Real	GetIncrementValue () const
	Gets the amount to increase or decrease by when the spinner value is altered by child buttons. More...
virtual Real	GetMaxSpinValue () const
	Gets the maximum limit for the value this spinner can have. More...
virtual Real	GetMaxXPages () const
	Gets the maximum number of pages supported on the X axis. More...
virtual Real	GetMaxYPages () const
	Gets the maximum number of pages supported on the Y axis. More...
virtual Real	GetMinSpinValue () const
	Gets the minimum limit for the value this Spinner can have. More...
virtual UI::OrderingPriority	GetOrderingPriority () const
	Gets which axis will be considered first when converting the current value to an X or Y page. More...
virtual Real	GetSpinValue () const
	Gets the value of this Spinner. More...
virtual const String &	GetTypeName () const
	Gets the type of widget this is. More...
virtual EditBox *	GetValueDisplay () const
	Gets the EditBox displaying the value of this Spinner. 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	SetButtonLayout (const SpinnerStyle Style)
	Sets the sizing and positioning policies of the children in this spinner to match the provided layout. More...
virtual void	SetIncrementValue (const Real Value)
	Sets the amount to increase or decrease by when the spinner value is altered by child buttons. More...
virtual void	SetMaxSpinValue (const Real Value)
	Sets the maximum limit for the value this spinner can have. More...
virtual void	SetMinSpinValue (const Real Value)
	Sets the minimum limit for the value this Spinner can have. More...
virtual void	SetOrderingPriority (const UI::OrderingPriority Order)
	Sets which axis will be considered first when converting the current value to an X or Y page. More...
virtual void	SetSpinValue (Real Value)
	Sets the value of this Spinner. More...
virtual void	SetSpinValueLimits (const Real Min, const Real Max)
	Sets the minimum and maximum limits for the value this Spinner can have. More...
Public Member Functions inherited from Mezzanine::UI::PageProvider
virtual void	_SetContainer (PagedContainer *ToUpdate)
	Sets the container that is using this provider to update which renderables are visible. 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...
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	_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 Boole	GetVisible () const
	Gets the visibility setting of this renderable. More...
virtual Boole	HasFocus () const
	Gets whether or not this widget currently has focus. More...
virtual void	Hide ()
	Forces this renderable to hide. More...
virtual Boole	IsDragged () const
	Gets whether or not the system mouse is being dragged over this widget. More...
virtual Boole	IsHovered () const
	Gets the result of the last mouse hover check. More...
virtual Boole	IsVisible () const
	Gets whether or not this renderable is being drawn. More...
virtual void	ProtoDeSerializeEvents (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the Events of this object with it. More...
virtual void	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...
virtual void	SetVisible (Boole CanSee)
	Sets the visibility of this renderable. More...
virtual void	Show ()
	Forces this renderable to be shown. More...
Public Member Functions inherited from Mezzanine::UI::QuadRenderable
	QuadRenderable (Screen *Parent)
	Blank constructor. More...
	QuadRenderable (const String &RendName, Screen *Parent)
	Class constructor. More...
	QuadRenderable (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
	Parent-less constructor. More...
virtual	~QuadRenderable ()
	Class destructor. More...
virtual void	_AppendRenderData (ScreenRenderData &RenderData)
	Appends the vertices of this renderable to another vector. More...
virtual void	_AppendRenderDataCascading (ScreenRenderData &RenderData)
	Appends the vertices of this renderable to another vector, and then does the same for this renderable's children. More...
virtual void	_Clean ()
	Refreshes the render data of this renderable. More...
virtual void	_MarkAllChildrenDirty ()
	Tells this QuadRenderable to mark each of it's children (and their children) as dirty. More...
virtual void	_MarkAllLayersDirty ()
	Tells this QuadRenderable that all of it's layers are dirty. More...
virtual void	_MarkDirty ()
	Marks this renderable as dirty, and informs other renderables if needed. More...
virtual void	_NotifyParenthood (QuadRenderable *NewParent)
	Notifies this QuadRenderable that it has been added to another QuadRenderable. More...
virtual void	_SetLayoutStrat (LayoutStrategy *ToSet)
	Sets a new LayoutStrategy for this quad to use. More...
virtual void	_SetZOrder (const UInt16 &Zorder)
	Ssts the ZOrder value for this renderable. More...
virtual void	AddChild (Widget *Child)
	Adds a Widget to this as a child of this quad. More...
virtual void	AddChild (Widget *Child, const UInt16 ZOrder)
	Adds a Widget to this as a child of this quad. More...
void	AddLayerToExistingGroup (RenderLayer *Layer, const UInt16 LayerZOrder, const UInt16 GroupID)
	Adds a RenderLayer to the specified group. More...
void	AddLayerToGroup (RenderLayer *Layer, const UInt16 LayerZOrder, const UInt16 GroupID)
	Adds a RenderLayer to the specified group. More...
void	AddLayerToGroup (RenderLayer *Layer, const GroupOrderEntry &GroupAndZ)
	Adds a RenderLayer to the specified group. More...
void	AddLayerToGroups (RenderLayer *Layer, const GroupOrderEntryVector &Entrys)
	Adds a RenderLayer to multiple groups. More...
virtual Boole	CheckOverlap (const QuadRenderable *Quad) const
	Checks to see if another Quad is overlapping with this one. More...
ChildIterator	ChildrenBegin ()
	Gets an iterator to the first child Widget. More...
ConstChildIterator	ChildrenBegin () const
	Gets a const iterator to the first child Widget. More...
ChildIterator	ChildrenEnd ()
	Gets an iterator to one passed the last child Widget. More...
ConstChildIterator	ChildrenEnd () const
	Gets an iterator to one passed the last child Widget. More...
MultiImageLayer *	CreateMultiImageLayer ()
	Creates an MultiImageLayer for this renderable. More...
MultiImageLayer *	CreateMultiImageLayer (const UInt16 NormalZ, const UInt16 HoveredZ)
	Creates an MultiImageLayer for this renderable. More...
MultiImageLayer *	CreateMultiImageLayer (const GroupOrderEntry &GroupAndZ)
	Creates an MultiImageLayer for this renderable and adds it to a RenderLayerGroup. More...
MultiLineTextLayer *	CreateMultiLineTextLayer ()
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const UInt16 NormalZ, const UInt16 HoveredZ)
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const GroupOrderEntry &GroupAndZ)
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const String &FontName)
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const String &FontName, const UInt16 NormalZ, const UInt16 HoveredZ)
	Creats a MultiLineTextLayer for this renderable. More...
MultiLineTextLayer *	CreateMultiLineTextLayer (const String &FontName, const GroupOrderEntry &GroupAndZ)
	Creats a MultiLineTextLayer for this renderable. More...
RenderLayerGroup *	CreateOrRetrieveRenderLayerGroup (const UInt16 GroupID)
	Gets the named RenderLayerGroup or creates one with the specified ID if it does not exist. More...
RenderLayerGroup *	CreateRenderLayerGroup (const UInt16 GroupID)
	Creates a new RenderLayerGroup that can have. 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...
virtual void	DestroyAllChildren ()
	Destroys all child Widgets currently inside this QuadRenderable.
void	DestroyAllRenderLayerGroups ()
	Destroy's all RenderLayerGroups being stored/managed by this QuadRenderable.
void	DestroyAllRenderLayers ()
	Destroys all RenderLayers being stored by this renderable.
virtual void	DestroyChild (Widget *ToBeDestroyed)
	Destroys a child Widget currently inside this QuadRenderable. More...
void	DestroyRenderLayer (RenderLayer *ToBeDestroyed)
	Destroys a RenderLayer being stored by this renderable. More...
void	DestroyRenderLayerGroup (const UInt16 GroupID)
	Destroy's a RenderLayerGroup by ID. More...
void	DestroyRenderLayerGroup (RenderLayerGroup *ToBeDestroyed)
	Destroy's a RenderLayerGroup by pointer. More...
RenderLayerGroup *	GetActiveGroup () const
	Gets the current RenderLayerGroup used for rendering. More...
virtual Vector2	GetActualPosition () const
	Gets the pixel position of this widget. More...
virtual Vector2	GetActualSize () const
	Gets the pixel size of this widget. More...
virtual UI::AspectRatioLock	GetAspectRationLock () const
	Gets how (and if) the aspect ratio of this quad is locked. More...
virtual Widget *	GetChild (const UInt16 Zorder) const
	Gets a child by it's ZOrder. More...
virtual Widget *	GetChild (const String &RendName) const
	Gets a child by it's name. More...
Widget *	GetClosestChild (Widget *Child)
	Gets a pointer to the child of this QuadRenderable that is storing a child, or another quad that is. More...
virtual UInt16	GetHighestChildZOrder () const
	Gets the highest ZOrder among the children of this QuadRenderable. More...
virtual Whole	GetHorizontalPositioningRules () const
	Gets the current behavior this quad will follow when it is positioned automatically on the X axis. More...
virtual Whole	GetHorizontalSizingRules () const
	Gets the current behavior this quad will follow for the X axis when it is resized. More...
virtual Real	GetIdealHeightForText () const
	Gets the height needed for this quadrenderable to be able to completely display text in it's child text layers. More...
virtual UInt16	GetLowestChildZOrder () const
	Gets the lowest ZOrder among the children of this QuadRenderable. More...
virtual Boole	GetManualTransformUpdates () const
	Gets whether or not this quad will be automatically updated when parent transforms are updated. More...
virtual UnifiedVec2	GetMaxSize () const
	Gets the currently set maximum size for this quad. More...
virtual UnifiedVec2	GetMinSize () const
	Gets the currently set minimum size for this quad. More...
virtual Boole	GetMousePassthrough () const
	Gets whether or not Mouse Passthrough is enabled. More...
QuadRenderable *	GetNextSibling (Boole Wrap=true)
	Gets the QuadRenderable after this one among the QuadRenderables owned by it's parent. More...
virtual Whole	GetNumChildren () const
	Gets the number of children in this QuadRenderable. More...
UInt32	GetNumRenderLayerGroups () const
	Gets the number of RenderLayerGroup's created for this renderable. More...
UInt32	GetNumRenderLayers () const
	Gets the number of RenderLayers created for this renderable. More...
UInt32	GetNumVisibleRenderLayers () const
	Gets the number of RenderLayers that are visible in this renderable. More...
QuadRenderable *	GetParent () const
	Gets the parent of this quad. More...
virtual const PositioningInfo &	GetPositioningPolicy () const
	Gets the current behavior this QuadRenderable will use when it is positioned. More...
QuadRenderable *	GetPrevSibling (Boole Wrap=true)
	Gets the QuadRenderable before this one among the QuadRenderables owned by it's parent. More...
virtual Rect	GetRect () const
	Gets this QuadRenderables' Rect. More...
RenderLayer *	GetRenderLayer (const UInt32 &Index) const
	Gets a RenderLayer belonging to this QuadRenderable by index. More...
RenderLayer *	GetRenderLayer (const Whole Which, const UI::RenderLayerType Type)
	Gets a RenderLayer belonging to this QuadRenderable by it's type. More...
RenderLayerGroup *	GetRenderLayerGroup (const UInt16 GroupID) const
	Gets a RenderLayerGroup by ID. More...
virtual const SizingInfo &	GetSizingPolicy () const
	Gets the current behavior this QuadRenderable will use when it is sized. More...
QuadRenderable *	GetTopMostQuad ()
	Gets the QuadRenderable that is both an ancestor of this quad, and a direct child of the screen. More...
virtual UnifiedVec2	GetUnifiedPosition () const
	Gets the position of this QuadRenderable as a Unified Vector2. More...
virtual UnifiedRect	GetUnifiedRect () const
	Gets the Unified positiona nd size of this QuadRenderable as a unified rect. More...
virtual UnifiedVec2	GetUnifiedSize () const
	Gets the size of this QuadRenderable as a Unified Vector2. More...
virtual Whole	GetVerticalPositioningRules () const
	Gets the current behavior this quad will follow when it is positioned automatically on the Y axis. More...
virtual Whole	GetVerticalSizingRules () const
	Gets the current behavior this quad will follow for the Y axis when it is resized. More...
virtual const UInt16 &	GetZOrder () const
	Gets the currently set ZOrder of this QuadRenderable with it's parent. More...
virtual Boole	IsChildOfScreen () const
	Gets whether or not this QuadRenderable is a direct child of it's screen. More...
virtual Boole	IsInside (const Vector2 &Point) const
	Checks to see if a point in 2D space is inside this quad. More...
Boole	IsVertexCachingEnabled () const
	Gets whether or not vertex caching is enabled for this Quad. More...
virtual void	PopulateTextLinesInLayers (const Real MaxWidth)
	Populates all text lines in all text layers owned by this quad. More...
virtual void	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite this object with it. More...
virtual void	ProtoDeSerializeChildQuads (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the ChildQuads of this object with it. More...
virtual void	ProtoDeSerializeRenderLayerGroups (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the RenderLayerGroups of this object with it. More...
virtual void	ProtoDeSerializeRenderLayers (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the RenderLayers of this object with it. More...
virtual void	ProtoSerialize (XML::Node &ParentNode) const
	Convert this class to an XML::Node ready for serialization. More...
virtual void	ProtoSerializeChildQuads (XML::Node &SelfRoot) const
	Convert the child quads of this class to an XML::Node ready for serialization. More...
virtual void	ProtoSerializeRenderLayerGroups (XML::Node &SelfRoot) const
	Convert the RenderLayerGroups of this class to an XML::Node ready for seriailization. More...
virtual void	ProtoSerializeRenderLayers (XML::Node &SelfRoot) const
	Convert the RenderLayers of this class to an XML::Node ready for serialization. More...
ReverseChildIterator	RChildrenBegin ()
	Gets an iterator to the last Widget. More...
ConstReverseChildIterator	RChildrenBegin () const
	Gets a const iterator to the last Widget. More...
ReverseChildIterator	RChildrenEnd ()
	Gets an iterator to one before the first child Widget. More...
ConstReverseChildIterator	RChildrenEnd () const
	Gets a const iterator to one before the first child Widget. More...
virtual void	RemoveAllChildren ()
	Removes all child Widgets from this QuadRenderable. More...
virtual void	RemoveChild (Widget *ToBeRemoved)
	Removes a child Widget from this quadrenderable. More...
void	RemoveLayerFromAllGroups (RenderLayer *Layer)
	Removes a single RenderLayer from all RenderLayerGroups owned by this QuadRenderable. More...
void	RemoveLayerFromGroup (RenderLayer *Layer, const UInt16 GroupID)
	Removes a single RenderLayer from a specified RenderLayerGroup. More...
RenderLayerIterator	RenderLayerBegin ()
	Gets an iterator to the first RenderLayer. More...
ConstRenderLayerIterator	RenderLayerBegin () const
	Gets a const iterator to the first RenderLayer. More...
RenderLayerIterator	RenderLayerEnd ()
	Gets an iterator to one passed the last RenderLayer. More...
ConstRenderLayerIterator	RenderLayerEnd () const
	Gets an iterator to one passed the last RenderLayer. More...
RenderLayerGroupIterator	RenderLayerGroupBegin ()
	Gets an iterator to the first RenderLayerGroup. More...
ConstRenderLayerGroupIterator	RenderLayerGroupBegin () const
	Gets a const iterator to the first RenderLayerGroup. More...
RenderLayerGroupIterator	RenderLayerGroupEnd ()
	Gets an iterator to one passed the last RenderLayerGroup. More...
ConstRenderLayerGroupIterator	RenderLayerGroupEnd () const
	Gets an iterator to one passed the last RenderLayerGroup. More...
Boole	RenderLayerGroupExists (const UInt16 GroupID) const
	Checks to see if a RenderLayerGroup exists. More...
void	SetActiveGroup (const UInt16 GroupID)
	Sets the RenderLayerGroup that will be used to render this renderable. More...
void	SetActiveGroup (RenderLayerGroup *Group)
	Sets the RenderLayerGroup that will be used to render this renderable. More...
virtual void	SetAspectRatioLock (const UI::AspectRatioLock Lock)
	Sets how (and if) the aspect ratio of this quad is locked. More...
virtual void	SetHorizontalPositioningRules (const Whole Rules)
	Sets the behavior this quad will have when it is positioned automatically on the X axis. More...
virtual void	SetHorizontalSizingRules (const Whole Rules)
	Sets the behavior this quad will have on the X axis when it is resized. More...
void	SetLocalVertexCaching (Boole Enable)
	Enables or disables caching of vertex's belonging to this and all child renderables. More...
virtual void	SetManualTransformUpdates (Boole Enable)
	Sets whether or not this quad has specific behaviors for it's transform updates and they should not be done automatically. More...
virtual void	SetMaxSize (const UnifiedVec2 &Max)
	Sets the maximum size this quad is allowed to have. More...
virtual void	SetMinSize (const UnifiedVec2 &Min)
	Sets the minimum size this quad is allowed to have. More...
virtual void	SetMousePassthrough (Boole Enable)
	Sets whether or not this quad should be skipped when determining if the mouse is hovered over this quad. More...
virtual void	SetPositioningPolicy (const PositioningInfo &Policy)
	Sets the behavior to be used when this QuadRenderable is positioned. More...
virtual void	SetSizingPolicy (const SizingInfo &Policy)
	Sets the behavior to be used when this QuadRenderable is sized. More...
virtual void	SetUnifiedPosition (const UnifiedVec2 &Position)
	Sets the position this QuadRenderable will have within it's parent. More...
virtual void	SetUnifiedSize (const UnifiedVec2 &Size)
	Sets the size this QuadRenderable will have within it's parent. More...
virtual void	SetVerticalPositioningRules (const Whole Rules)
	Sets the behavior this quad will have when it is positioned automatically on the Y axis. More...
virtual void	SetVerticalSizingRules (const Whole Rules)
	Sets the behavior this quad will have on the Y axis when it is resized. More...
virtual void	UpdateChildDimensions ()
	Updates the dimensions of the children in this QuadRenderable. More...
virtual void	UpdateChildOrder ()
	Updates the order of children in this QuadRenderable based on the ZOrder set on each child.
virtual void	UpdateDimensions ()
	Updates the dimensions of this QuadRenderable based on the transform of it's parent. More...
virtual void	UpdateDimensions (const Rect &OldSelfRect, const Rect &NewSelfRect)
	Updates the dimensions of this QuadRenderable based on the transform of it's parent. More...
Public Member Functions inherited from Mezzanine::UI::Renderable
Boole	_IsDirty () const
	Gets whether or not this renderable is dirty. More...
const String &	GetName () const
	Gets the name of this renderable. More...
Screen *	GetScreen () const
	Gets the parent screen of this renderable. More...
Boole	IsScreen () const
	Gets whether or not this renderable is a Screen. More...
Boole	IsWidget () const
	Gets whether or not this renderable is a Widget. More...
Public Member Functions inherited from Mezzanine::EventPublisher
	EventPublisher ()
	Class constructor.
virtual	~EventPublisher ()
	Class destructor.
Event *	GetEvent (const String &EventName) const
	Gets an event in this publisher. More...
Event *	GetEventExcept (const String &EventName) const
	Gets an event in this publisher. 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	EventSpinValueChanged = "SpinValueChanged"
	Event name for when the value in this Spinner is updated.
static const String	TypeName = "Spinner"
	String containing the type name for this class: "Spinner".
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	ClampToLimits (Real &Value)
	Ensures the provided value is within the configured limits. More...
virtual void	ConstructSpinner (const SpinnerStyle SpinStyle, FontData *EditFont)
	Contains all the common necessary startup initializations for this class. More...
Protected Member Functions inherited from Mezzanine::UI::PageProvider
	PageProvider (Screen *Parent)
	Blank constructor. More...
	PageProvider (const String &RendName, Screen *Parent)
	Standard initialization constructor. More...
	PageProvider (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
	Rect constructor. More...
virtual	~PageProvider ()
	Standard destructor.
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
void	ConstructWidget ()
	Contains all the common necessary startup initializations for this class. More...
virtual void	HandleChildStateChangeImpl (Widget *Child, const UInt32 &OldState, const UInt32 &NewState)
	Handles the logic to execute when a child of this widget has it's state updated. More...
virtual Boole	HandleInputImpl (const Input::MetaCode &Code)
	Consumes input for this widget's use. More...
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
Button *	DecrementSpin
	A pointer to the button that will decrement the spin value. More...
Button *	IncrementSpin
	A pointer to the button that will increment the spin value. More...
Real	IncrementValue
	The amount to increase or decrease by when the spin value is altered via buttons. More...
Real	MaxValue
	The maximum value allowed to be expressed by this Spinner. More...
Real	MinValue
	The minimum value allowed to be expressed by this Spinner. More...
UI::OrderingPriority	OrderPriority
	Which axis is primary when determining the current X or Y page. More...
Real	SpinValue
	The current spin value of this Spinner. More...
EditBox *	ValueDisplay
	A pointer to the EditBox that will display the spin value. More...
Protected Attributes inherited from Mezzanine::UI::PageProvider
PagedContainer *	Container
	A pointer to the PagedContainer this scrollbar is providing page data for. 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...

Additional Inherited Members
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.

Detailed Description

This is a simple widget for a numeric variable in a box.

Like the Scrollbar Widget, the size provided will be for the area of all the elements of this widget combined. In the case of separate format, if horizontal, the width of the increment and decrement buttons will be the same as the height or if vertical the height will be the same as the width provided. In either case making the two buttons perfectly square in size, with the remaining space going to the display caption.
In the case of the together format, then half of the height is taken and that is used for both the width and height, and then they are placed on the appropriate side.

This class can use either a HorizontalLayoutStrategy, VerticalLayoutStrategy, or the LayoutStrategy base class depeding on the set button layout/SpinStyle.

Definition at line 130 of file spinner.h.

Constructor & Destructor Documentation

Mezzanine::UI::Spinner::Spinner

(

Screen *

Parent

)

Blank constructor.

Parameters

Parent

The parent Screen that created this widget.

Definition at line 81 of file spinner.cpp.

Mezzanine::UI::Spinner::Spinner	(	const String &	RendName,
		const SpinnerStyle	SpinStyle,
		FontData *	EditFont,
		Screen *	Parent
	)

Standard initialization constructor.

Parameters

RendName	The name to be given to this renderable.
SpinStyle	The layout of buttons this Spinner will have.
EditFont	A pointer to the font to be used by the child EditBox.
Parent	The parent Screen that created this widget.

Definition at line 93 of file spinner.cpp.

Mezzanine::UI::Spinner::Spinner	(	const String &	RendName,
		const SpinnerStyle	SpinStyle,
		const String &	EditFontName,
		Screen *	Parent
	)

Standard initialization constructor.

Parameters

RendName	The name to be given to this renderable.
SpinStyle	The layout of buttons this Spinner will have.
EditFontName	The name of the font to be used by the child EditBox.
Parent	The parent Screen that created this widget.

Definition at line 105 of file spinner.cpp.

Mezzanine::UI::Spinner::Spinner	(	const String &	RendName,
		const UnifiedRect &	RendRect,
		const SpinnerStyle	SpinStyle,
		FontData *	EditFont,
		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.
SpinStyle	The layout of buttons this Spinner will have.
EditFont	A pointer to the font to be used by the child EditBox.
Parent	The parent screen that created this renderable.

Definition at line 117 of file spinner.cpp.

Mezzanine::UI::Spinner::Spinner	(	const String &	RendName,
		const UnifiedRect &	RendRect,
		const SpinnerStyle	SpinStyle,
		const String &	EditFontName,
		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.
SpinStyle	The layout of buttons this Spinner will have.
EditFontName	The name of the font to be used by the child EditBox.
Parent	The parent screen that created this renderable.

Definition at line 129 of file spinner.cpp.

Mezzanine::UI::Spinner::Spinner	(	const XML::Node &	XMLNode,
		Screen *	Parent
	)

XML constructor.

Parameters

XMLNode	The node of the xml document to construct from.
Parent	The screen the created Spinner will belong to.

Definition at line 141 of file spinner.cpp.

Member Function Documentation

void Mezzanine::UI::Spinner::_NotifyContainerUpdated ( )

virtual

Notifies this provider that the container it is providing page data to has been updated.

Implements Mezzanine::UI::PageProvider.

Definition at line 508 of file spinner.cpp.

void Mezzanine::UI::Spinner::_NotifyEvent ( EventArgumentsPtr  Args )

virtual

Notifies this subscriber of an event being fired.

Parameters

Args	The arguments containing specific information regarding this event.

Reimplemented from Mezzanine::UI::Widget.

Definition at line 481 of file spinner.cpp.

void Mezzanine::UI::Spinner::_OnSpinValueChanged ( const Real  OldValue, const Real  NewValue  )

virtual

Self logic to be executed when this Spinner has it's spin value updated.

Parameters

OldValue	The previous value of this Spinner.
NewValue	The updated value of this Spinner.

Definition at line 468 of file spinner.cpp.

void Mezzanine::UI::Spinner::ClampToLimits ( Real &  Value )

protectedvirtual

Ensures the provided value is within the configured limits.

Parameters

Value

The value to verify.

Definition at line 186 of file spinner.cpp.

void Mezzanine::UI::Spinner::ConstructSpinner ( const SpinnerStyle  SpinStyle, FontData *  EditFont  )

protectedvirtual

Contains all the common necessary startup initializations for this class.

Parameters

SpinStyle	The layout of buttons this Spinner will have.
EditFont	A pointer to the font to be used by the child EditBox.

Definition at line 167 of file spinner.cpp.

Real Mezzanine::UI::Spinner::GetCurrentXPage ( ) const

virtual

Gets the current page position on the X axis.

Returns

Returns a Real representing the page position on the X axis.

Implements Mezzanine::UI::PageProvider.

Definition at line 389 of file spinner.cpp.

Real Mezzanine::UI::Spinner::GetCurrentYPage ( ) const

virtual

Gets the current page position on the Y axis.

Returns

Returns a Real representing the page position on the Y axis.

Implements Mezzanine::UI::PageProvider.

Definition at line 399 of file spinner.cpp.

Button * Mezzanine::UI::Spinner::GetDecrement ( ) const

virtual

Gets the decrement Button of this Spinner.

Returns

Returns a pointer to the decrement Button.

Definition at line 356 of file spinner.cpp.

Button * Mezzanine::UI::Spinner::GetIncrement ( ) const

virtual

Gets the increment Button of this Spinner.

Returns

Returns a pointer to the increment Button.

Definition at line 353 of file spinner.cpp.

Real Mezzanine::UI::Spinner::GetIncrementValue ( ) const

virtual

Gets the amount to increase or decrease by when the spinner value is altered by child buttons.

Returns

Returns a Real containing the amount the spin value will go up or down when the child buttons are clicked.

Definition at line 219 of file spinner.cpp.

Real Mezzanine::UI::Spinner::GetMaxSpinValue ( ) const

virtual

Gets the maximum limit for the value this spinner can have.

Returns

Returns a Real containing the maximum allowed value of this Spinner.

Definition at line 234 of file spinner.cpp.

Real Mezzanine::UI::Spinner::GetMaxXPages ( ) const

virtual

Gets the maximum number of pages supported on the X axis.

Returns

Returns the number of pages on the X axis supported with the given work area size.

Implements Mezzanine::UI::PageProvider.

Definition at line 365 of file spinner.cpp.

Real Mezzanine::UI::Spinner::GetMaxYPages ( ) const

virtual

Gets the maximum number of pages supported on the Y axis.

Returns

Returns the number of pages on the Y axis supported with the given work area size.

Implements Mezzanine::UI::PageProvider.

Definition at line 377 of file spinner.cpp.

Real Mezzanine::UI::Spinner::GetMinSpinValue ( ) const

virtual

Gets the minimum limit for the value this Spinner can have.

Returns

Returns a Real containing the minimum allowed value of this Spinner.

Definition at line 228 of file spinner.cpp.

UI::OrderingPriority Mezzanine::UI::Spinner::GetOrderingPriority ( ) const

virtual

Gets which axis will be considered first when converting the current value to an X or Y page.

Returns

Returns an OrderingPriority enum value representing which axis is considered primary when determining the current page on a given axis.

Definition at line 240 of file spinner.cpp.

String Mezzanine::UI::Spinner::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 462 of file spinner.cpp.

Real Mezzanine::UI::Spinner::GetSpinValue ( ) const

virtual

Gets the value of this Spinner.

Returns

Returns a Real containing the current value of this spinner.

Definition at line 213 of file spinner.cpp.

const String & Mezzanine::UI::Spinner::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 197 of file spinner.cpp.

EditBox * Mezzanine::UI::Spinner::GetValueDisplay ( ) const

virtual

Gets the EditBox displaying the value of this Spinner.

Returns

Returns a pointer to the value display EditBox.

Definition at line 359 of file spinner.cpp.

void Mezzanine::UI::Spinner::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.

Definition at line 430 of file spinner.cpp.

void Mezzanine::UI::Spinner::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.

Definition at line 412 of file spinner.cpp.

void Mezzanine::UI::Spinner::SetButtonLayout ( const SpinnerStyle  Style )

virtual

Sets the sizing and positioning policies of the children in this spinner to match the provided layout.

Parameters

Style

A SpinnerStyle value representing how the children of this spinner should be layed out.

Definition at line 246 of file spinner.cpp.

void Mezzanine::UI::Spinner::SetIncrementValue ( const Real  Value )

virtual

Sets the amount to increase or decrease by when the spinner value is altered by child buttons.

Parameters

Value

A Real containing the amount to increase the spin value when incrememnted, or decrease the spin value when decremented.

Definition at line 216 of file spinner.cpp.

void Mezzanine::UI::Spinner::SetMaxSpinValue ( const Real  Value )

virtual

Sets the maximum limit for the value this spinner can have.

Parameters

Value

The maximum value this Spinner can have.

Definition at line 231 of file spinner.cpp.

void Mezzanine::UI::Spinner::SetMinSpinValue ( const Real  Value )

virtual

Sets the minimum limit for the value this Spinner can have.

Parameters

Value

The minumum value this Spinner can have.

Definition at line 225 of file spinner.cpp.

void Mezzanine::UI::Spinner::SetOrderingPriority ( const UI::OrderingPriority  Order )

virtual

Sets which axis will be considered first when converting the current value to an X or Y page.

Note

This value is only used when this spinner is configured as both the X and Y provider of a paged container.

Parameters

Order

An OrderingPriority enum value representing which axis is to be considered primary when determining the current page on a given axis.

Definition at line 237 of file spinner.cpp.

void Mezzanine::UI::Spinner::SetSpinValue ( Real  Value )

virtual

Sets the value of this Spinner.

Parameters

Value

A Real containing the new value of this Spinner.

Definition at line 203 of file spinner.cpp.

void Mezzanine::UI::Spinner::SetSpinValueLimits ( const Real  Min, const Real  Max  )

virtual

Sets the minimum and maximum limits for the value this Spinner can have.

Note

Both of these values default to 0.0 after construction.

Parameters

Min	The minumum value this Spinner can have.
Max	The maximum value this Spinner can have.

Definition at line 222 of file spinner.cpp.

Member Data Documentation

Button* Mezzanine::UI::Spinner::DecrementSpin

protected

A pointer to the button that will decrement the spin value.

Definition at line 143 of file spinner.h.

Button* Mezzanine::UI::Spinner::IncrementSpin

protected

A pointer to the button that will increment the spin value.

Definition at line 140 of file spinner.h.

Real Mezzanine::UI::Spinner::IncrementValue

protected

The amount to increase or decrease by when the spin value is altered via buttons.

Definition at line 152 of file spinner.h.

Real Mezzanine::UI::Spinner::MaxValue

protected

The maximum value allowed to be expressed by this Spinner.

Definition at line 158 of file spinner.h.

Real Mezzanine::UI::Spinner::MinValue

protected

The minimum value allowed to be expressed by this Spinner.

Definition at line 155 of file spinner.h.

UI::OrderingPriority Mezzanine::UI::Spinner::OrderPriority

protected

Which axis is primary when determining the current X or Y page.

Definition at line 161 of file spinner.h.

Real Mezzanine::UI::Spinner::SpinValue

protected

The current spin value of this Spinner.

Definition at line 149 of file spinner.h.

EditBox* Mezzanine::UI::Spinner::ValueDisplay

protected

A pointer to the EditBox that will display the spin value.

Definition at line 146 of file spinner.h.

---

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

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