CEGUI::FalagardTooltip Class Reference

Tooltip class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardTooltip:

Collaboration diagram for CEGUI::FalagardTooltip:

Public Member Functions
	FalagardTooltip (const String &type)
	Constructor.
void	render ()
	Populate render cache. More...
Size	getTextSize () const
	Return the size of the area that will be occupied by the tooltip text, given any current formatting options. More...
Public Member Functions inherited from CEGUI::TooltipWindowRenderer
	TooltipWindowRenderer (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.

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 &)
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.

Detailed Description

Tooltip class for the FalagardBase module.

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

States:

• Enabled
• Disabled

Named Areas: TextArea - Typically this would be the same area as the TextComponent you define to receive the tooltip text. This named area is used when deciding how to dynamically size the Tooltip so that text is not clipped.

Member Function Documentation

Size CEGUI::FalagardTooltip::getTextSize ( ) const

virtual

Return the size of the area that will be occupied by the tooltip text, given any current formatting options.

Returns

Size object describing the size of the rendered tooltip text in pixels.

Implements CEGUI::TooltipWindowRenderer.

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