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

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

#include <verticalcontainer.h>

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

Public Member Functions

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

Definition at line 131 of file verticalcontainer.h.

Member Function Documentation

VerticalContainer * Mezzanine::UI::VerticalContainerFactory::CreateVerticalContainer ( const String &  RendName,
Screen *  Parent 
)
virtual

Creates a new VerticalContainer.

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

Definition at line 321 of file verticalcontainer.cpp.

VerticalContainer * Mezzanine::UI::VerticalContainerFactory::CreateVerticalContainer ( const String &  RendName,
const UnifiedRect &  RendRect,
Screen *  Parent 
)
virtual

Creates a new VerticalContainer.

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

Definition at line 328 of file verticalcontainer.cpp.

VerticalContainer * Mezzanine::UI::VerticalContainerFactory::CreateVerticalContainer ( const XML::Node &  XMLNode,
Screen *  Parent 
)
virtual

Creates a new VerticalContainer.

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

Definition at line 335 of file verticalcontainer.cpp.

Widget * Mezzanine::UI::VerticalContainerFactory::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 342 of file verticalcontainer.cpp.

Widget * Mezzanine::UI::VerticalContainerFactory::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 349 of file verticalcontainer.cpp.

Widget * Mezzanine::UI::VerticalContainerFactory::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 352 of file verticalcontainer.cpp.

Widget * Mezzanine::UI::VerticalContainerFactory::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 355 of file verticalcontainer.cpp.

void Mezzanine::UI::VerticalContainerFactory::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 358 of file verticalcontainer.cpp.

String Mezzanine::UI::VerticalContainerFactory::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 318 of file verticalcontainer.cpp.


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