MFC Grid manual

CTooltipSettings Class Reference

Tooltip settings. More...

#include <Dapfor/GUI/TooltipSettings.h>

List of all members.


Serialization

void Serialize (CArchive &ar)
 Serializes/deserializes data to/from the archive.
static int GetSerializeVertion ()
 Gets a serialization version.

Public Types

enum  Position { Top, Bottom, Left, Right }
 Location relative to the cell where the tooltip should be displayed. More...
enum  Mode { Always, AutoPop }
 Displaying mode. More...

Public Member Functions

 CTooltipSettings ()
 Default constructor.
 CTooltipSettings (const CTooltipSettings &settings)
 Copy constructor.
 ~CTooltipSettings ()
 Destructor.
CTooltipSettingsoperator= (const CTooltipSettings &settings)
 Operator =.
Get- methods
COLORREF GetBackColor () const
 Gets a background color.
COLORREF GetTextColor () const
 Gets a text color.
COLORREF GetBorderColor () const
 Gets a color of the tooltip border.
int GetDelay () const
 Gets delay in milliseconds for displaying the tooltip.
int GetDisappearDelay () const
 Gets delay in milliseconds for withdrawing the tooltip.
CSize GetToolTipOffset () const
 Gets the distance in pixels between the tooltip and a cell.
CSize GetTextMargin () const
 Gets an offset in pixels to display text inside of the tooltip.
Position GetPosition () const
 Gets a position of the tooltip related to a cell.
Mode GetMode () const
 Gets a tooltip displaying mode.
Set- methods
void SetBackColor (COLORREF color)
 Sets a new background color.
void SetTextColor (COLORREF color)
 Sets a new text color.
void SetBorderColor (COLORREF color)
 Sets a new color of the border around the tooltip.
void SetDelay (int span)
 Sets a new delay in milliseconds for displaying the tooltip.
void SetDisappearDelay (int span)
 Sets a new delay in milliseconds for withdrawing the tooltip.
void SetToolTipOffset (CSize sz)
 Sets a new distance in pixels between the tooltip and a cell.
void SetTextMargin (CSize margin)
 Sets a new offset in pixels to display a text inside of the tooltip.
void SetPosition (Position position)
 Sets a new position of the tooltip related to a cell.
void SetMode (Mode mode)
 Sets a new tooltip displaying mode.

Detailed Description

Tooltip settings.

Version:
1.0.0.0 Initial version

Member Enumeration Documentation

enum Position

Location relative to the cell where the tooltip should be displayed.

Enumerator:
Top  on the top from the cell
Bottom  on the bottom from the cell
Left  on the left from the cell
Right  on the right from the cell

enum Mode

Displaying mode.

Enumerator:
Always  Always on the grid.
AutoPop  Is displayed when the mouse stays untouched on the cell for a specified amount of time.


Constructor & Destructor Documentation

CTooltipSettings ( const CTooltipSettings settings  ) 

Copy constructor.

Parameters:
[in] settings Settings to be copied


Member Function Documentation

COLORREF GetBackColor (  )  const

Gets a background color.

Returns:
Background color

COLORREF GetTextColor (  )  const

Gets a text color.

Returns:
Text color

COLORREF GetBorderColor (  )  const

Gets a color of the tooltip border.

Returns:
Border color

int GetDelay (  )  const

Gets delay in milliseconds for displaying the tooltip.

Returns:
Delay in milliseconds

int GetDisappearDelay (  )  const

Gets delay in milliseconds for withdrawing the tooltip.

Returns:
Delay in milliseconds

CSize GetToolTipOffset (  )  const

Gets the distance in pixels between the tooltip and a cell.

Returns:
Tooltop offset in pixels

CSize GetTextMargin (  )  const

Gets an offset in pixels to display text inside of the tooltip.

Returns:
Text offset in pixels

CTooltipSettings::Position GetPosition (  )  const

Gets a position of the tooltip related to a cell.

Returns:
Tooltip location

CTooltipSettings::Mode GetMode (  )  const

Gets a tooltip displaying mode.

Returns:
Tooltip mode

void SetBackColor ( COLORREF  color  ) 

Sets a new background color.

Parameters:
[in] color Background color

void SetTextColor ( COLORREF  color  ) 

Sets a new text color.

Parameters:
[in] color Text color

void SetBorderColor ( COLORREF  color  ) 

Sets a new color of the border around the tooltip.

Parameters:
[in] color Border color

void SetDelay ( int  delay  ) 

Sets a new delay in milliseconds for displaying the tooltip.

Parameters:
[in] delay Delay in milliseconds

void SetDisappearDelay ( int  delay  ) 

Sets a new delay in milliseconds for withdrawing the tooltip.

Parameters:
[in] delay Delay in milliseconds

void SetToolTipOffset ( CSize  offset  ) 

Sets a new distance in pixels between the tooltip and a cell.

Parameters:
[in] offset Tooltop offset in pixels

void SetTextMargin ( CSize  margin  ) 

Sets a new offset in pixels to display a text inside of the tooltip.

Parameters:
[in] margin Text offset in pixels

void SetPosition ( Position  position  ) 

Sets a new position of the tooltip related to a cell.

Parameters:
[in] position Tooltip location

void SetMode ( Mode  mode  ) 

Sets a new tooltip displaying mode.

Parameters:
[in] mode Tooltip mode

int GetSerializeVertion (  )  [static]

Gets a serialization version.

Returns:
Current serialization version

void Serialize ( CArchive &  ar  ) 

Serializes/deserializes data to/from the archive.

Parameters:
[in] ar Archive to store or restore the data.

CTooltipSettings & operator= ( const CTooltipSettings settings  ) 

Operator =.

Parameters:
[in] settings Settings to be copied
Returns:
Reference to 'this'