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

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

#include <dropdownlist.h>

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

Public Member Functions

 DropDownListFactory ()
 Class constructor.
 
virtual ~DropDownListFactory ()
 Class destructor.
 
virtual DropDownListCreateDropDownList (const String &RendName, const UI::ScrollbarStyle &Style, Screen *Parent)
 Creates a new DropDownList. More...
 
virtual DropDownListCreateDropDownList (const String &RendName, const UnifiedRect &RendRect, const UI::ScrollbarStyle &Style, Screen *Parent)
 Creates a new DropDownList. More...
 
virtual DropDownListCreateDropDownList (const XML::Node &XMLNode, Screen *Parent)
 Creates a new DropDownList. 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 DropDownList widgets.

Definition at line 173 of file dropdownlist.h.

Member Function Documentation

DropDownList * Mezzanine::UI::DropDownListFactory::CreateDropDownList ( const String RendName,
const UI::ScrollbarStyle Style,
Screen Parent 
)
virtual

Creates a new DropDownList.

Parameters
RendNameThe name to be given to the created DropDownList.
StyleAn enum value representing how the scrollbar child of the ListBox will be constructed. See UI::ScrollbarStyle enum for more info.
ParentThe screen the created DropDownList will belong to.
Returns
Returns a pointer to the created DropDownList.

Definition at line 329 of file dropdownlist.cpp.

DropDownList * Mezzanine::UI::DropDownListFactory::CreateDropDownList ( const String RendName,
const UnifiedRect RendRect,
const UI::ScrollbarStyle Style,
Screen Parent 
)
virtual

Creates a new DropDownList.

Parameters
RendNameThe name to be given to the created DropDownList.
RendRectThe dimensions that will be assigned to the created DropDownList.
StyleAn enum value representing how the scrollbar child of the ListBox will be constructed. See UI::ScrollbarStyle enum for more info.
ParentThe screen the created DropDownList will belong to.
Returns
Returns a pointer to the created DropDownList.

Definition at line 336 of file dropdownlist.cpp.

DropDownList * Mezzanine::UI::DropDownListFactory::CreateDropDownList ( const XML::Node XMLNode,
Screen Parent 
)
virtual

Creates a new DropDownList.

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

Definition at line 343 of file dropdownlist.cpp.

Widget * Mezzanine::UI::DropDownListFactory::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 350 of file dropdownlist.cpp.

Widget * Mezzanine::UI::DropDownListFactory::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 357 of file dropdownlist.cpp.

Widget * Mezzanine::UI::DropDownListFactory::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 369 of file dropdownlist.cpp.

Widget * Mezzanine::UI::DropDownListFactory::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 381 of file dropdownlist.cpp.

void Mezzanine::UI::DropDownListFactory::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 384 of file dropdownlist.cpp.

String Mezzanine::UI::DropDownListFactory::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 326 of file dropdownlist.cpp.


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