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

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

#include <gridcontainer.h>

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

Public Member Functions

 GridContainerFactory ()
 Class constructor.
 
virtual ~GridContainerFactory ()
 Class destructor.
 
virtual GridContainer * CreateGridContainer (const String &RendName, Screen *Parent)
 Creates a new GridContainer. More...
 
virtual GridContainer * CreateGridContainer (const String &RendName, const UnifiedRect &RendRect, Screen *Parent)
 Creates a new GridContainer. More...
 
virtual GridContainer * CreateGridContainer (const XML::Node &XMLNode, Screen *Parent)
 Creates a new GridContainer. 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 GridContainer widgets.

Definition at line 326 of file gridcontainer.h.

Member Function Documentation

GridContainer * Mezzanine::UI::GridContainerFactory::CreateGridContainer ( const String &  RendName,
Screen *  Parent 
)
virtual

Creates a new GridContainer.

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

Definition at line 623 of file gridcontainer.cpp.

GridContainer * Mezzanine::UI::GridContainerFactory::CreateGridContainer ( const String &  RendName,
const UnifiedRect &  RendRect,
Screen *  Parent 
)
virtual

Creates a new GridContainer.

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

Definition at line 626 of file gridcontainer.cpp.

GridContainer * Mezzanine::UI::GridContainerFactory::CreateGridContainer ( const XML::Node &  XMLNode,
Screen *  Parent 
)
virtual

Creates a new GridContainer.

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

Definition at line 629 of file gridcontainer.cpp.

Widget * Mezzanine::UI::GridContainerFactory::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 632 of file gridcontainer.cpp.

Widget * Mezzanine::UI::GridContainerFactory::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 635 of file gridcontainer.cpp.

Widget * Mezzanine::UI::GridContainerFactory::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 638 of file gridcontainer.cpp.

Widget * Mezzanine::UI::GridContainerFactory::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 641 of file gridcontainer.cpp.

void Mezzanine::UI::GridContainerFactory::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 644 of file gridcontainer.cpp.

String Mezzanine::UI::GridContainerFactory::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 620 of file gridcontainer.cpp.


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