CEGUI::FalagardTooltip Class Reference

Tooltip class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardTooltip:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::FalagardTooltip:

Collaboration graph
[legend]

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.

Static Public Attributes

static const utf8 TypeName [] = "Falagard/Tooltip"
 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.

References CEGUI::URect::asAbsolute(), CEGUI::WindowRenderer::d_window, CEGUI::Window::getArea(), CEGUI::WindowRenderer::getLookNFeel(), CEGUI::Window::getParentPixelSize(), and CEGUI::Tooltip::getTextSize_impl().

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.

References CEGUI::WindowRenderer::d_window, CEGUI::WindowRenderer::getLookNFeel(), CEGUI::WidgetLookFeel::getStateImagery(), CEGUI::Window::isDisabled(), and CEGUI::StateImagery::render().


Generated on Thu Nov 27 20:34:46 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1