MFC Grid manual

CPaintInfo Class Reference

Contains painting information like colors, font, bounds, text adjustment. More...

#include <Dapfor/GUI/PaintInfo.h>

List of all members.


Public Member Functions

 CPaintInfo ()
 Default constructor.
 CPaintInfo (const CPaintInfo &PaintInfo)
 CPaintInfo (COLORREF foreColor, COLORREF backColor, CRect visibleRect, CRect virtualRect, CRect clipRect, CFont *font, int leftTextOffset, int rightTextOffset, const CHighlightSettings &settings)
COLORREF GetForeColor () const
 Gets foreground color.
COLORREF GetBackColor () const
 Gets background color.
const CRect & GetVisibleRect () const
 Gets a visible rectangle.
const CRect & GetVirtualRect () const
 Gets a virtual rectangle.
const CRect & GetClipRect () const
 Gets a clipped rectangle.
CFont * GetFont () const
 Gets a font.
int GetLeftTextOffset () const
 Gets an offset from the left of a virtual rectangle to paint a text.
int GetRightTextOffset () const
 Gets an offset from the right of a virtual rectangle to paint a text.
const CHighlightSettings & GetHighlightSettings () const
 Gets highlight settings.
void SetForeColor (COLORREF color)
 Sets new foreground color.
void SetBackColor (COLORREF color)
 Sets new background color.
void SetVisibleRect (const CRect &rc)
 Sets a new visible rectangle.
void SetVirtualRect (const CRect &rc)
 Sets a new virtual rectangle.
void SetClipRect (const CRect &rc)
 Sets a new clipped rectangle.
void SetFont (CFont *font)
 Sets a new font.
void SetLeftTextOffset (int offset)
 Sets a new offset to the left of a virtual rectangle to paint a text.
void SetRightTextOffset (int offset)
 Sets a new offset to the right of a virtual rectangle to paint a text.
void SetHighlightSettings (const CHighlightSettings &settings)
 Sets new highlight settings.

Detailed Description

Contains painting information like colors, font, bounds, text adjustment.

Version:
1.0.0.0 Initial version

Constructor & Destructor Documentation

CPaintInfo ( const CPaintInfo &  paintInfo  ) 

Copy constructor

Parameters:
[in] paintInfo Paint info to be copied

CPaintInfo ( COLORREF  foreColor,
COLORREF  backColor,
CRect  visibleRect,
CRect  virtualRect,
CRect  clipRect,
CFont *  font,
int  leftTextOffset,
int  rightTextOffset,
const CHighlightSettings &  settings 
)

Constructor

Parameters:
[in] foreColor Foreground color
[in] backColor Background color
[in] visibleRect Visible rectangle
[in] virtualRect Virtual rectangle
[in] clipRect Clipped rectangle
[in] font Pointer to a font object
[in] leftTextOffset Offset from the left of a virtual rectangle to paint a text
[in] rightTextOffset Offset from the right of a virtual rectangle to paint a text
[in] settings Highlight settings

Member Function Documentation

COLORREF GetForeColor (  )  const [inline]

Gets foreground color.

Returns:
Foreground color

COLORREF GetBackColor (  )  const [inline]

Gets background color.

Returns:
Background color

const CRect & GetVisibleRect (  )  const [inline]

Gets a visible rectangle.

Returns:
Visible rectangle

const CRect & GetVirtualRect (  )  const [inline]

Gets a virtual rectangle.

Returns:
Virtual rectangle

const CRect & GetClipRect (  )  const [inline]

Gets a clipped rectangle.

Returns:
Clipped rectangle

CFont * GetFont (  )  const [inline]

Gets a font.

Returns:
Pointer to a font object

int GetLeftTextOffset (  )  const [inline]

Gets an offset from the left of a virtual rectangle to paint a text.

Returns:
Offset in pixels

int GetRightTextOffset (  )  const [inline]

Gets an offset from the right of a virtual rectangle to paint a text.

Returns:
Offset in pixels

const CHighlightSettings & GetHighlightSettings (  )  const [inline]

Gets highlight settings.

Returns:
Highlight settings

void SetForeColor ( COLORREF  color  )  [inline]

Sets new foreground color.

Parameters:
[in] color Foreground color

void SetBackColor ( COLORREF  color  )  [inline]

Sets new background color.

Parameters:
[in] color Background color

void SetVisibleRect ( const CRect &  rc  )  [inline]

Sets a new visible rectangle.

Parameters:
[in] rc Visible rectangle

void SetVirtualRect ( const CRect &  rc  )  [inline]

Sets a new virtual rectangle.

Parameters:
[in] rc Virtual rectangle

void SetClipRect ( const CRect &  rc  )  [inline]

Sets a new clipped rectangle.

Parameters:
[in] rc Clipped rectangle

void SetFont ( CFont *  font  )  [inline]

Sets a new font.

Parameters:
[in] font Pointer to a font object

void SetLeftTextOffset ( int  offset  )  [inline]

Sets a new offset to the left of a virtual rectangle to paint a text.

Parameters:
[in] offset Offset from the left of a virtual rectangle to paint a text

void SetRightTextOffset ( int  offset  )  [inline]

Sets a new offset to the right of a virtual rectangle to paint a text.

Parameters:
[in] offset Offset from the right of a virtual rectangle to paint a text

void SetHighlightSettings ( const CHighlightSettings &  settings  )  [inline]

Sets new highlight settings.

Parameters:
[in] settings Highlight settings