Inheritance diagram for CEGUI::Tooltip:
Public Member Functions | |
Tooltip (const String &type, const String &name) | |
Constructor for the Tooltip base class constructor. | |
~Tooltip (void) | |
Destructor for the Tooltip base class. | |
void | setTargetWindow (Window *wnd) |
Sets the target window for the tooltip. This used internally to manage tooltips, you should not have to call this yourself. | |
const Window * | getTargetWindow () |
return the current target window for this Tooltip. | |
void | resetTimer (void) |
Resets the timer on the tooltip when in the Active / Inactive states. This is used internally to control the tooltip, it is not normally necessary to call this method yourself. | |
float | getHoverTime (void) const |
Return the number of seconds the mouse should hover stationary over the target window before the tooltip gets activated. | |
void | setDisplayTime (float seconds) |
Set the number of seconds the tooltip should be displayed for before it automatically de-activates itself. 0 indicates that the tooltip should never timesout and auto-deactivate. | |
float | getFadeTime (void) const |
Return the number of seconds that should be taken to fade the tooltip into and out of visibility. | |
void | setHoverTime (float seconds) |
Set the number of seconds the mouse should hover stationary over the target window before the tooltip gets activated. | |
float | getDisplayTime (void) const |
Return the number of seconds the tooltip should be displayed for before it automatically de-activates itself. 0 indicates that the tooltip never timesout and auto-deactivates. | |
void | setFadeTime (float seconds) |
Set the number of seconds that should be taken to fade the tooltip into and out of visibility. | |
void | positionSelf (void) |
Causes the tooltip to position itself appropriately. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventHoverTimeChanged |
Event fired when the hover timeout gets changed. | |
static const String | EventDisplayTimeChanged |
Event fired when the display timeout gets changed. | |
static const String | EventFadeTimeChanged |
Event fired when the fade timeout gets changed. | |
static const String | EventTooltipActive |
Event fired when the tooltip is about to get activated. | |
static const String | EventTooltipInactive |
Event fired when the tooltip has been deactivated. | |
Protected Types | |
enum | TipState { Inactive, Active, FadeIn, FadeOut } |
states for tooltip More... | |
Protected Member Functions | |
void | addTooltipEvents (void) |
Add ScrollablePane specific events. | |
void | doActiveState (float elapsed) |
void | doInactiveState (float elapsed) |
void | doFadeInState (float elapsed) |
void | doFadeOutState (float elapsed) |
void | switchToInactiveState (void) |
void | switchToActiveState (void) |
void | switchToFadeInState (void) |
void | switchToFadeOutState (void) |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
virtual Size | getTextSize () const |
Return the size of the area that will be occupied by the tooltip text, given any current formatting options. | |
virtual void | onHoverTimeChanged (WindowEventArgs &e) |
Event trigger method called when the hover timeout gets changed. | |
virtual void | onDisplayTimeChanged (WindowEventArgs &e) |
Event trigger method called when the display timeout gets changed. | |
virtual void | onFadeTimeChanged (WindowEventArgs &e) |
Event trigger method called when the fade timeout gets changed. | |
virtual void | onTooltipActive (WindowEventArgs &e) |
Event trigger method called just before the tooltip becomes active. | |
virtual void | onTooltipInactive (WindowEventArgs &e) |
Event trigger method called just after the tooltip is deactivated. | |
void | updateSelf (float elapsed) |
Perform actual update processing for this Window. | |
void | onMouseEnters (MouseEventArgs &e) |
Handler called when the mouse cursor has entered this window's area. | |
void | onTextChanged (WindowEventArgs &e) |
Handler called when the window's text is changed. | |
Protected Attributes | |
TipState | d_state |
Current tooltip state. | |
float | d_elapsed |
Used to track state change timings. | |
const Window * | d_target |
Current target Window for this Tooltip. | |
float | d_hoverTime |
tool-tip hover time (seconds mouse must stay stationary before tip shows). | |
float | d_displayTime |
tool-tip display time (seconds that tip is showsn for). | |
float | d_fadeTime |
tool-tip fade time (seconds it takes for tip to fade in and/or out). |
The Tooltip class shows a simple pop-up window around the mouse position with some text information. The tool-tip fades in when the user hovers with the mouse over a window which has tool-tip text set, and then fades out after some pre-set time.
|
states for tooltip
|
|
Return the number of seconds the tooltip should be displayed for before it automatically de-activates itself. 0 indicates that the tooltip never timesout and auto-deactivates.
|
|
Return the number of seconds that should be taken to fade the tooltip into and out of visibility.
|
|
Return the number of seconds the mouse should hover stationary over the target window before the tooltip gets activated.
|
|
return the current target window for this Tooltip.
|
|
Return the size of the area that will be occupied by the tooltip text, given any current formatting options.
|
|
Event trigger method called when the display timeout gets changed.
|
|
Event trigger method called when the fade timeout gets changed.
|
|
Event trigger method called when the hover timeout gets changed.
|
|
Handler called when the mouse cursor has entered this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the window's text is changed.
Reimplemented from CEGUI::Window. |
|
Event trigger method called just before the tooltip becomes active.
|
|
Event trigger method called just after the tooltip is deactivated.
|
|
Causes the tooltip to position itself appropriately.
|
|
Resets the timer on the tooltip when in the Active / Inactive states. This is used internally to control the tooltip, it is not normally necessary to call this method yourself.
|
|
Set the number of seconds the tooltip should be displayed for before it automatically de-activates itself. 0 indicates that the tooltip should never timesout and auto-deactivate.
|
|
Set the number of seconds that should be taken to fade the tooltip into and out of visibility.
|
|
Set the number of seconds the mouse should hover stationary over the target window before the tooltip gets activated.
|
|
Sets the target window for the tooltip. This used internally to manage tooltips, you should not have to call this yourself.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. |
|
Perform actual update processing for this Window.
Reimplemented from CEGUI::Window. |