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

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

#include <spinner.h>

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

Public Member Functions

 SpinnerFactory ()
 Class constructor.
 
virtual ~SpinnerFactory ()
 Class destructor.
 
virtual Spinner * CreateSpinner (const String &RendName, const SpinnerStyle SpinStyle, FontData *EditFont, Screen *Parent)
 Creates a new Spinner. More...
 
virtual Spinner * CreateSpinner (const String &RendName, const SpinnerStyle SpinStyle, const String &EditFontName, Screen *Parent)
 Creates a new Spinner. More...
 
virtual Spinner * CreateSpinner (const String &RendName, const UnifiedRect &RendRect, const SpinnerStyle SpinStyle, FontData *EditFont, Screen *Parent)
 Creates a new Spinner. More...
 
virtual Spinner * CreateSpinner (const String &RendName, const UnifiedRect &RendRect, const SpinnerStyle SpinStyle, const String &EditFontName, Screen *Parent)
 Creates a new Spinner. More...
 
virtual Spinner * CreateSpinner (const XML::Node &XMLNode, Screen *Parent)
 Creates a new Spinner. 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 Spinner widgets.

Definition at line 319 of file spinner.h.

Member Function Documentation

Spinner * Mezzanine::UI::SpinnerFactory::CreateSpinner ( const String &  RendName,
const SpinnerStyle  SpinStyle,
FontData *  EditFont,
Screen *  Parent 
)
virtual

Creates a new Spinner.

Parameters
RendNameThe name to be given to the created Spinner.
SpinStyleThe layout of buttons this Spinner will have.
EditFontA pointer to the font to be used by the edit layer.
ParentThe screen the created Spinner will belong to.
Returns
Returns a pointer to the created Spinner.

Definition at line 539 of file spinner.cpp.

Spinner * Mezzanine::UI::SpinnerFactory::CreateSpinner ( const String &  RendName,
const SpinnerStyle  SpinStyle,
const String &  EditFontName,
Screen *  Parent 
)
virtual

Creates a new Spinner.

Parameters
RendNameThe name to be given to the created Spinner.
SpinStyleThe layout of buttons this Spinner will have.
EditFontNameThe name of the font to be used by the edit layer.
ParentThe screen the created Spinner will belong to.
Returns
Returns a pointer to the created Spinner.

Definition at line 542 of file spinner.cpp.

Spinner * Mezzanine::UI::SpinnerFactory::CreateSpinner ( const String &  RendName,
const UnifiedRect &  RendRect,
const SpinnerStyle  SpinStyle,
FontData *  EditFont,
Screen *  Parent 
)
virtual

Creates a new Spinner.

Parameters
RendNameThe name to be given to the created Spinner.
RendRectThe dimensions that will be assigned to the created Spinner.
SpinStyleThe layout of buttons this Spinner will have.
EditFontA pointer to the font to be used by the edit layer.
ParentThe screen the created Spinner will belong to.
Returns
Returns a pointer to the created Spinner.

Definition at line 545 of file spinner.cpp.

Spinner * Mezzanine::UI::SpinnerFactory::CreateSpinner ( const String &  RendName,
const UnifiedRect &  RendRect,
const SpinnerStyle  SpinStyle,
const String &  EditFontName,
Screen *  Parent 
)
virtual

Creates a new Spinner.

Parameters
RendNameThe name to be given to the created Spinner.
RendRectThe dimensions that will be assigned to the created Spinner.
SpinStyleThe layout of buttons this Spinner will have.
EditFontNameThe name of the font to be used by the edit layer.
ParentThe screen the created Spinner will belong to.
Returns
Returns a pointer to the created Spinner.

Definition at line 548 of file spinner.cpp.

Spinner * Mezzanine::UI::SpinnerFactory::CreateSpinner ( const XML::Node &  XMLNode,
Screen *  Parent 
)
virtual

Creates a new Spinner.

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

Definition at line 551 of file spinner.cpp.

Widget * Mezzanine::UI::SpinnerFactory::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 554 of file spinner.cpp.

Widget * Mezzanine::UI::SpinnerFactory::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 557 of file spinner.cpp.

Widget * Mezzanine::UI::SpinnerFactory::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 574 of file spinner.cpp.

Widget * Mezzanine::UI::SpinnerFactory::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 591 of file spinner.cpp.

void Mezzanine::UI::SpinnerFactory::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 594 of file spinner.cpp.

String Mezzanine::UI::SpinnerFactory::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 536 of file spinner.cpp.


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