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

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

#include <listbox.h>

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

Public Member Functions

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

Definition at line 282 of file listbox.h.

Member Function Documentation

ListBox * Mezzanine::UI::ListBoxFactory::CreateListBox ( const String RendName,
const UI::ScrollbarStyle Style,
Screen Parent 
)
virtual

Creates a new ListBox.

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

Definition at line 387 of file listbox.cpp.

ListBox * Mezzanine::UI::ListBoxFactory::CreateListBox ( const String RendName,
const UnifiedRect RendRect,
const UI::ScrollbarStyle Style,
Screen Parent 
)
virtual

Creates a new ListBox.

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

Definition at line 394 of file listbox.cpp.

ListBox * Mezzanine::UI::ListBoxFactory::CreateListBox ( const XML::Node XMLNode,
Screen Parent 
)
virtual

Creates a new ListBox.

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

Definition at line 401 of file listbox.cpp.

Widget * Mezzanine::UI::ListBoxFactory::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 408 of file listbox.cpp.

Widget * Mezzanine::UI::ListBoxFactory::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 415 of file listbox.cpp.

Widget * Mezzanine::UI::ListBoxFactory::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 427 of file listbox.cpp.

Widget * Mezzanine::UI::ListBoxFactory::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 439 of file listbox.cpp.

void Mezzanine::UI::ListBoxFactory::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 442 of file listbox.cpp.

String Mezzanine::UI::ListBoxFactory::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 384 of file listbox.cpp.


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