MFC Grid manual

CTooltipCtrl Class Reference

Default implementation of ITooltipCtrl interface. More...

#include <Dapfor/GUI/TooltipCtrl.h>

Inheritance diagram for CTooltipCtrl:

ITooltipCtrl IAutoDelete CHtmlTooltipCtrl CInPlaceTooltipCtrl

List of all members.


Public Member Functions

 CTooltipCtrl (bool autoDelete)
 Constructor.
virtual ~CTooltipCtrl ()
 Virtual Destructor.
virtual bool Attach (CGrid &grid)
 Attaches a tooltip window to the grid.
virtual void Detach ()
 Detaches a tooltip window from the grid.
virtual bool Activate (const CGrid &grid, CGridCell &cell)
 Makes a tooltip window visible.
virtual void Desactivate ()
 Makes a tooltip window invisible.
virtual CString GetCurrentText () const
 Gets the text returned by ITooltip interface.
virtual CSize GetSize (const CGrid &grid, const CGridCell &cell) const
 Gets the size requested by the tooltip to show a text without restriction.
virtual const ITooltip & GetDefaultToolip () const
 Gets a default implementation of ITooltip interface.
virtual bool AutoDelete () const
 IAutoDelete implementation. Returns value passed in the constructor.

Protected Member Functions

const CGrid * GetGrid () const
 Gets the grid, to which the tooltip is attached.

Detailed Description

Default implementation of ITooltipCtrl interface.

Version:
1.0.0.0 Initial version

Constructor & Destructor Documentation

CTooltipCtrl ( bool  autoDelete  ) 

Constructor.

Parameters:
[in] autoDelete Indicates that this object can be destroyed in the destructor of CGrid

Member Function Documentation

bool Attach ( CGrid &  grid  )  [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.

Implements ITooltipCtrl.

Reimplemented in CHtmlTooltipCtrl.

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

Makes a tooltip window visible.

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

Implements ITooltipCtrl.

Reimplemented in CHtmlTooltipCtrl, and CInPlaceTooltipCtrl.

CString GetCurrentText (  )  const [virtual]

Gets the text returned by ITooltip interface.

Returns:
Text in the tooltip

Reimplemented in CHtmlTooltipCtrl, and CInPlaceTooltipCtrl.

CSize GetSize ( const CGrid &  grid,
const CGridCell &  cell 
) const [virtual]

Gets the size requested by the tooltip to show a text without restriction.

Returns:
Bounds, needed to show a text in the tooltip

Reimplemented in CHtmlTooltipCtrl, and CInPlaceTooltipCtrl.

const ITooltip & GetDefaultToolip (  )  const [virtual]

Gets a default implementation of ITooltip interface.

Returns:
Instance of CTooltip class

Implements ITooltipCtrl.

Reimplemented in CHtmlTooltipCtrl.

const CGrid * GetGrid (  )  const [protected]

Gets the grid, to which the tooltip is attached.

Returns:
The grid