CEGUI::FalagardProgressBar Class Reference

ProgressBar class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardProgressBar:

Collaboration diagram for CEGUI::FalagardProgressBar:

Public Member Functions
	FalagardProgressBar (const String &type)
	type name for this widget. More...
bool	isVertical () const
bool	isReversed () const
void	setVertical (bool setting)
void	setReversed (bool setting)
void	render ()
	Populate render cache. More...
Public Member Functions inherited from CEGUI::WindowRenderer
	WindowRenderer (const String &name, const String &class_name="Window")
	Constructor. More...
virtual	~WindowRenderer ()
	Destructor.
const String &	getName () const
	Returns the factory type name of this window renderer.
Window *	getWindow () const
	Get the window this windowrenderer is attached to.
const String &	getClass () const
	Get the "minimum" Window class this renderer requires.
const WidgetLookFeel &	getLookNFeel () const
	Get the Look'N'Feel assigned to our window.
virtual Rect	getUnclippedInnerRect () const
	Get unclipped inner rectangle that our window should return from its member function with the same name.
virtual Rect	getPixelRect () const
	Get actual pixel rectangle our window is to return from its member function with the same name.
virtual void	performChildWindowLayout ()
	Method called to perform extended laying out of the window's attached child windows.

Static Public Attributes
static const utf8	TypeName [] = "Falagard/ProgressBar"

Protected Attributes
bool	d_vertical
	True if progress bar operates on the vertical plane.
bool	d_reversed
	True if progress grows in the opposite direction to usual (i.e. to the left / downwards).
Protected Attributes inherited from CEGUI::WindowRenderer
Window *	d_window
	Pointer to the window this windowrenderer is assigned to.
const String	d_name
	Name of the factory type used to create this window renderer.
const String	d_class
	Name of the widget class that is the "minimum" requirement.
PropertyList	d_properties
	The list of properties that this windowrenderer will be handling.

Static Protected Attributes
static FalagardProgressBarProperties::VerticalProgress	d_verticalProperty
static FalagardProgressBarProperties::ReversedProgress	d_reversedProperty

Additional Inherited Members
Protected Types inherited from CEGUI::WindowRenderer
typedef std::vector< Property * >	PropertyList
Protected Member Functions inherited from CEGUI::WindowRenderer
void	registerProperty (Property *property)
	Register a property class that will be properly managed by this window renderer. More...
virtual void	onAttach ()
	Handler called when this windowrenderer is attached to a window.
virtual void	onDetach ()
	Handler called when this windowrenderer is detached from its window.
virtual void	onLookNFeelAssigned ()
	Handler called when a Look'N'Feel is assigned to our window.
virtual void	onLookNFeelUnassigned ()
	Handler called when a Look'N'Feel is removed/unassigned from our window.

Detailed Description

ProgressBar class for the FalagardBase module.

This class requires LookNFeel to be assigned. The LookNFeel should provide the following:

States:

• Enabled
• Disabled
• EnabledProgress
• DisabledProgress

Named Areas:

• ProgressArea

Property initialiser definitions:

• VerticalProgress - boolean property. Determines whether the progress widget is horizontal or vertical. Default is horizontal. Optional.

• ReversedProgress - boolean property. Determines whether the progress grows in the opposite direction to what is considered 'usual'. Set to "True" to have progress grow towards the left or bottom of the progress area. Optional.

Constructor & Destructor Documentation

CEGUI::FalagardProgressBar::FalagardProgressBar

(

const String &

type

)

type name for this widget.

Constructor

References CEGUI::WindowRenderer::registerProperty().

Member Function Documentation

void CEGUI::FalagardProgressBar::render ( )

virtual

Populate render cache.

This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API...

Implements CEGUI::WindowRenderer.

References d_reversed, d_vertical, CEGUI::WindowRenderer::d_window, CEGUI::NamedArea::getArea(), CEGUI::Window::getHeight(), CEGUI::WindowRenderer::getLookNFeel(), CEGUI::WidgetLookFeel::getNamedArea(), CEGUI::ComponentArea::getPixelRect(), CEGUI::ProgressBar::getProgress(), CEGUI::WidgetLookFeel::getStateImagery(), CEGUI::Window::isDisabled(), and CEGUI::StateImagery::render().