Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | List of all members
Mezzanine::UI::GenericWidgetFactory Class Reference

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

#include <widget.h>

+ Inheritance diagram for Mezzanine::UI::GenericWidgetFactory:
+ Collaboration diagram for Mezzanine::UI::GenericWidgetFactory:

Public Member Functions

 GenericWidgetFactory ()
 Class constructor.
 
virtual ~GenericWidgetFactory ()
 Class destructor.
 
virtual WidgetCreateWidget (const String &RendName, Screen *Parent)
 Creates a new Widget. More...
 
virtual WidgetCreateWidget (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
 Creates a new Widget. More...
 
virtual WidgetCreateWidget (Screen *Parent)
 Creates a Widget of the type represented by this factory. More...
 
virtual WidgetCreateWidget (const String &RendName, const NameValuePairMap &Params, Screen *Parent)
 Creates a Widget of the type represented by this factory. More...
 
virtual WidgetCreateWidget (const String &RendName, const UnifiedRect &RendRect, const NameValuePairMap &Params, Screen *Parent)
 Creates a Widget of the type represented by this factory. More...
 
virtual WidgetCreateWidget (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 generic widgets.

Definition at line 392 of file widget.h.

Member Function Documentation

Widget * Mezzanine::UI::GenericWidgetFactory::CreateWidget ( const String RendName,
Screen Parent 
)
virtual

Creates a new Widget.

Parameters
RendNameThe name to be given to the created Widget.
ParentThe screen the created Widget will belong to.
Returns
Returns a pointer to the created Widget.

Definition at line 569 of file widget.cpp.

Widget * Mezzanine::UI::GenericWidgetFactory::CreateWidget ( const String RendName,
const UnifiedRect RendRect,
Screen Parent 
)
virtual

Creates a new Widget.

Parameters
RendNameThe name to be given to the created Widget.
RendRectThe dimensions that will be assigned to the created Widget.
ParentThe screen the created Widget will belong to.
Returns
Returns a pointer to the created Widget.

Definition at line 576 of file widget.cpp.

Widget * Mezzanine::UI::GenericWidgetFactory::CreateWidget ( Screen Parent)
virtual

Creates a Widget of the type represented by this factory.

Parameters
ParentThe screen the created Widget will belong to.
Returns
Returns a pointer to the created Widget.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 583 of file widget.cpp.

Widget * Mezzanine::UI::GenericWidgetFactory::CreateWidget ( const String RendName,
const NameValuePairMap Params,
Screen Parent 
)
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.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 590 of file widget.cpp.

Widget * Mezzanine::UI::GenericWidgetFactory::CreateWidget ( const String RendName,
const UnifiedRect RendRect,
const NameValuePairMap Params,
Screen Parent 
)
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.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 593 of file widget.cpp.

Widget * Mezzanine::UI::GenericWidgetFactory::CreateWidget ( const XML::Node XMLNode,
Screen Parent 
)
virtual

Creates a Widget from XML.

Parameters
XMLNodeThe node of the xml document to construct from.
ParentThe screen the created Widget will belong to.
Returns
Returns a pointer to the Widget created.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 596 of file widget.cpp.

void Mezzanine::UI::GenericWidgetFactory::DestroyWidget ( Widget ToBeDestroyed)
virtual

Destroys a Widget created by this factory.

Parameters
ToBeDestroyedA pointer to the Widget to be destroyed.

Implements Mezzanine::UI::WidgetFactory.

Definition at line 603 of file widget.cpp.

String Mezzanine::UI::GenericWidgetFactory::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 566 of file widget.cpp.


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