CEGUI::FalagardListHeader Class Reference

ListHeader class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardListHeader:

Collaboration diagram for CEGUI::FalagardListHeader:

Public Member Functions
	FalagardListHeader (const String &type)
	Constructor.
const String &	getSegmentWidgetType () const
void	setSegmentWidgetType (const String &type)
void	render ()
	Populate render cache. More...
ListHeaderSegment *	createNewSegment (const String &name) const
	Create and return a pointer to a new ListHeaderSegment based object. More...
void	destroyListSegment (ListHeaderSegment *segment) const
	Cleanup and destroy the given ListHeaderSegment that was created via the createNewSegment method. More...
Public Member Functions inherited from CEGUI::ListHeaderWindowRenderer
	ListHeaderWindowRenderer (const String &name)
	Constructor.
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 void	performChildWindowLayout ()
	Method called to perform extended laying out of the window's attached child windows.
virtual void	getRenderingContext (RenderingContext &ctx) const
	update the RenderingContext as needed for our window. This is normally invoked via our window's member function with the same name.
virtual void	update (float)
	perform any time based updates for this WindowRenderer.

Static Public Attributes
static const utf8	TypeName []
	type name for this widget.

Protected Attributes
String	d_segmentWidgetType

Static Protected Attributes
static FalagardListHeaderProperties::SegmentWidgetType	d_segmentWidgetTypeProperty

Additional Inherited Members
Protected Types inherited from CEGUI::WindowRenderer
typedef std::pair< Property *, bool >	PropertyEntry
	type used for entries in the PropertyList.
typedef std::vector < PropertyEntry >	PropertyList
	type to use for the property list.
Protected Member Functions inherited from CEGUI::WindowRenderer
void	registerProperty (Property *property, const bool ban_from_xml)
	Register a property class that will be properly managed by this window renderer. More...
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.
void	operator= (const WindowRenderer &)

Detailed Description

ListHeader class for the FalagardBase module.

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

Property Initialisers: SegmentWidgetType - type of widget to create for segments.

Imagery States:

• Enabled - basic rendering for enabled state.
• Disabled - basic rendering for disabled state.

Member Function Documentation

ListHeaderSegment* CEGUI::FalagardListHeader::createNewSegment ( const String &  name ) const

virtual

Create and return a pointer to a new ListHeaderSegment based object.

Parameters

name	String object holding the name that should be given to the new Window.

Returns

Pointer to an ListHeaderSegment based object of whatever type is appropriate for this ListHeader.

Implements CEGUI::ListHeaderWindowRenderer.

void CEGUI::FalagardListHeader::destroyListSegment ( ListHeaderSegment *  segment ) const

virtual

Cleanup and destroy the given ListHeaderSegment that was created via the createNewSegment method.

Parameters

segment

Pointer to a ListHeaderSegment based object to be destroyed.

Returns

Nothing.

Implements CEGUI::ListHeaderWindowRenderer.

void CEGUI::FalagardListHeader::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.