CEGUI::WindowRenderer Class Reference

Base-class for the assignable WindowRenderer object. More...

Inherits CEGUI::AllocatedObject< WindowRenderer >, and CEGUI::AllocatedObject< WindowRenderer >.

Inherited by CEGUI::EditboxWindowRenderer, CEGUI::EditboxWindowRenderer, CEGUI::FalagardButton, CEGUI::FalagardButton, CEGUI::FalagardDefault, CEGUI::FalagardDefault, CEGUI::FalagardFrameWindow, CEGUI::FalagardFrameWindow, CEGUI::FalagardListHeaderSegment, CEGUI::FalagardListHeaderSegment, CEGUI::FalagardProgressBar, CEGUI::FalagardProgressBar, CEGUI::FalagardStatic, CEGUI::FalagardStatic, CEGUI::FalagardTabButton, CEGUI::FalagardTabButton, CEGUI::FalagardTitlebar, CEGUI::FalagardTitlebar, CEGUI::FalagardTree, CEGUI::FalagardTree, CEGUI::InventoryItemRenderer, CEGUI::ItemEntryWindowRenderer, CEGUI::ItemEntryWindowRenderer, CEGUI::ItemListBaseWindowRenderer, CEGUI::ItemListBaseWindowRenderer, CEGUI::ListboxWindowRenderer, CEGUI::ListboxWindowRenderer, CEGUI::ListHeaderWindowRenderer, CEGUI::ListHeaderWindowRenderer, CEGUI::MultiColumnListWindowRenderer, CEGUI::MultiColumnListWindowRenderer, CEGUI::MultiLineEditboxWindowRenderer, CEGUI::MultiLineEditboxWindowRenderer, CEGUI::ScrollablePaneWindowRenderer, CEGUI::ScrollablePaneWindowRenderer, CEGUI::ScrollbarWindowRenderer, CEGUI::ScrollbarWindowRenderer, CEGUI::SliderWindowRenderer, CEGUI::SliderWindowRenderer, CEGUI::TabControlWindowRenderer, CEGUI::TabControlWindowRenderer, CEGUI::TooltipWindowRenderer, CEGUI::TooltipWindowRenderer, and WindowRenderer_wrapper.

Collaboration diagram for CEGUI::WindowRenderer:

Public Member Functions
	WindowRenderer (const String &name, const String &class_name="Window")
	Constructor. More...
virtual	~WindowRenderer ()
	Destructor.
virtual void	render ()=0
	Populate render cache. More...
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 Rectf	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.
virtual bool	handleFontRenderSizeChange (const Font *const font)
	Perform any updates needed because the given font's render size has changed. More...
	WindowRenderer (const String &name, const String &class_name="Window")
	Constructor. More...
virtual	~WindowRenderer ()
	Destructor.
virtual void	render ()=0
	Populate render cache. More...
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 Rectf	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.
virtual bool	handleFontRenderSizeChange (const Font *const font)
	Perform any updates needed because the given font's render size has changed. More...

Protected Types
typedef std::pair< Property *, bool >	PropertyEntry
	type used for entries in the PropertyList.
typedef std::vector< PropertyEntry CEGUI_VECTOR_ALLOC(PropertyEntry)>	PropertyList
	type to use for the property list.
typedef std::pair< Property *, bool >	PropertyEntry
	type used for entries in the PropertyList.
typedef std::vector< PropertyEntry CEGUI_VECTOR_ALLOC(PropertyEntry)>	PropertyList
	type to use for the property list.

Protected Member Functions
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	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.

Protected Attributes
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.

Friends
class	Window

Detailed Description

Base-class for the assignable WindowRenderer object.

Constructor & Destructor Documentation

CEGUI::WindowRenderer::WindowRenderer	(	const String &	name,
		const String &	class_name = "Window"
	)

Constructor.

Parameters

name	Factory type name
class_name	The name of a widget class that is to be the minimum requirement for this window renderer.

Referenced by CEGUI::FalagardTree::FalagardTree().

CEGUI::WindowRenderer::WindowRenderer	(	const String &	name,
		const String &	class_name = "Window"
	)

