This is a simple widget for a numeric variable in a box. 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 | WidgetState { WS_Untouched = 0, WS_Hovered = 1, WS_Focused = 2, WS_Dragged = 4 } |
Enum describing the current state of the widget. | |
Public Member Functions inherited from Mezzanine::UI::PageProvider | |
virtual void | _NotifyContainerUpdated ()=0 |
Notifies this provider that the container it is providing page data to has been updated. More... | |
virtual void | _SetContainer (PagedContainer *ToUpdate) |
Sets the container that is using this provider to update which renderables are visible. More... | |
virtual Real | GetCurrentXPage () const =0 |
Gets the current page position on the X axis. More... | |
virtual Real | GetCurrentYPage () const =0 |
Gets the current page position on the Y axis. More... | |
virtual Real | GetMaxXPages () const =0 |
Gets the maximum number of pages supported on the X axis. More... | |
virtual Real | GetMaxYPages () const =0 |
Gets the maximum number of pages supported on the Y axis. More... | |
virtual void | ProtoDeSerializePageData (const XML::Node &SelfRoot) |
Take the data stored in an XML Node and overwrite the PageProvider data of this object with it. More... | |
virtual void | ProtoSerializePageData (XML::Node &SelfRoot) const |
Convert the PageProvider data of this class to an XML::Node ready for serialization. More... | |
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 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 | EventMouseDragging = "MouseDragging" |
Event name for when a mouse activation button is pressed, and held while moving. | |
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 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 Attributes inherited from Mezzanine::UI::PageProvider | |
PagedContainer * | Container |
A pointer to the PagedContainer this scrollbar is providing page data for. More... | |
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.