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

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

#include <verticalscrollbar.h>

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

Public Member Functions

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

Definition at line 159 of file verticalscrollbar.h.

Member Function Documentation

VerticalScrollbar * Mezzanine::UI::VerticalScrollbarFactory::CreateVerticalScrollbar ( const String RendName,
const UI::ScrollbarStyle Style,
Screen Parent 
)
virtual

Creates a new VerticalScrollbar.

Parameters
RendNameThe name to be given to the created VerticalScrollbar.
StyleAn enum value representing how to position the button layout of the scrollbar. See UI::ScrollbarStyle enum for more info.
ParentThe screen the created VerticalScrollbar will belong to.
Returns
Returns a pointer to the created VerticalScrollbar.

Definition at line 586 of file verticalscrollbar.cpp.

VerticalScrollbar * Mezzanine::UI::VerticalScrollbarFactory::CreateVerticalScrollbar ( const String RendName,
const UnifiedRect RendRect,
const UI::ScrollbarStyle Style,
Screen Parent 
)
virtual

Creates a new VerticalScrollbar.

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

Definition at line 593 of file verticalscrollbar.cpp.

VerticalScrollbar * Mezzanine::UI::VerticalScrollbarFactory::CreateVerticalScrollbar ( const XML::Node XMLNode,
Screen Parent 
)
virtual

Creates a new VerticalScrollbar.

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

Definition at line 600 of file verticalscrollbar.cpp.

Widget * Mezzanine::UI::VerticalScrollbarFactory::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 607 of file verticalscrollbar.cpp.

Widget * Mezzanine::UI::VerticalScrollbarFactory::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 614 of file verticalscrollbar.cpp.

Widget * Mezzanine::UI::VerticalScrollbarFactory::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 626 of file verticalscrollbar.cpp.

Widget * Mezzanine::UI::VerticalScrollbarFactory::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 638 of file verticalscrollbar.cpp.

void Mezzanine::UI::VerticalScrollbarFactory::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 641 of file verticalscrollbar.cpp.

String Mezzanine::UI::VerticalScrollbarFactory::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 583 of file verticalscrollbar.cpp.


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