Constructor.

Parameters

name	Factory type name
class_name	The name of a widget class that is to be the minimum requirement for this window renderer.

Member Function Documentation

bool CEGUI::WindowRenderer::handleFontRenderSizeChange ( const Font *const  font )

virtual

Perform any updates needed because the given font's render size has changed.

/note This base implementation deals with updates needed for various definitions in the assigned widget look. If you override, you should generally always call this base class implementation.

Parameters

font	Pointer to the Font whose render size has changed.

Returns

• true if some action was taken.
• false if no action was taken (i.e font is not used here).

Reimplemented in CEGUI::FalagardStaticText, CEGUI::FalagardStaticText, CEGUI::FalagardEditbox, CEGUI::FalagardEditbox, CEGUI::FalagardMultiLineEditbox, CEGUI::FalagardMultiLineEditbox, CEGUI::FalagardListbox, CEGUI::FalagardListbox, CEGUI::FalagardMenuItem, and CEGUI::FalagardMenuItem.

References d_window, getLookNFeel(), and CEGUI::WidgetLookFeel::handleFontRenderSizeChange().

Referenced by WindowRenderer_wrapper::getUnclippedInnerRect(), CEGUI::FalagardListbox::handleFontRenderSizeChange(), CEGUI::FalagardMultiLineEditbox::handleFontRenderSizeChange(), CEGUI::FalagardEditbox::handleFontRenderSizeChange(), CEGUI::FalagardStaticText::handleFontRenderSizeChange(), CEGUI::Window::handleFontRenderSizeChange(), and WindowRenderer_wrapper::update().

virtual bool CEGUI::WindowRenderer::handleFontRenderSizeChange ( const Font *const  font )

virtual

Perform any updates needed because the given font's render size has changed.

/note This base implementation deals with updates needed for various definitions in the assigned widget look. If you override, you should generally always call this base class implementation.

Parameters

font	Pointer to the Font whose render size has changed.

Returns

• true if some action was taken.
• false if no action was taken (i.e font is not used here).

Reimplemented in CEGUI::FalagardStaticText, CEGUI::FalagardStaticText, CEGUI::FalagardEditbox, CEGUI::FalagardEditbox, CEGUI::FalagardMultiLineEditbox, CEGUI::FalagardMultiLineEditbox, CEGUI::FalagardListbox, CEGUI::FalagardListbox, CEGUI::FalagardMenuItem, and CEGUI::FalagardMenuItem.

void CEGUI::WindowRenderer::registerProperty ( Property *  property, const bool  ban_from_xml  )

protected

Register a property class that will be properly managed by this window renderer.

Parameters

property	Pointer to a static Property object that will be added to the target window.
ban_from_xml	true if this property should be added to the 'ban' list so that it is not written in XML output. false if this property is not banned and should appear in XML output.

void CEGUI::WindowRenderer::registerProperty ( Property *  property, const bool  ban_from_xml  )

protected

Register a property class that will be properly managed by this window renderer.

Parameters

property	Pointer to a static Property object that will be added to the target window.
ban_from_xml	true if this property should be added to the 'ban' list so that it is not written in XML output. false if this property is not banned and should appear in XML output.

References d_properties.

Referenced by WindowRenderer_wrapper::performChildWindowLayout(), and registerProperty().

void CEGUI::WindowRenderer::registerProperty ( Property *  property )

protected

Register a property class that will be properly managed by this window renderer.

Parameters

property

Pointer to a static Property object that will be added to the target window.

References registerProperty().

void CEGUI::WindowRenderer::registerProperty ( Property *  property )

protected

Register a property class that will be properly managed by this window renderer.

Parameters

property

Pointer to a static Property object that will be added to the target window.

virtual void CEGUI::WindowRenderer::render ( )

pure 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...

