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

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

#include <checkbox.h>

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

Public Member Functions

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

Definition at line 150 of file checkbox.h.

Member Function Documentation

CheckBox * Mezzanine::UI::CheckBoxFactory::CreateCheckBox ( const String RendName,
Screen Parent 
)
virtual

Creates a new CheckBox.

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

Definition at line 226 of file checkbox.cpp.

CheckBox * Mezzanine::UI::CheckBoxFactory::CreateCheckBox ( const String RendName,
const UnifiedRect RendRect,
Screen Parent 
)
virtual

Creates a new CheckBox.

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

Definition at line 229 of file checkbox.cpp.

CheckBox * Mezzanine::UI::CheckBoxFactory::CreateCheckBox ( const XML::Node XMLNode,
Screen Parent 
)
virtual

Creates a new CheckBox.

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

Definition at line 232 of file checkbox.cpp.

Widget * Mezzanine::UI::CheckBoxFactory::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 235 of file checkbox.cpp.

Widget * Mezzanine::UI::CheckBoxFactory::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 238 of file checkbox.cpp.

Widget * Mezzanine::UI::CheckBoxFactory::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 241 of file checkbox.cpp.

Widget * Mezzanine::UI::CheckBoxFactory::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 244 of file checkbox.cpp.

void Mezzanine::UI::CheckBoxFactory::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 247 of file checkbox.cpp.

String Mezzanine::UI::CheckBoxFactory::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 223 of file checkbox.cpp.


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