IlvToolTip Class Reference

Named Property class. More...

#include <ilviews/graphics/tooltip.h>

Inheritance diagram for IlvToolTip:

Public Member Functions
	IlvToolTip (const char label, IlvPalette palette=0, IlUShort xMargin=4, IlUShort yMargin=4, IlvAlignment alignment=IlvLeft)
	Constructor.
virtual void	abort (const IlvView view, const IlvGraphic graphic)
	Is called when the pointing device leaves the object associated with the tooltip.
virtual void	boundingBox (IlvRect &bbox, IlvDisplay *display=0) const
	Returns the bounding box of the tooltip.
virtual void	draw (IlvPort dst, const IlvRect &bbox, const IlvRegion clip) const
	Is called to draw the tooltip.
IlvAlignment	getAlignment () const
	Returns the label alignment of this tooltip if it extends over multiple lines.
const char *	getLabel () const
	Returns the label displayed by this tooltip.
IlvPalette *	getPalette () const
	Returns the palette used by this tooltip.
IlUShort	getXMargin () const
	Retrieves the horizontal margin of the text.
IlUShort	getYMargin () const
	Retrieves the vertical margin of the text.
virtual void	init (const IlvView view, const IlvGraphic graphic, const IlvPoint &point)
	Is called when the user places the mouse over the graphic object associated with the tooltip.
virtual void	reInit (const IlvView view, const IlvGraphic graphic, const IlvPoint &point)
	Is called when the user moves the mouse over the graphic object associated with the tooltip.
void	setAlignment (IlvAlignment alignment)
	Sets the label alignment of this tooltip if it extends over multiple lines.
void	setBackground (IlvColor *color)
	Sets the background color to be applied to this tooltip.
void	setForeground (IlvColor *color)
	Sets the foreground color to be applied to this tooltip.
void	setLabel (const char *label)
	Sets the labels displayed by this tooltip.
void	setPalette (IlvPalette *palette)
	Sets the palette to be used by this tooltip.
void	setXMargin (IlUShort xMargin)
	Sets the horizontal margin of the text.
void	setYMargin (IlUShort yMargin)
	Sets the vertical margin of the text.
virtual void	show (IlvView *view, IlvRect &bbox)
	Is called when this tooltip is about to be displayed.
Static Public Member Functions
static void	Enable (IlBoolean value)
	Enables or disables the tooltip feature.
static IlvPos	GetHorizontalOffset ()
	Returns the horizontal offset set for the tooltip window.
static IlvPalette *	GetPalette (const IlvToolTip , IlvDisplay )
	Returns the palette associated with the tooltip.
static IlUInt	GetTimerPeriod ()
	Returns the period of time in milliseconds that elapses before a tooltip is displayed.
static IlUInt	GetTimerVisibilityPeriod ()
	Returns the period of time in milliseconds that a tooltip is displayed.
static IlvToolTip *	GetToolTip (const IlvGraphic *obj)
	Returns the tooltip instance associated with the specified object.
static IlvPos	GetVerticalOffset ()
	Returns the vertical offset set for the tooltip window.
static IlBoolean	IsEnabled ()
	Indicates whether tooltips are enabled.
static void	SetHorizontalOffset (IlvPos offset)
	Sets the horizontal offset of the tooltip window.
static void	SetTimerPeriod (IlUInt period)
	Sets the period of time in milliseconds that elapses before a tooltip is displayed.
static void	SetTimerVisibilityPeriod (IlUInt period)
	Sets the period of time in milliseconds that a tooltip is displayed.
static void	SetVerticalOffset (IlvPos offset)
	Sets the vertical offset of the tooltip window.

Detailed Description

Named Property class.

Library: views

The class IlvToolTip defines tooltips. A tooltip is a short explanatory text that is displayed in a small window when the user leaves the mouse for a short while over a GUI component. Only objects stored in a gadget container or in gadget manager display tooltips. If you want to have tooltips in an another kind of object, see the IlvToolTipHandler class.

See also:: IlvGadgetContainer, IlvGadgetManager, IlvToolTipHandler

Constructor & Destructor Documentation

IlvToolTip::IlvToolTip	(	const char *	label,
		IlvPalette *	palette = `0`,
		IlUShort	xMargin = `4`,
		IlUShort	yMargin = `4`,
		IlvAlignment	alignment = `IlvLeft`
	)

