This is a widget that stores sets of renderables but only displays one at a time. More...

#include <tabset.h>

Inheritance diagram for Mezzanine::UI::TabSet:

Collaboration diagram for Mezzanine::UI::TabSet:

Static Public Attributes
static const String	TypeName = "TabSet"
	String containing the type name for this class: "TabSet".

Static Public Attributes inherited from Mezzanine::UI::StackedContainer
static const String	TypeName = "StackedContainer"
	String containing the type name for this class: "StackedContainer".

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
	TabSet (Screen *Parent)
	Blank constructor. More...

	TabSet (const String &RendName, Screen *Parent)
	Standard initialization constructor. More...

	TabSet (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
	Rect constructor. More...

	TabSet (const XML::Node &XMLNode, Screen *Parent)
	XML constructor. More...

virtual	~TabSet ()
	Class destructor.

Friends
class	TabSetFactory

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::StackedContainer
	StackedContainer (Screen *Parent)
	Blank constructor. More...

	StackedContainer (const String &RendName, Screen *Parent)
	Standard initialization constructor. More...

	StackedContainer (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
	Rect constructor. More...

virtual	~StackedContainer ()
	Class destructor.

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

Static Public Member Functions inherited from Mezzanine::UI::StackedContainer
static String	GetSerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. 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...

Detailed Description

This is a widget that stores sets of renderables but only displays one at a time.

This widget is useful for tabbed option displays.

Definition at line 53 of file tabset.h.

Constructor & Destructor Documentation

Mezzanine::UI::TabSet::TabSet ( Screen * Parent)

protected

Blank constructor.

Parameters

Parent The parent Screen that created this widget.

Definition at line 56 of file tabset.cpp.

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

protected

Standard initialization constructor.

Parameters

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

Definition at line 62 of file tabset.cpp.

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

protected

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 68 of file tabset.cpp.

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

protected

XML constructor.

Parameters

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

Definition at line 74 of file tabset.cpp.

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

/home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/tabset.h
/home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/tabset.cpp

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation