MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Mezzanine::UI::WidgetFactory Class Referenceabstract

This is a base class for factories that construct the widgets available to the UI subsystem. More...

#include <widgetfactory.h>

+ Inheritance diagram for Mezzanine::UI::WidgetFactory:

Public Member Functions

 WidgetFactory ()
 Class constructor.
 
virtual ~WidgetFactory ()
 Class destructor.
 
virtual WidgetCreateWidget (Screen *Parent)=0
 Creates a Widget of the type represented by this factory. More...
 
virtual WidgetCreateWidget (const String &RendName, const NameValuePairMap &Params, Screen *Parent)=0
 Creates a Widget of the type represented by this factory. More...
 
virtual WidgetCreateWidget (const String &RendName, const UnifiedRect &RendRect, const NameValuePairMap &Params, Screen *Parent)=0
 Creates a Widget of the type represented by this factory. More...
 
virtual WidgetCreateWidget (const XML::Node &XMLNode, Screen *Parent)=0
 Creates a Widget from XML. More...
 
virtual void DestroyWidget (Widget *ToBeDestroyed)=0
 Destroys a Widget created by this factory. More...
 
virtual String GetWidgetTypeName () const =0
 Gets the name of the Widget that is created by this factory. More...
 

Detailed Description

This is a base class for factories that construct the widgets available to the UI subsystem.

Definition at line 61 of file widgetfactory.h.

Member Function Documentation

virtual Widget* Mezzanine::UI::WidgetFactory::CreateWidget ( Screen Parent)
pure virtual
virtual Widget* Mezzanine::UI::WidgetFactory::CreateWidget ( const String RendName,
const NameValuePairMap Params,
Screen Parent 
)
pure virtual

Creates a Widget of the type represented by this factory.

Parameters
RendNameThe name to be given to the created widget.
ParamsA NameValuePairMap containing the params to be applied during construction.
ParentThe screen the created Widget will belong to.
Returns
Returns a pointer to the created Widget.

Implemented in Mezzanine::UI::GenericWidgetFactory, Mezzanine::UI::ButtonFactory, Mezzanine::UI::MenuEntryFactory, Mezzanine::UI::RadioButtonFactory, Mezzanine::UI::HorizontalScrollbarFactory, Mezzanine::UI::VerticalScrollbarFactory, Mezzanine::UI::CheckBoxFactory, Mezzanine::UI::HorizontalContainerFactory, Mezzanine::UI::VerticalContainerFactory, and Mezzanine::UI::MenuButtonFactory.

virtual Widget* Mezzanine::UI::WidgetFactory::CreateWidget ( const String RendName,
const UnifiedRect RendRect,
const NameValuePairMap Params,
Screen Parent 
)
pure virtual

Creates a Widget of the type represented by this factory.

Parameters
RendNameThe name to be given to the created widget.
RendRectThe dimensions that will be assigned to the created Widget.
ParamsA NameValuePairMap containing the params to be applied during construction.
ParentThe screen the created Widget will belong to.
Returns
Returns a pointer to the created Widget.

Implemented in Mezzanine::UI::GenericWidgetFactory, Mezzanine::UI::ButtonFactory, Mezzanine::UI::MenuEntryFactory, Mezzanine::UI::RadioButtonFactory, Mezzanine::UI::HorizontalScrollbarFactory, Mezzanine::UI::VerticalScrollbarFactory, Mezzanine::UI::CheckBoxFactory, Mezzanine::UI::HorizontalContainerFactory, Mezzanine::UI::VerticalContainerFactory, and Mezzanine::UI::MenuButtonFactory.

virtual Widget* Mezzanine::UI::WidgetFactory::CreateWidget ( const XML::Node XMLNode,
Screen Parent 
)
pure virtual
virtual void Mezzanine::UI::WidgetFactory::DestroyWidget ( Widget ToBeDestroyed)
pure virtual
virtual String Mezzanine::UI::WidgetFactory::GetWidgetTypeName ( ) const
pure virtual

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