MFC Grid manual

CHeaderPaintInfo Class Reference

Header related paint information. More...

#include <Dapfor/GUI/HeaderPaintInfo.h>


Public Types
enum	DropPosition { None, Begin, End }
	indicates the position at which a column should be dropped. More...
Public Member Functions
	CHeaderPaintInfo (const CColumn hotColumn, const CColumn dropColumn, DropPosition dropPosition, bool mouseCaptured, CFont font, CImageList imageList, COLORREF textColor)
	Constructor.
const CColumn *	GetHotColumn () const
	Gets the hot column i.e. the actual column over which the mouse cursor is located.
const CColumn *	GetDropColumn () const
	Gets the column that is actually dragging.
DropPosition	GetDropPosition () const
	Gets a position relative to the hot column where a dragged column should be inserted.
bool	IsMouseCaptured () const
	Specifies whether mouse is captured by the header.
CFont *	GetFont () const
	Gets the font used for drawing text.
CImageList *	GetImageList () const
	Gets an image list to draw icons in the header.
COLORREF	GetTextColor () const
	Gets a text color.

Detailed Description

Header related paint information.

enum DropPosition

indicates the position at which a column should be dropped.

Enumerator:

None	No column is actually dragged.
Begin	Dragged column should be dropped before the current column.
End	Dragged column should be dropped after the current column.

Constructor.

Parameters:

`[in]`	hotColumn	The actual column where the mouse is over. Can be zero.
`[in]`	dropColumn	The column to be dropped. Can be zero.
`[in]`	dropPosition	Position relative to the hot column where a dropped column should be inserted.
`[in]`	mouseCaptured	Indicates that the mouse is captured by the header.
`[in]`	font	Font to display a text.
`[in]`	imageList	Image list
`[in]`	textColor	Color of a displaying text.

const CColumn * GetHotColumn ( ) const [inline]

Gets the hot column i.e. the actual column over which the mouse cursor is located.

const CColumn * GetDropColumn ( ) const [inline]

Gets the column that is actually dragging.

DropPosition GetDropPosition ( ) const [inline]

Gets a position relative to the hot column where a dragged column should be inserted.

Returns:: A drop position if a drop operation is actually performed. Otherwise CHeaderPaintInfo::None

bool IsMouseCaptured ( ) const [inline]

Specifies whether mouse is captured by the header.

CFont * GetFont ( ) const [inline]

Gets the font used for drawing text.

CImageList * GetImageList ( ) const [inline]

Gets an image list to draw icons in the header.

COLORREF GetTextColor ( ) const [inline]

Gets a text color.