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

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

#include <button.h>

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

Public Member Functions

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

Definition at line 239 of file button.h.

Member Function Documentation

Button * Mezzanine::UI::ButtonFactory::CreateButton ( const String RendName,
Screen Parent 
)
virtual

Creates a new Button.

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

Definition at line 376 of file button.cpp.

Button * Mezzanine::UI::ButtonFactory::CreateButton ( const String RendName,
const UnifiedRect RendRect,
Screen Parent 
)
virtual

Creates a new Button.

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

Definition at line 379 of file button.cpp.

Button * Mezzanine::UI::ButtonFactory::CreateButton ( const XML::Node XMLNode,
Screen Parent 
)
virtual

Creates a new Button.

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

Definition at line 382 of file button.cpp.

Widget * Mezzanine::UI::ButtonFactory::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 385 of file button.cpp.

Widget * Mezzanine::UI::ButtonFactory::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 388 of file button.cpp.

Widget * Mezzanine::UI::ButtonFactory::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 391 of file button.cpp.

Widget * Mezzanine::UI::ButtonFactory::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 394 of file button.cpp.

void Mezzanine::UI::ButtonFactory::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 397 of file button.cpp.

String Mezzanine::UI::ButtonFactory::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 373 of file button.cpp.


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