Mezzanine::UI::EditBoxFactory Class Reference

This is the factory implementation for EditBox widgets. More...

#include <editbox.h>

Inheritance diagram for Mezzanine::UI::EditBoxFactory:

Collaboration diagram for Mezzanine::UI::EditBoxFactory:

Public Member Functions
	EditBoxFactory ()
	Class constructor.
virtual	~EditBoxFactory ()
	Class destructor.
virtual EditBox *	CreateEditBox (const String &RendName, const RenderLayerType EditLayerType, FontData *EditFont, Screen *Parent)
	Creates a new EditBox. More...
virtual EditBox *	CreateEditBox (const String &RendName, const RenderLayerType EditLayerType, const String &EditFontName, Screen *Parent)
	Creates a new EditBox. More...
virtual EditBox *	CreateEditBox (const String &RendName, const UnifiedRect &RendRect, const RenderLayerType EditLayerType, FontData *EditFont, Screen *Parent)
	Creates a new EditBox. More...
virtual EditBox *	CreateEditBox (const String &RendName, const UnifiedRect &RendRect, const RenderLayerType EditLayerType, const String &EditFontName, Screen *Parent)
	Creates a new EditBox. More...
virtual EditBox *	CreateEditBox (const XML::Node &XMLNode, Screen *Parent)
	Creates a new EditBox. More...
virtual Widget *	CreateWidget (Screen *Parent)
	Creates a Widget of the type represented by this factory. More...
virtual Widget *	CreateWidget (const String &RendName, const NameValuePairMap &Params, Screen *Parent)
	Creates a Widget of the type represented by this factory. More...
virtual Widget *	CreateWidget (const String &RendName, const UnifiedRect &RendRect, const NameValuePairMap &Params, Screen *Parent)
	Creates a Widget of the type represented by this factory. More...
virtual Widget *	CreateWidget (const XML::Node &XMLNode, Screen *Parent)
	Creates a Widget from XML. More...
virtual void	DestroyWidget (Widget *ToBeDestroyed)
	Destroys a Widget created by this factory. More...
virtual String	GetWidgetTypeName () const
	Gets the name of the Widget that is created by this factory. More...
Public Member Functions inherited from Mezzanine::UI::WidgetFactory
	WidgetFactory ()
	Class constructor.
virtual	~WidgetFactory ()
	Class destructor.

Detailed Description

This is the factory implementation for EditBox widgets.

Definition at line 207 of file editbox.h.

Member Function Documentation

EditBox * Mezzanine::UI::EditBoxFactory::CreateEditBox ( const String &  RendName, const RenderLayerType  EditLayerType, FontData *  EditFont, Screen *  Parent  )

virtual

Creates a new EditBox.

Parameters

RendName	The name to be given to the created EditBox.
EditLayerType	The type of text layer to be auto-created for editing.
EditFont	A pointer to the font to be used by the edit layer.
Parent	The screen the created EditBox will belong to.

Returns

Returns a pointer to the created EditBox.

Definition at line 413 of file editbox.cpp.

EditBox * Mezzanine::UI::EditBoxFactory::CreateEditBox ( const String &  RendName, const RenderLayerType  EditLayerType, const String &  EditFontName, Screen *  Parent  )

virtual

Creates a new EditBox.

Parameters

RendName	The name to be given to the created EditBox.
EditLayerType	The type of text layer to be auto-created for editing.
EditFontName	The name of the font to be used by the edit layer.
Parent	The screen the created EditBox will belong to.

Returns

Returns a pointer to the created EditBox.

Definition at line 416 of file editbox.cpp.

EditBox * Mezzanine::UI::EditBoxFactory::CreateEditBox ( const String &  RendName, const UnifiedRect &  RendRect, const RenderLayerType  EditLayerType, FontData *  EditFont, Screen *  Parent  )

virtual

Creates a new EditBox.

Parameters

RendName	The name to be given to the created EditBox.
RendRect	The dimensions that will be assigned to the created EditBox.
EditLayerType	The type of text layer to be auto-created for editing.
EditFont	A pointer to the font to be used by the edit layer.
Parent	The screen the created EditBox will belong to.

Returns

Returns a pointer to the created EditBox.

Definition at line 419 of file editbox.cpp.

EditBox * Mezzanine::UI::EditBoxFactory::CreateEditBox ( const String &  RendName, const UnifiedRect &  RendRect, const RenderLayerType  EditLayerType, const String &  EditFontName, Screen *  Parent  )

virtual

Creates a new EditBox.

Parameters

RendName	The name to be given to the created EditBox.
RendRect	The dimensions that will be assigned to the created EditBox.
EditLayerType	The type of text layer to be auto-created for editing.
EditFontName	The name of the font to be used by the edit layer.
Parent	The screen the created EditBox will belong to.

Returns

Returns a pointer to the created EditBox.

Definition at line 422 of file editbox.cpp.

EditBox * Mezzanine::UI::EditBoxFactory::CreateEditBox ( const XML::Node &  XMLNode, Screen *  Parent  )

virtual

Creates a new EditBox.

Parameters

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

Returns

Returns a pointer to the created EditBox.

Definition at line 425 of file editbox.cpp.

Widget * Mezzanine::UI::EditBoxFactory::CreateWidget ( Screen *  Parent )

virtual

Creates a Widget of the type represented by this factory.

Parameters

Parent

The screen the created Widget will belong to.

Returns

Returns a pointer to the created Widget.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 428 of file editbox.cpp.

Widget * Mezzanine::UI::EditBoxFactory::CreateWidget ( const String &  RendName, const NameValuePairMap &  Params, Screen *  Parent  )

virtual

Creates a Widget of the type represented by this factory.

Parameters

RendName	The name to be given to the created widget.
Params	A NameValuePairMap containing the params to be applied during construction.
Parent	The screen the created Widget will belong to.

Returns

Returns a pointer to the created Widget.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 431 of file editbox.cpp.

Widget * Mezzanine::UI::EditBoxFactory::CreateWidget ( const String &  RendName, const UnifiedRect &  RendRect, const NameValuePairMap &  Params, Screen *  Parent  )

virtual

Creates a Widget of the type represented by this factory.

Parameters

RendName	The name to be given to the created widget.
RendRect	The dimensions that will be assigned to the created Widget.
Params	A NameValuePairMap containing the params to be applied during construction.
Parent	The screen the created Widget will belong to.

Returns

Returns a pointer to the created Widget.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 448 of file editbox.cpp.

Widget * Mezzanine::UI::EditBoxFactory::CreateWidget ( const XML::Node &  XMLNode, Screen *  Parent  )

virtual

Creates a Widget from XML.

Parameters

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

Returns

Returns a pointer to the Widget created.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 465 of file editbox.cpp.

void Mezzanine::UI::EditBoxFactory::DestroyWidget ( Widget *  ToBeDestroyed )

virtual

Destroys a Widget created by this factory.

Parameters

ToBeDestroyed

A pointer to the Widget to be destroyed.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 468 of file editbox.cpp.

String Mezzanine::UI::EditBoxFactory::GetWidgetTypeName ( ) const

virtual

Gets the name of the Widget that is created by this factory.

Returns

Returns the typename of the Widget created by this factory.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 410 of file editbox.cpp.

---

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

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