Owner-drawn context menu in WTL

Igor Vigdorchik

Rate me:

4.71/5 (22 votes)

24 Apr 2006CPOL3 min read

An article explaining how to create an owner-drawn context menu.

Download demo project - 72.6 Kb

WTL Context Menu

Introduction

I was looking for a code to implement an owner-drawn context menu in WTL, but could not find any; everything I found would modify the behavior of the CCommandBarCtrl, and could not be used in a context menu displayed by, let's say, an edit control.

In this article, I’ll show you how to implement an owner-drawn context menu, and how to add cool-looking menus to your application real easy, using my class CCoolContextMenu.

Implementation

In order to make an item an owner-drawn item, you must create a new menu item, or modify an existing one by setting the MFT_OWNERDRAW menu flag.

You can use the InsertMenuItem or SetMenuItemInfo functions to set or change information about a menu item. When calling these two functions, you must specify a pointer to a MENUITEMINFO structure, which specifies the properties of the menu item.

You need to specify the MFT_OWNERDRAW value for the fType member, for an item to become an owner-drawn item. You can also associate an application-defined value, which is called item data, with each menu item. The CCoolContextMenu class defines the MenuItemData structure that contains the information used to draw a menu item. The application uses the dwItemData member to store a pointer to this structure.

The MenuItemData structure is sent to the menu's owner window with the WM_MEASUREITEM and WM_DRAWITEM messages. The GetMenuItemInfo function is used to retrieve the item data for a menu at any time.

Copy Code

LRESULT InitMenuPopupHandler(UINT uMsg, WPARAM wParam, 
                             LPARAM lParam, BOOL& bHandled)
{
    // System menu, do nothing
    if ((BOOL)HIWORD(lParam))   
    {
        bHandled = FALSE;
        return 1;
    }

    CMenuHandle menuPopup = (HMENU)wParam;
    ATLASSERT(menuPopup.m_hMenu != NULL);

    TCHAR szString[MAX_MENU_ITEM_TEXT_LENGTH];
    BOOL bRet = FALSE;

    for (int i = 0; i < menuPopup.GetMenuItemCount(); i++)
    {
        CMenuItemInfo mii;
        mii.cch = MAX_MENU_ITEM_TEXT_LENGTH;
        mii.fMask = MIIM_CHECKMARKS | MIIM_DATA | MIIM_ID | 
                    MIIM_STATE | MIIM_SUBMENU | MIIM_TYPE;
        mii.dwTypeData = szString;
        bRet = menuPopup.GetMenuItemInfo(i, TRUE, &mii);
        ATLASSERT(bRet);

        if (!(mii.fType & MFT_OWNERDRAW))
        // not already an ownerdraw item
        {
            MenuItemData * pMI = new MenuItemData;
            ATLASSERT(pMI != NULL);

            if (pMI)
            {
                // Make this menu item an owner-drawn
                mii.fType |= MFT_OWNERDRAW;

                pMI->fType = mii.fType;
                pMI->fState = mii.fState;

                // Associate an image with a menu item
                static_cast<T*>(this)->AssociateImage(mii, pMI);

                pMI->lpstrText = new TCHAR[lstrlen(szString) + 1];
                ATLASSERT(pMI->lpstrText != NULL);

                if (pMI->lpstrText != NULL)
                    lstrcpy(pMI->lpstrText, szString);
                mii.dwItemData = (ULONG_PTR)pMI;

                bRet = menuPopup.SetMenuItemInfo(i, TRUE, &mii);
                ATLASSERT(bRet);
            }
        }
    }

    // Add it to the list
    m_stackMenuHandle.Push(menuPopup.m_hMenu);
    
    return 0;
}

Internally, CCoolContextMenu implements WM_MEASUREITEM, WM_DRAWITEM, WM_INITMENUPOPUP, and WM_MENUSELECT messages so you do not have to worry about anything.

Using the code

To use the CCoolContextMenu class, all you have to do is to derive your class from CCoolContextMenu and follow the next few steps:

Copy Code

class CCoolEdit : public CWindowImpl<CCoolEdit, CRichEditCtrl>,
                  public CRichEditCommands<CCoolEdit>,
                  public CCoolContextMenu<CCoolEdit>

In the message map, use CHAIN_MSG_MAP to redirect messages to CCoolContextMenu's message map:

Copy Code

BEGIN_MSG_MAP(CCoolEdit)
    ...
    CHAIN_MSG_MAP(CCoolContextMenu<CCoolEdit>)
END_MSG_MAP()

In the OnInitDialog() function of your dialog class, or in the OnCreate() function of the window class, call the GetSystemSettings() method of CCoolContextMenu:

Copy Code

LRESULT OnInitDialog(UINT uMsg, WPARAM wParam, 
                     LPARAM lParam, BOOL& bHandled)
{
    ...
    GetSystemSettings();
    ...
}

But wait! What about images? Don't worry, just create the image list and implement the AssociateImage(CMenuItemInfo& mii, MenuItemData * pMI) function in your CCoolContextMenu derived class:

Copy Code

void AssociateImage(CMenuItemInfo& mii, MenuItemData * pMI)
{
    switch (mii.wID)
    {
    case ID_EDIT_UNDO:
        pMI->iImage = 17;
        break;
    case ID_EDIT_CUT:
        pMI->iImage = 3;
        break;
    case ID_EDIT_COPY:
        pMI->iImage = 4;
        break;
    case ID_EDIT_PASTE:
        pMI->iImage = 5;
        break;
    case ID_EDIT_CLEAR:
        pMI->iImage = 20;
        break;
    default:
        pMI->iImage = -1;
        break;
    }
}

Conclusion

CCoolContextMenu allows you to add nice looking context menus to your application with just a few lines of code; and by combining my code with Jean-Michel's, your windows will look completely different.

My Thanks To

Jean-Michel LE FOL for the menu customization code in CMenuXP - The OfficeXP menu (WTL version)[^]
Do Young KIM for the bitmaps in XP Style - MainFrame in WTL[^]
Bjarke Viksøe and Justin Tay for answering my questions on the WTL Group[^]

History

March 13, 2006 - Initial release.
March 15, 2006 - Put a message map in the CCoolContextMenu class. Thanks to Jörgen Sigvardsson for suggesting it.
April 24, 2006 - Added a default implementation of the AssociateImage function to the CCoolContextMenu class.

Disclaimer

THIS SOFTWARE AND THE ACCOMPANYING FILES ARE DISTRIBUTED "AS IS" AND WITHOUT ANY WARRANTIES WHETHER EXPRESSED OR IMPLIED. NO RESPONSIBILITIES FOR POSSIBLE DAMAGES CAN BE TAKEN. THE USER MUST ASSUME THE ENTIRE RISK OF USING THIS SOFTWARE.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Igor Vigdorchik

	Web Developer
	United States

No Biography provided

Comments and Discussions

CBoldDC bold(*pDC, (lpDrawItemStruct->itemState & ODS_DEFAULT) != 0);

kuibing24-Jun-11 15:24

kuibing

24-Jun-11 15:24

There's a row of code :
CBoldDC bold(*pDC, (lpDrawItemStruct->itemState & ODS_DEFAULT) != 0);

But it never use it in DrawItem();

Does it make sense?

Nice work - but you undersold it!

John Hind16-Sep-10 1:01

John Hind

16-Sep-10 1:01

IF apply the fix suggested by bobnob below, which also fixes the problem noted by rajas, you can add this to a CMainFrame and it will pimp the main menus too! Also if you add a task tray menu, it is automatically pimped as well!

Great work - many, many thanks!

A few bugs and opportunities:

John Hind29-Sep-10 0:10

John Hind

29-Sep-10 0:10

I discovered a few things when testing and adapting this code:

1. The code assumes the menuitem will always be located at the left of the menu DC. This is not the case if the menu splits into more than one column. It is easily fixed by using the left coordinate of the rectangle rather than 0 in a few places.

2. By putting the cleanup code in WM_UNINITMENUPOPUP rather than WM_MENUSELECT it can be simplified and made more robust (i.e. you get a menu handle so you no longer need to store these in an array and it works if the menu is dismissed without making a selection).

3. You can avoid the need for the setup call by putting the code from that in the WM_MEASUREITEM handler and making it conditional on the m_menufont member being NULL, so it gets done once only.

4. A neat way of making icon attachment automatic is to simply store individual icons in the resources keyed on the command ID (in exactly the same way that string resources are used to provide status bar help for commands).

Re: A few bugs and opportunities:

Igor Vigdorchik29-Sep-10 14:03

Igor Vigdorchik

29-Sep-10 14:03

John,

Thanks for your comments. I am not sure I understand what you mean in 3 and 4. Could you please elaborate?

Re: A few bugs and opportunities:

John Hind29-Sep-10 22:56

John Hind

29-Sep-10 22:56

Sure!

I actually re-factored the code so the font caching code is in MeasureItem and the m_bFlatMenus flag is set in the constructor. However you could simply do:

if (m_fontMenu.IsNull()) GetSystemSettings();

at the start of MeasureItem. This avoids the need for the user of the code to explicitly call GetSystemSettings.

In InitMenuPopupHandler, I put the following line of code:

pMI->hIcon = (HICON)LoadImage(_Module.GetResourceInstance(),      MAKEINTRESOURCE(mii.wID), IMAGE_ICON, 16, 16, LR_DEFAULTCOLOR);

hIcon replaces iImage in the MenuItemData structure and DrawItem is simplified to draw this icon directly (unless it is NULL which it will be if the resource is absent). The icon is deleted again in my WM_UNINITMENUPOPUP handler. All you need to do to add an icon is put one in the resources and give it the same ID as the Menu Item (conveniently you can use the same symbolic constant). This follows the same pattern that ATL/WTL/MFC uses to associate help strings in the String Table with menu items.

I also refactored the code so it is self-contained and incorporated sidebar capability based on Cool WTL menu with Gradient Sidebar.

Re: A few bugs and opportunities:

Igor Vigdorchik30-Sep-10 14:27

Igor Vigdorchik

30-Sep-10 14:27

Thanks a lot, John.

My revised version:

John Hind29-Sep-10 23:00

John Hind

29-Sep-10 23:00

Copy Code

// JHCCMenu.h - implementation of the CCMenu class
// ===============================================
// Add-in template to pimp and add features to menus. May be added to CFrameWindowImpl
// class or any CWindowImpl class with a context menu. In former case, pimps main menu
// and any task-bar menu; in the latter, any context menus. Two steps are needed to use:
// 1-Add this template to the inheritance list of the class which implements the menus;
// 2-Add CHAIN_MSG_MAP(CCMenu<xxx>) to the class message map.
//
// Menus created from resources are converted automatically. Items with id = 0
// and MF_DISABLED are rendered as headings - horizontal unless the NEXT item
// has MF_MENUBARBREAK in which case a vertical sidebar. Icons from resources are
// used if they have a numeric id which matches the command id (similar to the way
// help string resources are matched to menu items).
//
// Menus created programatically have more flexibility. Use AppendCCMenu which takes
// the same parameters as AppendMenu but adds hIcon and uExtras parameters. You can
// specify the icon (or NULL). Extras flags are MFT_EX_HTITLE (= 1); MFT_EX_VTITLE
// (= 2) and MFT_EX_KEEP (= 4). The first two specify horizontal and vertical
// titles, the last prevents automatic clean-up when the menu closes. Use MFT_EX_KEEP
// if you create the menu once and then re-use it; you must then call DestroyCCMenu
// for each menu created (must be called for sub-menus too). If you create the menu
// anew each time in the WM_INITMENUPOPUP handler, leave this flag out and cleanup
// will be automatic (including destroying the icon if any).
//
// References:
// http://www.codeproject.com/KB/wtl/WTLOwnerDrawCtxtMenu.aspx
// http://www.codeproject.com/KB/wtl/sidebarmenu.aspx
// http://dvinogradov.blogspot.com/2007_01_01_archive.html
/////////////////////////////////////////////////////////////////////////////

#pragma once

#include "stdafx.h"

#define MAX_MENU_ITEM_TEXT_LENGTH       (100)
#define IMGPADDING                      (6)
#define TEXTPADDING                     (8)

#define SIDEBAR_FONT					(_T("TREBUCHET"))
#define TITLE_BG						(::GetSysColor(COLOR_HIGHLIGHT))
#define TITLE_TX						(::GetSysColor(COLOR_HIGHLIGHTTEXT))
#define MENU_BG							(HLS_TRANSFORM(::GetSysColor(COLOR_3DFACE), -4, 60))
#define ICON_BG							(HLS_TRANSFORM(::GetSysColor(COLOR_3DFACE), +20, 60))
#define MENU_TX							(::GetSysColor(COLOR_MENUTEXT))
#define MENU_DT							(::GetSysColor(COLOR_GRAYTEXT))
#define SELECT_BG						(HLS_TRANSFORM(::GetSysColor(COLOR_HIGHLIGHT), +70, -57))
#define SELECT_BR						(::GetSysColor(COLOR_HIGHLIGHT))
#define SEPARATOR_PN					(::GetSysColor(COLOR_HIGHLIGHT))

#ifndef OBM_CHECK
#define OBM_CHECK                       32760
#endif

#ifndef SPI_GETFLATMENU
	const UINT SPI_GETFLATMENU = 0x1022;
#endif

// Bit flags for "fExtra":
#define MFT_EX_HTITLE					(0x00000001L)
#define MFT_EX_VTITLE					(0x00000002L)
#define MFT_EX_KEEP						(0x00000004L)

template <class T>
class CCMenu
{
private:
    int m_cxExtraSpacing;
    COLORREF m_clrMask;
    SIZE m_szBitmap;
    SIZE m_szButton;
    CFont m_fontMenu;
    bool m_bFlatMenus;
	UINT m_itemHeight;
	bool m_bEnabled;

protected:
	struct MenuItemData	
	{
		LPTSTR lpstrText;
		UINT fType;
		UINT fState;
		UINT fExtra;
        HICON hIcon;
	};

	// Transforms an RGB colour by increasing or reducing its luminance and/or saturation in HLS space.
	COLORREF HLS_TRANSFORM(COLORREF rgb, int percent_L, int percent_S)
	{
		WORD h, l, s;
		ColorRGBToHLS(rgb, &h, &l, &s);
		if ( percent_L > 0 )
		{
			l = WORD(l + ((240 - l) * percent_L) / 100);
		}
		else if ( percent_L < 0 )
		{
			l = WORD((l * (100 + percent_L)) / 100);
		}
		if ( percent_S > 0 )
		{
			s = WORD(s + ((240 - s) * percent_S) / 100);
		}
		else if ( percent_S < 0 )
		{
			s = WORD((s * (100 + percent_S)) / 100);
		}
		if (l > 240) l = 240; if (l < 0) l = 0;
		if (s > 240) s = 240; if (s < 0) s = 0;
		return ColorHLSToRGB(h, l, s);
	}

	// Handles the WM_MEASUREITEM message.
	void MeasureItem(LPMEASUREITEMSTRUCT lpMeasureItemStruct)
	{
		MenuItemData* pmd = (MenuItemData*)lpMeasureItemStruct->itemData;

		if (m_fontMenu.IsNull())
		{	// First time only, cache the font and some drawing metrics
			NONCLIENTMETRICS info = { sizeof(NONCLIENTMETRICS), 0 };
			#if (WINVER >= 0x0600)
			OSVERSIONINFO osvi = { sizeof(OSVERSIONINFO), 0 };
			GetVersionEx(&osvi);
			if (osvi.dwMajorVersion < 6) info.cbSize -= sizeof(int);
			#endif
			::SystemParametersInfo(SPI_GETNONCLIENTMETRICS, info.cbSize, &info, 0);
			HFONT hFontMenu = ::CreateFontIndirect(&info.lfMenuFont);
			ATLASSERT(hFontMenu != NULL);
			m_fontMenu.Attach(hFontMenu);
			CWindowDC dc(NULL);
			HFONT hFontOld = dc.SelectFont(m_fontMenu);
			RECT rcText = { 0, 0, 0, 0 };
			dc.DrawText(_T("\t"), -1, &rcText, DT_SINGLELINE | DT_LEFT | DT_VCENTER | DT_CALCRECT);
			if ((rcText.right - rcText.left) < 4)
			{
				::SetRectEmpty(&rcText);
				dc.DrawText(_T("x"), -1, &rcText, DT_SINGLELINE | DT_LEFT | DT_VCENTER | DT_CALCRECT);
				m_cxExtraSpacing = rcText.right - rcText.left;
			}
			else
			{
				m_cxExtraSpacing = 0;
			}
			m_itemHeight = abs(info.lfMenuFont.lfHeight) + 10;
			dc.SelectFont(hFontOld);
		}

		if (pmd->fType & MFT_SEPARATOR)
		{   // separator - use quarter system height and leave width for system to calculate
			lpMeasureItemStruct->itemHeight = ::GetSystemMetrics(SM_CYMENU) / 4;
			lpMeasureItemStruct->itemWidth  = 0;
		}
		else if (pmd->fExtra & MFT_EX_VTITLE)
		{	// Sidebar - set width to height of normal item and leave height for system to calculate
			lpMeasureItemStruct->itemWidth = ::GetSystemMetrics(SM_CYMENU) - (::GetSystemMetrics(SM_CXMENUCHECK) - 1);
			lpMeasureItemStruct->itemHeight  = 0;
		}
		else
		{	// Compute size of text - use DrawText with DT_CALCRECT
			CWindowDC dc(NULL);
			CFont fontBold;
			HFONT hOldFont = NULL;
			if ((pmd->fState & MFS_DEFAULT) || (pmd->fExtra & MFT_EX_HTITLE))
			{	// Need bold version of font
				LOGFONT lf = { 0 };
				m_fontMenu.GetLogFont(lf);
				lf.lfWeight += 200;
				fontBold.CreateFontIndirect(&lf);
				ATLASSERT(fontBold.m_hFont != NULL);
				hOldFont = dc.SelectFont(fontBold);
                fontBold.DeleteObject();
			}
			else
			{	// Standard font
				hOldFont = dc.SelectFont(m_fontMenu);
			}
			RECT rcText = { 0, 0, 0, 0 };
			dc.DrawText(pmd->lpstrText, -1, &rcText, DT_SINGLELINE | DT_LEFT | DT_VCENTER | DT_CALCRECT);
            int cx = rcText.right - rcText.left;
			dc.SelectFont(hOldFont);
			cx += 4;                    // L/R margin for readability
			cx += 1;                    // space between button and menu text
			cx += 2 * m_szButton.cx;    // button width
			cx += m_cxExtraSpacing;     // extra between item text and accelerator keys
			cx -= ::GetSystemMetrics(SM_CXMENUCHECK) - 1;
			lpMeasureItemStruct->itemWidth = cx;
			lpMeasureItemStruct->itemHeight = m_itemHeight;
		}
	}

	// Draw the icon in greyscale within the given rectangle in the device context.
	void DrawDisabledIcon(HDC DC, CRect& Rect, HICON Icon)
	{
		WTL::CDC MemDC(CreateCompatibleDC(DC));
		BITMAPINFO bmi;
		ZeroMemory(&bmi, sizeof(BITMAPINFO));
		bmi.bmiHeader.biSize = sizeof(BITMAPINFOHEADER);
		bmi.bmiHeader.biWidth = Rect.Width();
		bmi.bmiHeader.biHeight = Rect.Height();
		bmi.bmiHeader.biPlanes = 1;
		bmi.bmiHeader.biBitCount = 32;
		bmi.bmiHeader.biCompression = BI_RGB;
		bmi.bmiHeader.biSizeImage = bmi.bmiHeader.biWidth * bmi.bmiHeader.biHeight * 4;
		VOID *pvBits;
		WTL::CBitmap Bitmap(::CreateDIBSection(MemDC, &bmi, DIB_RGB_COLORS, &pvBits, NULL, 0));
		WTL::CBitmapHandle PrevBitmap(MemDC.SelectBitmap(Bitmap));
		MemDC.DrawIconEx(0, 0, Icon, bmi.bmiHeader.biWidth, bmi.bmiHeader.biHeight);
		for (unsigned char *p = (unsigned char*)pvBits, *end = p + bmi.bmiHeader.biSizeImage; p < end; p += 4)
		{	// Gray = 0.3*R + 0.59*G + 0.11*B
			p[0] = p[1] = p[2] = (static_cast<unsigned int>(p[2]) *  77 + static_cast<unsigned int>(p[1]) * 151 +
				static_cast<unsigned int>(p[0]) *  28) >> 8;
		}
		BLENDFUNCTION BlendFunction;
		BlendFunction.BlendOp = AC_SRC_OVER;
		BlendFunction.BlendFlags = 0;
		BlendFunction.SourceConstantAlpha = 0x60;  // half transparent
		BlendFunction.AlphaFormat = AC_SRC_ALPHA;  // use bitmap alpha
		AlphaBlend(DC, Rect.left, Rect.top, bmi.bmiHeader.biWidth, bmi.bmiHeader.biHeight,
			MemDC, 0, 0, bmi.bmiHeader.biWidth, bmi.bmiHeader.biHeight, BlendFunction);
		MemDC.SelectBitmap(PrevBitmap);
	}

	// Draw a vertical (sidebar) title item.
	void DrawVTitle(LPDRAWITEMSTRUCT lpDrawItemStruct)
	{
		MenuItemData* pmd = (MenuItemData*)lpDrawItemStruct->itemData;
		CDCHandle dc = lpDrawItemStruct->hDC;
        CRect rc(lpDrawItemStruct->rcItem);
        CString sCaption = pmd->lpstrText;
		RECT rct; dc.GetClipBox(&rct);
		rc.bottom = rct.bottom - rct.top;
        dc.FillSolidRect(rc, TITLE_BG);
		rc.DeflateRect(2,2);
		HFONT hFont = CreateFont(rc.right - rc.left, 0, 900, 900, FW_BOLD, FALSE, FALSE, FALSE, DEFAULT_CHARSET,
			OUT_DEFAULT_PRECIS, CLIP_DEFAULT_PRECIS, PROOF_QUALITY, DEFAULT_PITCH | FF_DONTCARE, SIDEBAR_FONT);
		rc.InflateRect(2,2);
		int oldbkm = dc.SetBkMode(TRANSPARENT);
		COLORREF oldcolor = dc.SetTextColor(TITLE_TX);
		HFONT fontold = dc.SelectFont(hFont);
		dc.DrawText(sCaption, sCaption.GetLength(), rc, DT_SINGLELINE|DT_LEFT|DT_BOTTOM);
		dc.SelectFont(fontold);
		dc.SetTextColor(oldcolor);
		dc.SetBkMode(oldbkm);
	}

	// Draw a horizontal title item.
	void DrawHTitle(LPDRAWITEMSTRUCT lpDrawItemStruct)
	{
		MenuItemData* pmd = (MenuItemData*)lpDrawItemStruct->itemData;
		CDCHandle dc = lpDrawItemStruct->hDC;
        CRect rc(lpDrawItemStruct->rcItem);
		CRect rcx(rc);
        rcx.right = rc.left + m_szBitmap.cx + IMGPADDING;
        dc.FillSolidRect(rcx, ICON_BG);
        rcx.left = rcx.right;
        rcx.right = rc.right;
        dc.FillSolidRect(rcx, TITLE_BG);
		dc.SetTextColor(TITLE_TX);
		dc.SetBkMode(TRANSPARENT);
        CString sCaption = pmd->lpstrText;
		HFONT m_hDefFont = NULL;
		LOGFONT lf;
		CFont m_fontBold;
		dc.GetCurrentFont().GetLogFont(&lf);
		lf.lfWeight = FW_BOLD;
		m_fontBold.CreateFontIndirect(&lf);
		m_hDefFont = dc.SelectFont(m_fontBold);
        dc.DrawText(sCaption, sCaption.GetLength(), rcx, DT_SINGLELINE|DT_VCENTER|DT_CENTER);
		dc.SelectFont(m_hDefFont);
	}

	// Draw a horizontal separator bar.
	void DrawSeparator(LPDRAWITEMSTRUCT lpDrawItemStruct)
	{
		MenuItemData* pmd = (MenuItemData*)lpDrawItemStruct->itemData;
		CDCHandle dc = lpDrawItemStruct->hDC;
		CRect rc(lpDrawItemStruct->rcItem);
		CRect rcx(rc);
        rcx.right = rc.left + m_szBitmap.cx + IMGPADDING;
        dc.FillSolidRect(rcx, ICON_BG);
        rcx.left = rcx.right;
        rcx.right = rc.right;
        dc.FillSolidRect(rcx, MENU_BG);
		rcx.top += (rc.bottom - rc.top) / 2;
		rcx.left += 2; rcx.right -= 2;
		CPen newpen;
		HPEN oldpen;
		newpen.CreatePen(PS_SOLID, 1, SEPARATOR_PN);
		oldpen = dc.SelectPen(newpen);
		dc.MoveTo(CPoint(rcx.left, rcx.top));
		dc.LineTo(CPoint(rcx.right, rcx.top));
		dc.SelectPen(oldpen);
	}

	// Draw a normal menu item.
	void DrawActiveItem(LPDRAWITEMSTRUCT lpDrawItemStruct)
	{
		MenuItemData* pmd = (MenuItemData*)lpDrawItemStruct->itemData;
		CDCHandle dc = lpDrawItemStruct->hDC;
		CRect rc(lpDrawItemStruct->rcItem);
		BOOL bDisabled = lpDrawItemStruct->itemState & ODS_GRAYED;
 		BOOL bChecked = lpDrawItemStruct->itemState & ODS_CHECKED;
		BOOL bSelected = lpDrawItemStruct->itemState & ODS_SELECTED;
		BOOL bDefault = pmd->fState & MFS_DEFAULT;

        if (bSelected && !bDisabled)
        {	// Draw the selected item background
			HPEN oldpen;
			CPen newpen;
			newpen.CreatePen(PS_SOLID, 1, SELECT_BR);
			oldpen = dc.SelectPen(newpen);
			HBRUSH oldbrush;
			CBrush newbrush;
			newbrush.CreateSolidBrush(SELECT_BG);
			oldbrush = (HBRUSH)::SelectObject(dc, newbrush);
            dc.Rectangle(rc);
			dc.SelectBrush(oldbrush);
			dc.SelectPen(oldpen);
        }
        else
        {   // Draw the unselected item background
            CRect rcx(rc);
            rcx.right = rc.left + m_szBitmap.cx + IMGPADDING;
            dc.FillSolidRect(rcx, ICON_BG);
            rcx.left = rcx.right;
            rcx.right = rc.right;
            dc.FillSolidRect(rcx, MENU_BG);
        }

        // Draw the text
        CRect rcx(rc);
        CString sCaption = pmd->lpstrText;
        int nTab = sCaption.Find('\t');
        if (nTab >= 0) sCaption = sCaption.Left (nTab);
		dc.SetTextColor(bDisabled ? MENU_DT : MENU_TX);
		dc.SetBkMode(TRANSPARENT);
		HFONT m_hDefFont = NULL;
		if (bDefault)
		{	// If the item is default, use a bold font
			LOGFONT lf;
			CFont m_fontBold;
			CFontHandle ((HFONT)::GetCurrentObject (dc, OBJ_FONT)).GetLogFont (&lf);
			lf.lfWeight = FW_BOLD;
			m_fontBold.CreateFontIndirect (&lf);
			m_hDefFont = (HFONT)::SelectObject(dc, m_fontBold);
		}
        rcx.left += m_szBitmap.cx + IMGPADDING + TEXTPADDING;
        dc.DrawText(sCaption, sCaption.GetLength(), rcx, DT_SINGLELINE|DT_VCENTER|DT_LEFT);
        if (nTab >= 0)
        {    
            rcx.right -= TEXTPADDING + 4;
            dc.DrawText(pmd->lpstrText + nTab + 1, _tcslen(pmd->lpstrText + nTab + 1), rcx, DT_SINGLELINE|DT_VCENTER|DT_RIGHT);
        }
		if (m_hDefFont != NULL) dc.SelectFont(m_hDefFont);

		if (bChecked)
        {	// Draw the check mark:
			HPEN oldpen;
			CPen newpen;
			newpen.CreatePen(PS_SOLID, 1, SELECT_BR);
			oldpen = dc.SelectPen(newpen);
			HBRUSH oldbrush;
			CBrush newbrush;
			newbrush.CreateSolidBrush(bDisabled ? ICON_BG : (bSelected ? SELECT_BG : ICON_BG));
			oldbrush = (HBRUSH)::SelectObject(dc, newbrush);
            dc.Rectangle(CRect(rc.left + 1, rc.top + 1, rc.left + m_szButton.cx - 2, rc.bottom - 1));
			dc.SelectBrush(oldbrush);
			dc.SelectPen(oldpen);
			CRect rcx(rc);
            rcx.left  = rc.left + 2;
            rcx.right = rc.left + m_szBitmap.cx + IMGPADDING;
            dc.SetBkColor(bSelected? SELECT_BG : ICON_BG);
			rcx.top += 3; rcx.left += 2;
            HBITMAP hBmp = LoadBitmap(NULL, MAKEINTRESOURCE(OBM_CHECK));
            BOOL bRet = dc.DrawState(rcx.TopLeft(), rcx.Size(), hBmp, DSS_NORMAL, (HBRUSH)NULL);
            DeleteObject(hBmp);
        }
        else if (pmd->hIcon != NULL)
        {	// Draw the icon:
            if (bDisabled)
			{
				DrawDisabledIcon(dc, CRect(rc.left + 3, rc.top + 4, rc.left + 3 + m_szBitmap.cx, rc.top + 4 + m_szBitmap.cx), pmd->hIcon);
			}
			else
            {
				dc.DrawIconEx(CPoint(rc.left + 3, rc.top + 4), pmd->hIcon, CSize(m_szBitmap.cx, m_szBitmap.cx));
            }
        }
	}

	// Determine which type of item is to be drawn.
    void DrawItem(LPDRAWITEMSTRUCT lpDrawItemStruct)
	{
		MenuItemData* pmd = (MenuItemData*)lpDrawItemStruct->itemData;
        if (pmd->fType & MFT_SEPARATOR)
        {
			DrawSeparator(lpDrawItemStruct);
		}
		else if (pmd->fExtra & MFT_EX_VTITLE)
		{
			DrawVTitle(lpDrawItemStruct);
		}
		else if (pmd->fExtra & MFT_EX_HTITLE)
		{
			DrawHTitle(lpDrawItemStruct);
		}
		else
		{
			DrawActiveItem(lpDrawItemStruct);
		}
    }

	// Handle WM_INITMENUPOPUP by automatically converting non OWNERDRAW items.
    LRESULT InitMenuPopupHandler(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& bHandled)
    {        
		if ((BOOL)HIWORD(lParam))
		{	// System menu, do nothing
			bHandled = FALSE;
			return 1;
		}
		CMenuHandle menuPopup = (HMENU)wParam;
		ATLASSERT(menuPopup.m_hMenu != NULL);
        TCHAR szString[MAX_MENU_ITEM_TEXT_LENGTH];
		MenuItemData* pMIlast = NULL;
        for (int i = 0; i < menuPopup.GetMenuItemCount(); i++)
        {	// Process every menuitem in menu
            CMenuItemInfo mii;
            mii.cch = MAX_MENU_ITEM_TEXT_LENGTH;
            mii.fMask = MIIM_CHECKMARKS | MIIM_DATA | MIIM_ID | MIIM_STATE | MIIM_SUBMENU | MIIM_TYPE;
            mii.dwTypeData = szString;
			menuPopup.GetMenuItemInfo(i, TRUE, &mii);
            if (!(mii.fType & MFT_OWNERDRAW))
            {   // Not already an ownerdraw item
                MenuItemData* pMI = new MenuItemData;
                ATLASSERT(pMI != NULL);
 				pMI->fExtra = 0;
				pMI->hIcon = NULL;
				pMI->fType = mii.fType;
				pMI->fState = mii.fState;
				if (pMIlast)
				{	// If last item was a title and this has MENUBARBREAK, last should be vertical
					if (pMI->fType & MFT_MENUBARBREAK) pMIlast->fExtra = MFT_EX_VTITLE;
					pMIlast = NULL;
				}
				if ((mii.wID == 0) && (mii.fState & MF_DISABLED))
				{	// If ID is zero and it's disabled, it is a title, establish if vertical next item
					pMIlast = pMI;
					pMI->fExtra = MFT_EX_HTITLE;
				}
				pMI->lpstrText = new TCHAR[lstrlen(szString) + 1];
                ATLASSERT(pMI->lpstrText != NULL);
				lstrcpy(pMI->lpstrText, szString);
                mii.dwItemData = (ULONG_PTR)pMI;
                mii.fType |= MFT_OWNERDRAW;
				pMI->hIcon = (HICON)LoadImage(_Module.GetResourceInstance(), MAKEINTRESOURCE(mii.wID), IMAGE_ICON, 16, 16, LR_DEFAULTCOLOR);
				menuPopup.SetMenuItemInfo(i, TRUE, &mii);
             }
        }
        return 0;
    }

	// For WM_MEASUREITEM check it is an owner-draw menu and if so handle it.
	LRESULT MeasureItemHandler(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& bHandled)
	{
		LPMEASUREITEMSTRUCT lpMeasureItemStruct = (LPMEASUREITEMSTRUCT)lParam;
		MenuItemData* pmd = (MenuItemData*)lpMeasureItemStruct->itemData;
		if (lpMeasureItemStruct->CtlType == ODT_MENU && pmd != NULL)
		{
		    MeasureItem(lpMeasureItemStruct);
		}
		else
		{
			bHandled = FALSE;
		}
		return 1;
	}

	// For WM_DRAWITEM check it is an owner-draw menu and if so handle it.
    LRESULT DrawItemHandler(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& bHandled)
    {
        LPDRAWITEMSTRUCT lpDrawItemStruct = (LPDRAWITEMSTRUCT)lParam;
        MenuItemData* pMI = (MenuItemData*)lpDrawItemStruct->itemData;
		if (lpDrawItemStruct->CtlType == ODT_MENU && pMI != NULL)
		{
            DrawItem(lpDrawItemStruct);
		}
		else
		{
			bHandled = FALSE;
		}
        return 1;
    }

public:
    CCMenu()
    {
		m_bEnabled = false;
        m_cxExtraSpacing = 0;
        m_clrMask = RGB(192, 192, 192);
        m_szBitmap.cx = 16;
        m_szBitmap.cy = 15;
    	m_szButton.cx = m_szBitmap.cx + 6;
		m_szButton.cy = m_szBitmap.cy + 6;

		// Query flat menu mode (Windows XP or later)
		OSVERSIONINFO ovi = { sizeof(OSVERSIONINFO) };
		::GetVersionEx(&ovi);
		if (((ovi.dwMajorVersion == 5) && (ovi.dwMinorVersion >= 1)) || (ovi.dwMajorVersion > 5))
		{
			BOOL bRetVal = FALSE;
			BOOL bRet = ::SystemParametersInfo(SPI_GETFLATMENU, 0, &bRetVal, 0);
			m_bFlatMenus = (bRet && bRetVal);
		}
		// Mark as enabled to process messages
		m_bEnabled = true;
	}

    ~CCMenu()
    {
        if (!m_fontMenu.IsNull()) m_fontMenu.DeleteObject();
    }

	// Note: do not forget to put CHAIN_MSG_MAP in your message map.
	BEGIN_MSG_MAP(CCMenu)
        MESSAGE_HANDLER(WM_INITMENUPOPUP, OnInitMenuPopup)
		MESSAGE_HANDLER(WM_UNINITMENUPOPUP, OnUninitMenuPopup)
        MESSAGE_HANDLER(WM_MEASUREITEM, OnMeasureItem)
        MESSAGE_HANDLER(WM_DRAWITEM, OnDrawItem)
	END_MSG_MAP()

	// For programatic menu construction, works as AppendMenu with added optional hIcon and uExtras.
	BOOL AppendCCMenu(HMENU hMenu, UINT uFlags, UINT_PTR uIDNewItem = 0, LPCTSTR lpNewItem = NULL, HICON hIcon = NULL, UINT uExtras = 0)
	{
		if (m_bEnabled)
		{
			MenuItemData* pMI = new MenuItemData;
			pMI->lpstrText = new TCHAR[lstrlen(lpNewItem) + 1];
			ATLASSERT(pMI->lpstrText != NULL);
			if (lpNewItem == NULL)
				pMI->lpstrText[0] = 0;
			else
				lstrcpy(pMI->lpstrText, lpNewItem);
			pMI->fExtra = uExtras;
			pMI->hIcon = hIcon;
			pMI->fType = uFlags & (MF_BITMAP|MF_MENUBARBREAK|MF_MENUBREAK|MF_RIGHTJUSTIFY|MF_SEPARATOR|MF_STRING);
			pMI->fState = uFlags & (MF_CHECKED|MF_DEFAULT|MF_DISABLED|MF_GRAYED|MF_HILITE);
			return ::AppendMenu(hMenu, MF_OWNERDRAW | uFlags, uIDNewItem, (LPCWSTR)pMI);
		}
		else
		{
			return ::AppendMenu(hMenu, uFlags, uIDNewItem, lpNewItem);
		}
	}

	// Call this explicitly (defaulting the second parameter) if you use AppendCCmenu with the MFT_EX_KEEP
	// flag when you are done with the menu.
	void DestroyCCMenu(CMenuHandle menu, BOOL always = TRUE)
	{
        ATLASSERT(menu.m_hMenu != NULL);
        for (int i = 0; i < menu.GetMenuItemCount(); i++)
        {
			CMenuItemInfo mii;
            mii.fMask = MIIM_DATA | MIIM_TYPE;
            menu.GetMenuItemInfo(i, TRUE, &mii);
            MenuItemData* pMI = (MenuItemData*)mii.dwItemData;
            if (pMI != NULL)
            {
				if (!always) if (pMI->fExtra & MFT_EX_KEEP) return;
                mii.fMask = MIIM_DATA | MIIM_TYPE | MIIM_STATE;
                mii.fType = pMI->fType;
				mii.fState = pMI->fState;
                mii.dwTypeData = pMI->lpstrText;
                mii.cch = lstrlen(pMI->lpstrText);
                mii.dwItemData = NULL;
                menu.SetMenuItemInfo(i, TRUE, &mii);
				if (pMI->hIcon != NULL) DestroyIcon(pMI->hIcon);
                delete [] pMI->lpstrText;
                delete pMI;
            }
        }
	}

    LRESULT OnInitMenuPopup(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& bHandled)
    {
		if (!m_bEnabled) {bHandled = FALSE; return 1;}
        return InitMenuPopupHandler(uMsg, wParam, lParam, bHandled);
    }

    LRESULT OnUninitMenuPopup(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& bHandled)
    {
		if (!m_bEnabled) {bHandled = FALSE; return 0;}
		HMENU hMenu = (HMENU)wParam;
        CMenuHandle menuPopup = hMenu;
		DestroyCCMenu(menuPopup, FALSE);
		bHandled = FALSE;
		return 1;
    }

    LRESULT OnMeasureItem(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& bHandled)
    {
		if (!m_bEnabled) {bHandled = FALSE; return 0;}
        return MeasureItemHandler(uMsg, wParam, lParam, bHandled);
    }

    LRESULT OnDrawItem(UINT uMsg, WPARAM wParam, LPARAM lParam, BOOL& bHandled)
    {
		if (!m_bEnabled) {bHandled = FALSE; return 0;}
        return DrawItemHandler(uMsg, wParam, lParam, bHandled);
    }
}

Re: My revised version:

phoenicyan3-Jan-15 8:49

phoenicyan

3-Jan-15 8:49

I used the CCMenu by John for the mainframe menu and the various popup menus. Everything worked flawlessly! For a popup menu to work in a window xxx the following steps needed:
1) add derivation to the window:

Copy Code

public CCMenu<xxx>

;
2) enable context menu message handler:

Copy Code

	MESSAGE_HANDLER(WM_CONTEXTMENU, OnContextMenu)
...
LRESULT OnContextMenu(UINT /*uMsg*/, WPARAM /*wParam*/, LPARAM lParam, BOOL& /*bHandled*/)
{
	POINT pt = { GET_X_LPARAM(lParam), GET_Y_LPARAM(lParam) };
	HMENU hMenu = ::LoadMenu(_Module.GetResourceInstance(),(LPCTSTR)IDR_LISTV_MENU);
	if (hMenu != NULL)
	{
		HMENU hSubMenu = ::GetSubMenu(hMenu,0);
		if(hSubMenu != NULL)
		{
			::TrackPopupMenu(hSubMenu, TPM_LEFTBUTTON | TPM_RIGHTBUTTON, pt.x, pt.y, 0, m_hWnd, NULL);
			::PostMessage(m_hWnd, WM_NULL, 0, 0); 
		}
		::DestroyMenu(hMenu);
	}
	return 0;
}

3) create icons with the same ids as the menu items.

Thanks a lot for the CCMenu!

Menu not drawn second time

rajas23-Feb-09 20:32

rajas

23-Feb-09 20:32

Thank you for the great class.

I am trying it and think I have done what the article says. The first time the menu is brought up, everthing looks fine, the images are associated correctly and the menu looks good. However, when I call the menu for the second time, nothing is drawn - no text, no image. The menu window opens up to the correct size and small arrows are drawn to show popup menus that come from this menu, but nothing is drawn - if I put a breakpoint in the code for DrawItem, it is not called at all.

What am I doing wrong?

Re: Menu not drawn second time

Igor Vigdorchik24-Feb-09 14:12

Igor Vigdorchik

24-Feb-09 14:12

Take a look at the demo project and do exactly the same way, it will work.

Re: Menu not drawn second time

rajas4-Mar-09 19:04

rajas

4-Mar-09 19:04

Thanks - I see what is different in my project. Especially when it works correctly in one place ane not in another.

It turns out that your class requires that I create and destroy the menu each time it is invoked. However, I have another class (for a tray icon) which creates the menu the first time and then keeps it and reuses it each time it is called for - now there is nothing drawn after the first time. I see where you remove the data for each menu item. I either have to make a change in your class, or in the other. I also have the issue of sharing imagelist. So I probably have to make a change in your class to have the option of Shared image list & a menu that can have a longer life span than one showing.

Thank you for a very nice class.

Suggestion...

Oliver Jennert17-Feb-09 0:42

Oliver Jennert

17-Feb-09 0:42

Hello Igor,

you provided a great class; I also like the templatized design. The one thing that I consider to be a bit confusing is that the m_Imagelist is destroyed by the class but not created there.
I like the idea of having one imagelist for a whole application. But if I attach it to the m_Imagelist of multiple windows, it would be destroyed by the first window or dialog box that is closed.

So I suggest to use a flag like LVS_SHAREIMAGELISTS used by a ListView, which decides whether the imagelist is destroyed.

Oliver

Re: Suggestion...

Igor Vigdorchik18-Feb-09 15:03

Igor Vigdorchik

18-Feb-09 15:03

Hi, Oliver,

Thank you for a suggestion.

Igor.

Thanks man! [modified]

hssaroch26-May-08 1:28

hssaroch

26-May-08 1:28

modified 1-Dec-11 2:10am.

Re: Thanks man!

Igor Vigdorchik26-May-08 5:39

Igor Vigdorchik

26-May-08 5:39

You need to create an image list and implement the AssociateImage() function with the correct image ids. Just follow the sample code, it's all there.

Regards,
Igor.

Very Nice code, but small question!

SeekTruth3-Apr-08 23:25

SeekTruth

3-Apr-08 23:25

I found that i have to call Loadmenu and DestroyMenu each time while processing WM_RBUTTONDOWN message, does it necessary?

Re: Very Nice code, but small question!

Igor Vigdorchik4-Apr-08 6:47

Igor Vigdorchik

4-Apr-08 6:47

Yes, it's necessary.

Small fix

Val Salamakha18-May-07 15:24

Val Salamakha

18-May-07 15:24

Igor,

On the right button up, the richedit control is not focused and the cursor is not shown. So the menu item "Select All" does not work properly.

To fix the problem, it needs to add fuction SetFocus() as shown below:

LRESULT OnRButtonUp(UINT /*uMsg*/, WPARAM /*wParam*/, LPARAM lParam, BOOL& /*bHandled*/)
{
....
// Cursor's horizontal and vertical position
CPoint pt(GET_X_LPARAM(lParam), GET_Y_LPARAM(lParam));

// Convert client coordinates to screen coordinates
ClientToScreen(&pt);

SetFocus();

.....

Best Regards,

Val Salamakha

Re: Small fix [modified]

Igor Vigdorchik18-May-07 15:41

Igor Vigdorchik

18-May-07 15:41

Interesting, but it works for me. No one else complained either.

Re: Small fix

Val Salamakha18-May-07 20:07

Val Salamakha

18-May-07 20:07

Igor,

Maybe my computer has a problem with CPU due to an very early version of Hiper Technology on Intel P4 3.0 Ghz with XP. However the same problem was seen on my old Intel P2 400 Mhz with W2k.

Excellent piece of code

digitally_urs21-Dec-06 21:00

digitally_urs

21-Dec-06 21:00

you are the man (Y) thumbs up. It integrates seamlessly Smile | :)

, if you do not screw up your ATL and WTL includes order :P

Project Help Wanted

PrafullaT11-Sep-06 20:46

PrafullaT

11-Sep-06 20:46

Hello Experts,
I am involved into developement of Toolbar for IE.
In that I have one drop down menu- button.
I want the menu items of this menu to be hyperlinks.
A single menu item can have more than on words each poiting to
different websites.
These menutems are owner-drawn.
Please tell me how I put hyperlinks on MenuItems.
I am using WTL.
Still,if anyone knows how to do it in MFC,let me know.
I will port it to WTL myself!!!!!!!!
Thanks in advance

Found a bug

masterminder20-Jun-06 15:12

masterminder

20-Jun-06 15:12

in InitMenuPopupHandler():

The mii.fType was saved after setting the MFT_OWNERDRAW flag, so the restored menu item will have a MFT_OWNERDRAW flag. Simply exchange two lines will solve the program.

if (pMI)
{
// Make this menu item an owner-drawn
mii.fType |= MFT_OWNERDRAW; // <-- This should be done after save the fType to pMI

pMI->fType = mii.fType;
pMI->fState = mii.fState;

BTW, why not use a HMENU instead of resource id ? I construct the menu in run time, not from the resource.

Re: Found a bug

masterminder20-Jun-06 15:19

masterminder

20-Jun-06 15:19

bobnob wrote:
BTW, why not use a HMENU instead of resource id ? I construct the menu in run time, not from the resource.

Oh, I make a mistake, the menu resource id was not save by this class Poke tongue | ;-P

Good work (1 question)

sergytmp4-Jun-06 22:15

sergytmp

4-Jun-06 22:15

Hello Igor !
Thank you for sharing your code.

1 question: Then I use your cool menu with context menu in child dialog - all ok. But main menu of parent dialog (main menu of main application window) changes its look to cool too. First open of any submenu of main menu is Ok, but in second open I see menu without any text or cool graphics - only borders and background.

Please, can you give me some answer ?