Constructor.

Initializes a new instance of the class IlvToopTip that displays a text with the provided graphic attributes and the specified margins.

Parameters:

	label	The text that the tooltip displays. This text can extend over several lines separated by the ' ' character. This label is copied.
	palette	The palette used to display by the tooltip. If this parameter is omitted or set to 0, the default tooltip palette is used.
	xMargin	The horizontal margin of the text.
	yMargin	The vertical margin of the text.

Member Function Documentation

virtual void IlvToolTip::abort	(	const IlvView *	view,
		const IlvGraphic *	graphic
	)			`[virtual]`

Is called when the pointing device leaves the object associated with the tooltip.

Is called to indicate that the tooltip should be hidden.

Parameters:

	view	The view in which the object is displayed.
	graphic	A pointer to the object that owns the tooltip.

See also:: init, reInit

virtual void IlvToolTip::boundingBox	(	IlvRect &	bbox,
		IlvDisplay *	display = `0`
	)			const `[virtual]`

Returns the bounding box of the tooltip.

You can override this member function to give a specific size to the tooltip.

Parameters:

	bbox	The returned bounding box.
	display	The connection to the display. You can use this tooltip to provide a palette to the tooltip if it has no associated palette.

See also:: draw

virtual void IlvToolTip::draw	(	IlvPort *	dst,
		const IlvRect &	bbox,
		const IlvRegion *	clip
	)			const `[virtual]`

Is called to draw the tooltip.

You can override this member function to display images more elaborate than simple text lines.

Parameters:

	dst	The destination drawing port.
	bbox	The bounding box of the tooltip.
	clip	The clipping region.

See also:: boundingBox

static void IlvToolTip::Enable ( IlBoolean value ) [static]

Enables or disables the tooltip feature.

Parameters:

value A Boolean value specifying whether tooltips should be enables (IlTrue) or not (IlFalse). When value is set to IlFalse, tooltips are not displayed.

See also:: IsEnabled

IlvAlignment IlvToolTip::getAlignment ( ) const

Returns the label alignment of this tooltip if it extends over multiple lines.

Returns:: The label alignment used by this tooltip.

See also:: setAlignment

static IlvPos IlvToolTip::GetHorizontalOffset ( ) [static]

Returns the horizontal offset set for the tooltip window.

The default value is 0. This value aligns the x coordinate of the pointing device with the center of the tooltip window.

Returns:: The horizontal offset set for the tooltip window.

See also:: SetHorizontalOffset

const char* IlvToolTip::getLabel ( ) const

Returns the label displayed by this tooltip.

Returns:: The label displayed by this tooltip. The returned string should not be deleted or modified by the user.

See also:: setLabel

static IlvPalette* IlvToolTip::GetPalette	(	const IlvToolTip *	,
		IlvDisplay *
	)			`[static]`

Returns the palette associated with the tooltip.

If the palette has no associated palette, it returns the default tooltip palette.

Returns:: Returns the palette associated with the tooltip.

See also:: Enable

IlvPalette* IlvToolTip::getPalette ( ) const

Returns the palette used by this tooltip.

Returns:: The palette used by this tooltip or 0 if no palette has been set with the method IlvToolTip::setPalette.

See also:: setPalette

static IlUInt IlvToolTip::GetTimerPeriod ( ) [static]

Returns the period of time in milliseconds that elapses before a tooltip is displayed.

Returns:: The period of time in milliseconds that elapses between the moment when the mouse enters an object and its associated tooltip is displayed. The default value is 500 ms.

See also:: SetTimerPeriod

static IlUInt IlvToolTip::GetTimerVisibilityPeriod ( ) [static]

Returns the period of time in milliseconds that a tooltip is displayed.

Returns:: The period of time in milliseconds that a tooltip tooltip is displayed. The default value is 6000 ms.

See also:: SetTimerVisibilityPeriod

static IlvToolTip* IlvToolTip::GetToolTip ( const IlvGraphic * obj ) [static]

Returns the tooltip instance associated with the specified object.

Returns:: The tooltip instance associated with the specified object, or 0 if there is none.

static IlvPos IlvToolTip::GetVerticalOffset ( ) [static]

Returns the vertical offset set for the tooltip window.

The default value is 20. This value sets the top coordinate of the tooltip window 20 pixels below the pointing device location.

Returns:: The vertical offset set for the tooltip window.

