ITooltipCtrl Class Reference

Interface to handle a tooltip location in the grid. More...

#include <Dapfor/GUI/ITooltipCtrl.h>

Inheritance diagram for ITooltipCtrl:

List of all members.

Public Member Functions
virtual	~ITooltipCtrl ()
	Virtual destructor.
virtual bool	Attach (CGrid &grid)=0
	Attaches a tooltip window to the grid.
virtual void	Detach ()=0
	Detaches a tooltip window from the grid.
virtual bool	Activate (const CGrid &grid, CGridCell &cell)=0
	Makes a tooltip window visible.
virtual void	Desactivate ()=0
	Makes a tooltip window invisible.
virtual const ITooltip &	GetDefaultToolip () const =0
	Gets default ITooltip implementation to display a grid's content.

---

Detailed Description

Interface to handle a tooltip location in the grid.

It is intended for handling the tooltip window, its location and also its visibility. The grid supports two types of tooltips. The first is usual window, appearing above a grid cell if the cursor does not move for a certain time interval and disappearing in a certain time interval, set in the grid parameters. The second type is so-called building-in window, appearing above a cell in the case when the cell is so small that not capable to display all text information. In this case the grid shows an emerging window precisely above the cell and displays in it the complete text contained in the cell, applying the same font, size, and also the way of aligning the text, as in the cell. GUI library gives some realizations of ITooltipCtrl interface. CTooltipCtrl and CTooltip classes give text information in a window. CHtmlTooltipCtrl and CHtmlTooltip realizations display a cell content in the Internet browser in the form of a html text. CInPlaceTooltipCtrl realization displays a partially visible text above a cell. Besides it's possible to realize arbitrary tooltips, representing information by means of MFC coltrols, or by means of the same grid.

---

Member Function Documentation

bool Attach

(

CGrid &

grid

)

[pure virtual]

Attaches a tooltip window to the grid.

Parameters:

[in]

grid

The grid

Returns:

True if the tooltip window has been successfully attached to the grid. Otherwse - false.

Implemented in CHtmlTooltipCtrl, and CTooltipCtrl.

bool Activate	(	const CGrid &	grid,
		CGridCell &	cell
	)			[pure virtual]

Makes a tooltip window visible.

Parameters:

[in]	grid	The grid
[in]	cell	Value indicates location and content of the tooltip

Implemented in CHtmlTooltipCtrl, CInPlaceTooltipCtrl, and CTooltipCtrl.

const ITooltip & GetDefaultToolip

(

)

const [pure virtual]

Gets default ITooltip implementation to display a grid's content.

Returns:

Default implementation to display a grid's content

Implemented in CHtmlTooltipCtrl, and CTooltipCtrl.