Crazy Eddies GUI System: CEGUI::FalagardTooltip Class Reference

Crazy Eddies GUI System 0.7.6

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Attributes
CEGUI::FalagardTooltip Class Reference

Tooltip class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardTooltip:
[legend]
Collaboration diagram for CEGUI::FalagardTooltip:
[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 []
| 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:

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