See also:: SetVerticalOffset

IlUShort IlvToolTip::getXMargin ( ) const

Retrieves the horizontal margin of the text.

Returns:: The horizontal margin of the text.

See also:: setXMargin

IlUShort IlvToolTip::getYMargin ( ) const

Retrieves the vertical margin of the text.

Returns:: The vertical margin of the text.

See also:: setYMargin

virtual void IlvToolTip::init	(	const IlvView *	view,
		const IlvGraphic *	graphic,
		const IlvPoint &	point
	)			`[virtual]`

Is called when the user places the mouse over the graphic object associated with the tooltip.

Parameters:

	view	The view in which the graphic object is displayed.
	graphic	A pointer to the object that owns the tooltip.
	point	The coordinates of the last mouse event that occurred to the graphic object.

See also:: reInit

static IlBoolean IlvToolTip::IsEnabled ( ) [static]

Indicates whether tooltips are enabled.

Returns:: IlTrue if tooltips are enabled and IlFalse otherwise.

See also:: Enable

virtual void IlvToolTip::reInit	(	const IlvView *	view,
		const IlvGraphic *	graphic,
		const IlvPoint &	point
	)			`[virtual]`

Is called when the user moves the mouse over the graphic object associated with the tooltip.

Is called to indicate that the tooltip is not to be displayed.

Parameters:

	view	The view in which the graphic object is displayed.
	graphic	A pointer to the object that owns the tooltip.
	point	The coordinates of the last mouse event that occurred to the graphic object.

See also:: init, abort

void IlvToolTip::setAlignment ( IlvAlignment alignment )

Sets the label alignment of this tooltip if it extends over multiple lines.

Parameters:

alignment The label alignment. Valid values are IlvLeft, IlvCenter, and IlvRight.

See also:: getAlignment

void IlvToolTip::setBackground ( IlvColor * color )

Sets the background color to be applied to this tooltip.

Parameters:

color

The background color to be applied to this tooltip. This color is locked.

See also:: getPalette, setForeground

void IlvToolTip::setForeground ( IlvColor * color )

Sets the foreground color to be applied to this tooltip.

Parameters:

color

The foreground color to be applied to this tooltip. This color is locked.

See also:: getPalette, setBackground

static void IlvToolTip::SetHorizontalOffset ( IlvPos offset ) [static]

Sets the horizontal offset of the tooltip window.

Parameters:

The

new horizontal offset.

See also:: GetHorizontalOffset

void IlvToolTip::setLabel ( const char * label )

Sets the labels displayed by this tooltip.

The string is copied.

Parameters:

label

The label to be displayed by the tooltip.

See also:: getLabel

void IlvToolTip::setPalette ( IlvPalette * palette )

Sets the palette to be used by this tooltip.

Parameters:

palette

The palette to be used by the tooltip. The old palette, if any, is unlocked, and the new one is locked.

See also:: getPalette

static void IlvToolTip::SetTimerPeriod ( IlUInt period ) [static]

Sets the period of time in milliseconds that elapses before a tooltip is displayed.

Parameters:

period

The new timer period.

See also:: GetTimerPeriod

static void IlvToolTip::SetTimerVisibilityPeriod ( IlUInt period ) [static]

Sets the period of time in milliseconds that a tooltip is displayed.

Parameters:

period

The new timer period.

See also:: GetTimerVisibiltyPeriod

static void IlvToolTip::SetVerticalOffset ( IlvPos offset ) [static]

Sets the vertical offset of the tooltip window.

Parameters:

The

new vertical offset.

See also:: GetVerticalOffset

void IlvToolTip::setXMargin ( IlUShort xMargin )

Sets the horizontal margin of the text.

Parameters:

xMargin

The new horizontal margin of the text.

See also:: getXMargin

void IlvToolTip::setYMargin ( IlUShort yMargin )

Sets the vertical margin of the text.

Parameters:

yMargin

The new vertical margin of the text.

See also:: getYMargin

virtual void IlvToolTip::show	(	IlvView *	view,
		IlvRect &	bbox
	)			`[virtual]`

Is called when this tooltip is about to be displayed.

Parameters:

	view	The view in which the tooltip is displayed.
	bbox	The size of the tooltip window.

Rogue Wave ViewsFoundation Package API Reference Guide

IlvToolTip Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Rogue Wave Views
Foundation Package API Reference Guide