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

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

#include <menuentry.h>

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

Public Member Functions

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

Definition at line 224 of file menuentry.h.

Member Function Documentation

MenuEntry * Mezzanine::UI::MenuEntryFactory::CreateMenuEntry ( const String RendName,
Screen Parent 
)
virtual

Creates a new MenuEntry.

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

Definition at line 491 of file menuentry.cpp.

MenuEntry * Mezzanine::UI::MenuEntryFactory::CreateMenuEntry ( const String RendName,
const UnifiedRect RendRect,
Screen Parent 
)
virtual

Creates a new MenuEntry.

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

Definition at line 498 of file menuentry.cpp.

MenuEntry * Mezzanine::UI::MenuEntryFactory::CreateMenuEntry ( const XML::Node XMLNode,
Screen Parent 
)
virtual

Creates a new MenuEntry.

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

Definition at line 505 of file menuentry.cpp.

Widget * Mezzanine::UI::MenuEntryFactory::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 512 of file menuentry.cpp.

Widget * Mezzanine::UI::MenuEntryFactory::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 519 of file menuentry.cpp.

Widget * Mezzanine::UI::MenuEntryFactory::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 522 of file menuentry.cpp.

Widget * Mezzanine::UI::MenuEntryFactory::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 525 of file menuentry.cpp.

void Mezzanine::UI::MenuEntryFactory::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 528 of file menuentry.cpp.

String Mezzanine::UI::MenuEntryFactory::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 488 of file menuentry.cpp.


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