Widget for handling the input and manipulation of text. More...

#include <editbox.h>

Inheritance diagram for Mezzanine::UI::EditBox:

Collaboration diagram for Mezzanine::UI::EditBox:

Static Public Attributes
static const String	EventTextUpdated
	Event name for when the text in this widget has been updated.

static const String	TypeName = "EditBox"
	String containing the type name for this class: "EditBox".

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

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

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

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

virtual	~EditBox ()
	Class destructor.

Protected Member Functions inherited from Mezzanine::UI::Widget
	Widget (Screen *Parent)
	Blank constructor. More...

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

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

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

virtual	~Widget ()
	Standard destructor.

void	ConstructWidget ()
	Contains all the common necessary startup initializations for this class. More...

virtual Boolean	HandleInputImpl (const Input::MetaCode &Code)
	Consumes input for this widget's use. More...

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

	QuadRenderable (const String &RendName, Screen *Parent)
	Class constructor. More...

	QuadRenderable (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
	Parent-less constructor. More...

virtual	~QuadRenderable ()
	Class destructor. More...

void	AppendLayerVertices (std::vector< VertexData > &Vertices)
	Adds all the vertices belonging to all the layers of this renderable to the provided vector. More...

void	CleanLayers ()
	Redraws all dirty layers. More...

void	ResizeLayers (const Whole NewSize)
	Resizes the container for RenderLayers in this QuadRenderable. More...

Protected Member Functions inherited from Mezzanine::UI::Renderable
	Renderable (Screen *Parent)
	Blank constructor. More...

	Renderable (const String &RendName, Screen *Parent)
	Class constructor. More...

virtual	~Renderable ()
	Class destructor.

Protected Member Functions inherited from Mezzanine::EventPublisher
Event *	AddEvent (const String &EventName)
	Creates a new event this Publisher can fire. More...

void	FireEvent (const EventArguments &Args)
	Fires an event. More...

void	RemoveAllEvents ()
	Removes all events in this Publisher. More...

void	RemoveEvent (const String &EventName)
	Removes an existing event in this Publisher. More...

Protected Member Functions inherited from Mezzanine::EventSubscriber
	EventSubscriber ()
	Class constructor.

virtual	~EventSubscriber ()
	Class destructor.

Protected Attributes
TextLayer *	EditLayer
	A pointer to the TextLayer that is the target to be edited when this widget processes input. 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...

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

Boolean	ManualTransformUpdates
	Controls whether or not this Quad and it's children will recieve automatic transform updates. More...

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

UI::RenderPriority	Priority
	Determines the "higher ZOrder" of this Quad compared to all other renderables on screen. 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
Boolean	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...

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

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::Widget
virtual bool	_HandleInput (const Input::MetaCode &Code)
	Handles input passed to this widget. More...

virtual void	_NotifyEvent (const EventArguments &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	_OnMouseDragging ()
	Self logic to be executed when the mouse cursor is dragging across the bounds of this widget. More...

virtual void	_OnMouseDragStart ()
	Self logic to be executed when the mouse cursor starts dragging across the bounds of this widget. More...

virtual void	_OnMouseEnter ()
	Self logic to be executed when the mouse cursor enters the bounds of this widget. More...

virtual void	_OnMouseExit ()
	Self logic to be executed when the mouse cursor leaves the bounds of thiw widget. More...

virtual void	_OnVisibilityHidden ()
	Self logic to be executed when this widget becomes invisible.

virtual void	_OnVisibilityShown ()
	Self logic to be executed when this widget becomes visible.

virtual void	BindGroupToState (const UInt32 BindState, RenderLayerGroup *ToBind)
	Binds a RenderLayerGroup to a WidgetState. More...

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

RenderableType	GetRenderableType () const
	Gets the type of renderable this is. More...

virtual const String &	GetTypeName () const
	Gets the type of widget this is. More...

virtual Boolean	GetVisible () const
	Gets the visibility setting of this renderable. More...

virtual Boolean	HasFocus () const
	Gets whether or not this widget currently has focus. More...

virtual void	Hide ()
	Forces this renderable to hide. More...

virtual Boolean	IsBeingDragged () const
	Gets whether or not this widget is being dragged. More...

virtual Boolean	IsHovered () const
	Gets the result of the last mouse hover check. More...

virtual Boolean	IsVisible () const
	Gets whether or not this renderable is being drawn. More...

virtual void	ProtoDeSerializeEvents (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the Events of this object with it. More...

virtual void	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	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	ProtoSerializeProperties (XML::Node &SelfRoot) const
	Convert the properties of this class to an XML::Node ready for serialization. More...

virtual void	ProtoSerializeStateGroupBindings (XML::Node &SelfRoot) const
	Convert the state-group bindings of this class to an XML::Node ready for serialization. More...

virtual bool	SetGroupFromState (const UInt32 BindState)
	Sets the group bound to the specified WidgetState as active. More...

virtual void	SetVisible (Boolean CanSee)

virtual void	Show ()
	Forces this renderable to be shown. More...

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

Detailed Description

Widget for handling the input and manipulation of text.

Definition at line 55 of file editbox.h.

Constructor & Destructor Documentation

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

protected

Blank constructor.

Parameters

Parent The parent Screen that created this widget.

Definition at line 57 of file editbox.cpp.

Mezzanine::UI::EditBox::EditBox	(	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 63 of file editbox.cpp.

Mezzanine::UI::EditBox::EditBox	(	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 69 of file editbox.cpp.

Mezzanine::UI::EditBox::EditBox	(	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 EditBox will belong to.

Definition at line 75 of file editbox.cpp.

Member Data Documentation

TextLayer* Mezzanine::UI::EditBox::EditLayer

protected

A pointer to the TextLayer that is the target to be edited when this widget processes input.

Definition at line 65 of file editbox.h.

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

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

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation