_common.h File Reference

Go to the source code of this file.

Detailed Description

Common constants and types.

Warning

You should not include this header directly. It is included by all public mCtrl headers.

Many mCtrl controls implement features outlined after <commctrl.h>, for sake of consistency and for sake of easiness of mCtrl adoption by developers with Win32API experience.

However we don't want to include that header in public mCtrl headers as, in general, mCtrl interface should be more self-contained.

Therefore this headers defines some constants and types which are equivalent to those in <commctrl.h>, with name beginning with a prefix MC_. Note that applications including both mCtrl headers and <commctrl.h> can use those constants and types interchangeably as the constants and types are binary compatible.

Note that documentation of the <commctrl.h> replacements is quite brief. Refer to MSDN documentation of their counterparts for more detailed info.

Additionally this header provides miscellaneous constants marking reserved ranges for messages and notifications of mCtrl controls (in a similar manner as <commctrl.h> does for COMCTL32.DLL controls).

Data Structures
struct	MC_NMCUSTOMDRAW
	Equivalent of NMCUSTOMDRAWINFO from <commctrl.h>. More...

Common Constants
#define	MC_CLR_NONE   ((COLORREF) 0xFFFFFFFF)
	Equivalent of CLR_NONE from <commctrl.h>. More...
#define	MC_CLR_DEFAULT   ((COLORREF) 0xFF000000)
	Equivalent of CLR_DEFAULT from <commctrl.h>. More...
#define	MC_I_IMAGECALLBACK   (-1)
	Equivalent of I_IMAGECALLBACK from <commctrl.h>. More...
#define	MC_I_IMAGENONE   (-2)
	Equivalent of I_IMAGENONE from <commctrl.h>. More...
#define	MC_I_CHILDRENCALLBACK   (-1)
	Equivalent of I_CHILDRENCALLBACK from <commctrl.h>. More...
#define	MC_LPSTR_TEXTCALLBACKW   ((LPWSTR)(INT_PTR) -1)
	Equivalent of LPSTR_TEXTCALLBACKW from <commctrl.h> (Unicode variant). More...
#define	MC_LPSTR_TEXTCALLBACKA   ((LPSTR)(INT_PTR) -1)
	Equivalent of LPSTR_TEXTCALLBACKA from <commctrl.h> (ANSI variant). More...

Unicode Resolution
#define	MC_LPSTR_TEXTCALLBACK   MCTRL_NAME_AW(MC_LPSTR_TEXTCALLBACK)
	Equivalent of LPSTR_TEXTCALLBACK from <commctrl.h>. More...

Control Specific Message Ranges
#define	MC_EXM_FIRST   (WM_USER+0x4000 + 0)
#define	MC_EXM_LAST   (WM_USER+0x4000 + 49)
#define	MC_GM_FIRST   (WM_USER+0x4000 + 50)
#define	MC_GM_LAST   (WM_USER+0x4000 + 199)
#define	MC_HM_FIRST   (WM_USER+0x4000 + 200)
#define	MC_HM_LAST   (WM_USER+0x4000 + 299)
#define	MC_MTM_FIRST   (WM_USER+0x4000 + 300)
#define	MC_MTM_LAST   (WM_USER+0x4000 + 399)
#define	MC_MBM_FIRST   (WM_USER+0x4000 + 400)
#define	MC_MBM_LAST   (WM_USER+0x4000 + 499)
#define	MC_PVM_FIRST   (WM_USER+0x4000 + 500)
#define	MC_PVM_LAST   (WM_USER+0x4000 + 599)
#define	MC_CHM_FIRST   (WM_USER+0x4000 + 600)
#define	MC_CHM_LAST   (WM_USER+0x4000 + 699)
#define	MC_TLM_FIRST   (WM_USER+0x4000 + 700)
#define	MC_TLM_LAST   (WM_USER+0x4000 + 799)
#define	MC_IVM_FIRST   (WM_USER+0x4000 + 800)
#define	MC_IVM_LAST   (WM_USER+0x4000 + 849)

Control Specific Notification Ranges
#define	MC_EXN_FIRST   (0x40000000 + 0)
#define	MC_EXN_LAST   (0x40000000 + 49)
#define	MC_GN_FIRST   (0x40000000 + 100)
#define	MC_GN_LAST   (0x40000000 + 199)
#define	MC_HN_FIRST   (0x40000000 + 200)
#define	MC_HN_LAST   (0x40000000 + 299)
#define	MC_MTN_FIRST   (0x40000000 + 300)
#define	MC_MTN_LAST   (0x40000000 + 349)
#define	MC_PVN_FIRST   (0x40000000 + 400)
#define	MC_PVN_LAST   (0x40000000 + 499)
#define	MC_CHN_FIRST   (0x40000000 + 500)
#define	MC_CHN_LAST   (0x40000000 + 599)
#define	MC_TLN_FIRST   (0x40000000 + 600)
#define	MC_TLN_LAST   (0x40000000 + 699)

---

Data Structure Documentation

struct MC_NMCUSTOMDRAW

Equivalent of NMCUSTOMDRAWINFO from <commctrl.h>.

For more detailed information refer to documentation of NMCUSTOMDRAWINFO on MSDN.

Data Fields
NMHDR	hdr
DWORD	dwDrawStage
HDC	hdc
RECT	rc
DWORD_PTR	dwItemSpec
UINT	uItemState
LPARAM	lItemlParam

Macro Definition Documentation

#define MC_CLR_NONE   ((COLORREF) 0xFFFFFFFF)

Equivalent of CLR_NONE from <commctrl.h>.

#define MC_CLR_DEFAULT   ((COLORREF) 0xFF000000)

Equivalent of CLR_DEFAULT from <commctrl.h>.

#define MC_I_IMAGECALLBACK   (-1)

Equivalent of I_IMAGECALLBACK from <commctrl.h>.

#define MC_I_IMAGENONE   (-2)

Equivalent of I_IMAGENONE from <commctrl.h>.

#define MC_I_CHILDRENCALLBACK   (-1)

Equivalent of I_CHILDRENCALLBACK from <commctrl.h>.

#define MC_LPSTR_TEXTCALLBACKW   ((LPWSTR)(INT_PTR) -1)

Equivalent of LPSTR_TEXTCALLBACKW from <commctrl.h> (Unicode variant).

#define MC_LPSTR_TEXTCALLBACKA   ((LPSTR)(INT_PTR) -1)

Equivalent of LPSTR_TEXTCALLBACKA from <commctrl.h> (ANSI variant).

#define MC_LPSTR_TEXTCALLBACK   MCTRL_NAME_AW(MC_LPSTR_TEXTCALLBACK)

Equivalent of LPSTR_TEXTCALLBACK from <commctrl.h>.

Unicode-resolution alias.

See Also

MC_LPSTR_TEXTCALLBACKW MC_LPSTR_TEXTCALLBACKA