CHeaderPaintInfo Class Reference

Header related paint information. More...

#include <Dapfor/GUI/HeaderPaintInfo.h>

List of all members.

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 a hot column i.e. the actual column where the mouse is over.
const CColumn *	GetDropColumn () const
	Gets the column which is actually dragging.
DropPosition	GetDropPosition () const
	Gets a position relative to the hot column where a dragged column should be inserted.
bool	IsMouseCaptured () const
	Indicates that the mouse is captured by the header.
CFont *	GetFont () const
	Gets the font, a text is drawn with.
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.

Version:

1.0.0.0 Initial version

---

Member Enumeration Documentation

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 & Destructor Documentation

CHeaderPaintInfo	(	const CColumn *	hotColumn,
		const CColumn *	dropColumn,
		DropPosition	dropPosition,
		bool	mouseCaptured,
		CFont *	font,
		CImageList *	imageList,
		COLORREF	textColor
	)

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.

---

Member Function Documentation

const CColumn * GetHotColumn

(

)

const [inline]

Gets a hot column i.e. the actual column where the mouse is over.

Returns:

A hot column if it exists. Otherwise zero.

const CColumn * GetDropColumn

(

)

const [inline]

Gets the column which is actually dragging.

Returns:

A drop column if it exists. Otherwise zero.

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]

Indicates that the mouse is captured by the header.

Returns:

Value, indicating whether the mouse is captured by the header.

CFont * GetFont

(

)

const [inline]

Gets the font, a text is drawn with.

Returns:

Actually used font

CImageList * GetImageList

(

)

const [inline]

Gets an image list to draw icons in the header.

Returns:

Actually used image list

COLORREF GetTextColor

(

)

const [inline]

Gets a text color.

Returns:

Color, the text is drawn with.