DigitalSpaces::DICEGUITooltip Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
void	setTargetWindow (DICEGUIWindow *wnd)
	Sets the target window for the tooltip. This used internally to manage tooltips, you should not have to call this yourself.
DICEGUIWindow *	getTargetWindow ()
	return the current target window for this Tooltip.
void	resetTimer ()
	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 ()
	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 ()
	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 ()
	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 ()
	Causes the tooltip to position itself appropriately.
void	sizeSelf ()
	Causes the tooltip to resize itself appropriately.
void	getTextSize (out_Pairf *size)
	Return the size of the area that will be occupied by the tooltip text, given any current formatting options.

---

Member Function Documentation

void DigitalSpaces::DICEGUITooltip::setTargetWindow

(

DICEGUIWindow *

wnd

)

Sets the target window for the tooltip. This used internally to manage tooltips, you should not have to call this yourself.

Parameters:

wnd

Window object that the tooltip should be associated with (for now).

Returns:

Nothing.

DICEGUIWindow* DigitalSpaces::DICEGUITooltip::getTargetWindow

(

)

return the current target window for this Tooltip.

Returns:

Pointer to the target window for this Tooltip or 0 for none.

void DigitalSpaces::DICEGUITooltip::resetTimer

(

)

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.

Returns:

Nothing.

float DigitalSpaces::DICEGUITooltip::getHoverTime

(

)

Return the number of seconds the mouse should hover stationary over the target window before the tooltip gets activated.

Returns:

float value representing a number of seconds.

void DigitalSpaces::DICEGUITooltip::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.

Parameters:

seconds

float value representing a number of seconds.

Returns:

Nothing.

float DigitalSpaces::DICEGUITooltip::getFadeTime

(

)

Return the number of seconds that should be taken to fade the tooltip into and out of visibility.

Returns:

float value representing a number of seconds.

void DigitalSpaces::DICEGUITooltip::setHoverTime

(

float

seconds

)

Set the number of seconds the mouse should hover stationary over the target window before the tooltip gets activated.

Parameters:

seconds

float value representing a number of seconds.

Returns:

Nothing.

float DigitalSpaces::DICEGUITooltip::getDisplayTime

(

)

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.

Returns:

float value representing a number of seconds.

void DigitalSpaces::DICEGUITooltip::setFadeTime

(

float

seconds

)

Set the number of seconds that should be taken to fade the tooltip into and out of visibility.

Parameters:

seconds

float value representing a number of seconds.

Returns:

Nothing.

void DigitalSpaces::DICEGUITooltip::positionSelf

(

)

Causes the tooltip to position itself appropriately.

Returns:

Nothing.

void DigitalSpaces::DICEGUITooltip::sizeSelf

(

)

Causes the tooltip to resize itself appropriately.

Returns:

Nothing.

void DigitalSpaces::DICEGUITooltip::getTextSize

(

out_Pairf *

size

)

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.

---

The documentation for this struct was generated from the following file:

• CEGUIInterfaces/CEGUIInterfaces.h