Safe Haskell	None

HGamer3D.Bindings.CEGUI.ClassTooltip

Synopsis

Documentation

new Source

Arguments

:: String	type
-> String	name
-> IO HG3DClass

Constructor for the Tooltip

delete Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance which is going to be deleted.
-> IO ()

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

Destructor for the Tooltip

setTargetWindow Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> HG3DClass	wnd - Window object that the tooltip should be associated with (for now).
-> IO ()	return value - Nothing.

return the current target window for this Tooltip

getTargetWindow Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO HG3DClass	return value - Pointer to the target window for this

resetTimer Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO ()	return value - Nothing.

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

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.

getHoverTime Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float	return value - float value representing a number of seconds.

setDisplayTime Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	seconds - float value representing a number of seconds.
-> IO ()	return value - Nothing.

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

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.

getFadeTime Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float	return value - float value representing a number of seconds.

setHoverTime Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	seconds - float value representing a number of seconds.
-> IO ()	return value - Nothing.

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.

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

getDisplayTime Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> IO Float	return value - float value representing a number of seconds.

setFadeTime Source

Arguments

:: HG3DClass	classpointer - pointer of Class instance from which this methods is called.
-> Float	seconds - float value representing a number of seconds.
-> IO ()	return value - Nothing.

Causes the tooltip to position itself appropriately.

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

positionSelf Source

Arguments