Implemented in CEGUI::FalagardStaticText, CEGUI::FalagardStaticText, CEGUI::FalagardEditbox, CEGUI::FalagardEditbox, WindowRenderer_wrapper, CEGUI::FalagardStatic, CEGUI::FalagardStatic, CEGUI::FalagardMultiLineEditbox, CEGUI::FalagardMultiLineEditbox, CEGUI::FalagardListbox, CEGUI::FalagardListbox, CEGUI::FalagardMultiColumnList, CEGUI::FalagardMultiColumnList, CEGUI::FalagardStaticImage, CEGUI::FalagardStaticImage, CEGUI::FalagardProgressBar, CEGUI::FalagardProgressBar, CEGUI::FalagardSlider, CEGUI::FalagardSlider, CEGUI::FalagardScrollbar, CEGUI::FalagardTabControl, CEGUI::FalagardScrollbar, CEGUI::FalagardTabControl, CEGUI::FalagardTree, CEGUI::FalagardTree, CEGUI::FalagardMenuItem, CEGUI::FalagardMenuItem, CEGUI::FalagardFrameWindow, CEGUI::FalagardFrameWindow, CEGUI::FalagardListHeader, CEGUI::FalagardListHeader, CEGUI::FalagardItemListbox, CEGUI::FalagardItemListbox, CEGUI::FalagardItemEntry, CEGUI::FalagardListHeaderSegment, CEGUI::FalagardScrollablePane, CEGUI::FalagardItemEntry, CEGUI::FalagardListHeaderSegment, CEGUI::FalagardScrollablePane, CEGUI::FalagardMenubar, CEGUI::FalagardPopupMenu, CEGUI::FalagardTooltip, CEGUI::FalagardMenubar, CEGUI::FalagardPopupMenu, CEGUI::FalagardTooltip, CEGUI::FalagardButton, CEGUI::FalagardButton, CEGUI::FalagardTabButton, CEGUI::FalagardTabButton, CEGUI::FalagardTitlebar, CEGUI::FalagardTitlebar, CEGUI::FalagardDefault, CEGUI::FalagardDefault, and CEGUI::InventoryItemRenderer.

Referenced by CEGUI::Window::bufferGeometry(), and WindowRenderer_wrapper::update().

virtual void CEGUI::WindowRenderer::render ( )

pure 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...

Implemented in CEGUI::FalagardStaticText, CEGUI::FalagardStaticText, CEGUI::FalagardEditbox, CEGUI::FalagardEditbox, WindowRenderer_wrapper, CEGUI::FalagardStatic, CEGUI::FalagardStatic, CEGUI::FalagardMultiLineEditbox, CEGUI::FalagardMultiLineEditbox, CEGUI::FalagardListbox, CEGUI::FalagardListbox, CEGUI::FalagardMultiColumnList, CEGUI::FalagardMultiColumnList, CEGUI::FalagardStaticImage, CEGUI::FalagardStaticImage, CEGUI::FalagardProgressBar, CEGUI::FalagardProgressBar, CEGUI::FalagardSlider, CEGUI::FalagardSlider, CEGUI::FalagardScrollbar, CEGUI::FalagardTabControl, CEGUI::FalagardScrollbar, CEGUI::FalagardTabControl, CEGUI::FalagardTree, CEGUI::FalagardTree, CEGUI::FalagardMenuItem, CEGUI::FalagardMenuItem, CEGUI::FalagardFrameWindow, CEGUI::FalagardFrameWindow, CEGUI::FalagardListHeader, CEGUI::FalagardListHeader, CEGUI::FalagardItemListbox, CEGUI::FalagardItemListbox, CEGUI::FalagardItemEntry, CEGUI::FalagardListHeaderSegment, CEGUI::FalagardScrollablePane, CEGUI::FalagardItemEntry, CEGUI::FalagardListHeaderSegment, CEGUI::FalagardScrollablePane, CEGUI::FalagardMenubar, CEGUI::FalagardPopupMenu, CEGUI::FalagardTooltip, CEGUI::FalagardMenubar, CEGUI::FalagardPopupMenu, CEGUI::FalagardTooltip, CEGUI::FalagardButton, CEGUI::FalagardButton, CEGUI::FalagardTabButton, CEGUI::FalagardTabButton, CEGUI::FalagardTitlebar, CEGUI::FalagardTitlebar, CEGUI::FalagardDefault, CEGUI::FalagardDefault, and CEGUI::InventoryItemRenderer.