Crazy Eddies GUI System  0.7.7
Public Member Functions | Static Public Attributes
CEGUI::FalagardTooltip Class Reference

Tooltip class for the FalagardBase module. More...

+ Inheritance diagram for CEGUI::FalagardTooltip:
+ Collaboration diagram for CEGUI::FalagardTooltip:

List of all members.

Public Member Functions

 FalagardTooltip (const String &type)
 Constructor.
void render ()
 Populate render cache.
Size getTextSize () const
 Return the size of the area that will be occupied by the tooltip text, given any current formatting options.
- 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.
virtual ~WindowRenderer ()
 Destructor.
const StringgetName () const
 Returns the factory type name of this window renderer.
WindowgetWindow () const
 Get the window this windowrenderer is attached to.
const StringgetClass () const
 Get the "minimum" Window class this renderer requires.
const WidgetLookFeelgetLookNFeel () 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.

Detailed Description

Tooltip class for the FalagardBase module.

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

States:

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.