// Name: msw/ownerdrw.cpp
// Purpose: implementation of wxOwnerDrawn class
// Author: Vadim Zeitlin
-// Modified by:
+// Modified by:
// Created: 13.11.97
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
-// ============================================================================
-// headers & declarations
-// ============================================================================
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+#pragma implementation
+#endif
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
+#include "wx/msw/private.h"
#ifdef __BORLANDC__
- #pragma hdrstop
+#pragma hdrstop
#endif
#ifndef WX_PRECOMP
+ #include "wx/window.h"
+ #include "wx/msw/private.h"
+ #include "wx/font.h"
+ #include "wx/bitmap.h"
+ #include "wx/dcmemory.h"
#include "wx/menu.h"
+ #include "wx/utils.h"
#endif
+#include "wx/settings.h"
#include "wx/ownerdrw.h"
#include "wx/menuitem.h"
+#include "wx/fontutil.h"
+#include "wx/module.h"
+
+#if wxUSE_OWNER_DRAWN
+
+#ifndef SPI_GETKEYBOARDCUES
+#define SPI_GETKEYBOARDCUES 0x100A
+#endif
-#include <windows.h>
+class wxMSWSystemMenuFontModule : public wxModule
+{
+public:
+
+ virtual bool OnInit()
+ {
+ ms_systemMenuFont = new wxFont;
+
+#if defined(__WXMSW__) && defined(__WIN32__) && defined(SM_CXMENUCHECK)
+ NONCLIENTMETRICS nm;
+ nm.cbSize = sizeof(NONCLIENTMETRICS);
+ SystemParametersInfo(SPI_GETNONCLIENTMETRICS,0,&nm,0);
+
+ ms_systemMenuButtonWidth = nm.iMenuHeight;
+ ms_systemMenuHeight = nm.iMenuHeight;
+
+ // create menu font
+ wxNativeFontInfo info;
+ memcpy(&info.lf, &nm.lfMenuFont, sizeof(LOGFONT));
+ ms_systemMenuFont->Create(info);
+
+ if (SystemParametersInfo(SPI_GETKEYBOARDCUES, 0, &ms_showCues, 0) == 0)
+ ms_showCues = true;
+#endif
+
+ return true;
+ }
+
+ virtual void OnExit()
+ {
+ delete ms_systemMenuFont;
+ ms_systemMenuFont = NULL;
+ }
+
+ static wxFont* ms_systemMenuFont;
+ static int ms_systemMenuButtonWidth; // windows clean install default
+ static int ms_systemMenuHeight; // windows clean install default
+ static bool ms_showCues;
+private:
+ DECLARE_DYNAMIC_CLASS(wxMSWSystemMenuFontModule)
+};
+
+// these static variables are from the wxMSWSystemMenuFontModule object
+// and reflect the system settings returned by the Win32 API's
+// SystemParametersInfo() call.
+
+wxFont* wxMSWSystemMenuFontModule::ms_systemMenuFont = NULL;
+int wxMSWSystemMenuFontModule::ms_systemMenuButtonWidth = 18; // windows clean install default
+int wxMSWSystemMenuFontModule::ms_systemMenuHeight = 18; // windows clean install default
+bool wxMSWSystemMenuFontModule::ms_showCues = true;
+
+IMPLEMENT_DYNAMIC_CLASS(wxMSWSystemMenuFontModule, wxModule)
+
+
+// temporary hack to implement wxOwnerDrawn::IsMenuItem() without breaking
+// backwards compatibility
+#if wxCHECK_VERSION(2, 7, 0)
+ #pragma warning "TODO: remove gs_menuItems hack"
+#endif
+
+// VC++ 6 gives a warning here:
+//
+// return type for 'OwnerDrawnSet_wxImplementation_HashTable::iterator::
+// operator ->' is 'class wxOwnerDrawn ** ' (ie; not a UDT or reference to
+// a UDT. Will produce errors if applied using infix notation.
+//
+// shut it down
+#ifdef __VISUALC__
+ #if __VISUALC__ <= 1300
+ #pragma warning(push)
+ #pragma warning(disable: 4284)
+ #define POP_WARNINGS
+ #endif
+#endif
+
+#include "wx/hashset.h"
+WX_DECLARE_HASH_SET(wxOwnerDrawn*, wxPointerHash, wxPointerEqual, OwnerDrawnSet);
+
+#ifdef POP_WARNINGS
+ #pragma warning(pop)
+#endif
+
+static OwnerDrawnSet gs_menuItems;
// ============================================================================
// implementation of wxOwnerDrawn class
// ctor
// ----
-wxOwnerDrawn::wxOwnerDrawn(const wxString& str,
- bool bCheckable, bool bMenuItem)
+wxOwnerDrawn::wxOwnerDrawn(const wxString& str,
+ bool bCheckable,
+ bool bMenuItem)
: m_strName(str)
{
- m_bCheckable = bCheckable;
- m_bOwnerDrawn = FALSE;
- m_nHeight = 0;
- m_nMarginWidth = ms_nLastMarginWidth;
+ if (ms_nDefaultMarginWidth == 0)
+ {
+ ms_nDefaultMarginWidth = ::GetSystemMetrics(SM_CXMENUCHECK) +
+ wxSystemSettings::GetMetric(wxSYS_EDGE_X);
+ ms_nLastMarginWidth = ms_nDefaultMarginWidth;
+ }
+
+ m_bCheckable = bCheckable;
+ m_bOwnerDrawn = false;
+ m_nHeight = 0;
+ m_nMarginWidth = ms_nLastMarginWidth;
+ m_nMinHeight = wxMSWSystemMenuFontModule::ms_systemMenuHeight;
+
+ m_bmpDisabled = wxNullBitmap;
+
+ // TODO: we can't add new m_isMenuItem field in 2.6, so we use this hack
+ // with the map, but do add m_isMenuItem in 2.7
+ if ( bMenuItem )
+ {
+ gs_menuItems.insert(this);
+ }
+}
+
+wxOwnerDrawn::~wxOwnerDrawn()
+{
+ // TODO: remove this in 2.7
+ gs_menuItems.erase(this);
}
-#if defined(__WXMSW__) && defined(__WIN32__)
- uint wxOwnerDrawn::ms_nDefaultMarginWidth = GetSystemMetrics(SM_CXMENUCHECK);
-#else // # what is the reasonable default?
- uint wxOwnerDrawn::ms_nDefaultMarginWidth = 15;
-#endif
+bool wxOwnerDrawn::IsMenuItem() const
+{
+ // TODO: in 2.7, replace this with simple "return m_isMenuItem"
+ return gs_menuItems.count(this) == 1;
+}
+
+
+// these items will be set during the first invocation of the c'tor,
+// because the values will be determined by checking the system settings,
+// which is a chunk of code
+size_t wxOwnerDrawn::ms_nDefaultMarginWidth = 0;
+size_t wxOwnerDrawn::ms_nLastMarginWidth = 0;
-uint wxOwnerDrawn::ms_nLastMarginWidth = ms_nDefaultMarginWidth;
// drawing
// -------
+wxFont wxOwnerDrawn::GetFontToUse() const
+{
+ wxFont font = m_font;
+ if ( !font.Ok() )
+ {
+ if ( IsMenuItem() )
+ font = *wxMSWSystemMenuFontModule::ms_systemMenuFont;
+
+ if ( !font.Ok() )
+ font = *wxNORMAL_FONT;
+ }
+
+ return font;
+}
+
// get size of the item
-bool wxOwnerDrawn::OnMeasureItem(uint *pwidth, uint *pheight)
+// The item size includes the menu string, the accel string,
+// the bitmap and size for a submenu expansion arrow...
+bool wxOwnerDrawn::OnMeasureItem(size_t *pwidth, size_t *pheight)
{
- wxMemoryDC dc;
- dc.SetFont(GetFont());
+ if ( IsOwnerDrawn() )
+ {
+ wxMemoryDC dc;
- // ## ugly...
- char *szStripped = new char[m_strName.Len()];
- wxStripMenuCodes((char *)m_strName.c_str(), szStripped);
- wxString str = szStripped;
- delete [] szStripped;
+ wxString str = wxStripMenuCodes(m_strName);
- // # without this menu items look too tightly packed (at least under Windows)
- str += 'W'; // 'W' is typically the widest letter
+ // if we have a valid accel string, then pad out
+ // the menu string so that the menu and accel string are not
+ // placed on top of each other.
+ if ( !m_strAccel.empty() )
+ {
+ str.Pad(str.Length()%8);
+ str += m_strAccel;
+ }
- dc.GetTextExtent(str, (long *)pwidth, (long *)pheight);
- m_nHeight = *pheight; // remember height for use in OnDrawItem
+ dc.SetFont(GetFontToUse());
- return TRUE;
-}
+ dc.GetTextExtent(str, (long *)pwidth, (long *)pheight);
-// searching for this macro you'll find all the code where I'm using the native
-// Win32 GDI functions and not wxWindows ones. Might help to whoever decides to
-// port this code to X. (VZ)
+ // add space at the end of the menu for the submenu expansion arrow
+ // this will also allow offsetting the accel string from the right edge
+ *pwidth += GetMarginWidth() + 16;
+ }
+ else // don't draw the text, just the bitmap (if any)
+ {
+ *pwidth =
+ *pheight = 0;
+ }
-#ifdef __WIN32__
-#define O_DRAW_NATIVE_API // comments below explain why I use it
-#endif
+ // increase size to accommodate bigger bitmaps if necessary
+ if (m_bmpChecked.Ok())
+ {
+ // Is BMP height larger then text height?
+ size_t adjustedHeight = m_bmpChecked.GetHeight() +
+ 2*wxSystemSettings::GetMetric(wxSYS_EDGE_Y);
+ if (*pheight < adjustedHeight)
+ *pheight = adjustedHeight;
+
+ const size_t widthBmp = m_bmpChecked.GetWidth();
+ if ( IsOwnerDrawn() )
+ {
+ // widen the margin to fit the bitmap if necessary
+ if ((size_t)GetMarginWidth() < widthBmp)
+ SetMarginWidth(widthBmp);
+ }
+ else // we must allocate enough space for the bitmap
+ {
+ *pwidth += widthBmp;
+ }
+ }
+
+ // add a 4-pixel separator, otherwise menus look cluttered
+ *pwidth += 4;
+
+ // make sure that this item is at least as tall as the system menu height
+ if ( *pheight < m_nMinHeight )
+ *pheight = m_nMinHeight;
+
+ // remember height for use in OnDrawItem
+ m_nHeight = *pheight;
+
+ return true;
+}
// draw the item
-bool wxOwnerDrawn::OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus st)
+bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
+ const wxRect& rc,
+ wxODAction act,
+ wxODStatus st)
{
// we do nothing on focus change
if ( act == wxODFocusChanged )
- return TRUE;
+ return true;
+
- // wxColor <-> RGB
- #define ToRGB(col) RGB(col.Red(), col.Green(), col.Blue())
- #define UnRGB(col) GetRValue(col), GetGValue(col), GetBValue(col)
+ // this flag determines whether or not an edge will
+ // be drawn around the bitmap. In most "windows classic"
+ // applications, a 1-pixel highlight edge is drawn around
+ // the bitmap of an item when it is selected. However,
+ // with the new "luna" theme, no edge is drawn around
+ // the bitmap because the background is white (this applies
+ // only to "non-XP style" menus w/ bitmaps --
+ // see IE 6 menus for an example)
+
+ bool draw_bitmap_edge = true;
// set the colors
// --------------
DWORD colBack, colText;
if ( st & wxODSelected ) {
colBack = GetSysColor(COLOR_HIGHLIGHT);
- colText = GetSysColor(COLOR_HIGHLIGHTTEXT);
+ if (!(st & wxODDisabled))
+ {
+ colText = GetSysColor(COLOR_HIGHLIGHTTEXT);
+ }
+ else
+ {
+ colText = GetSysColor(COLOR_GRAYTEXT);
+ }
}
else {
// fall back to default colors if none explicitly specified
- colBack = m_colBack.Ok() ? ToRGB(m_colBack) : GetSysColor(COLOR_WINDOW);
- colText = m_colText.Ok() ? ToRGB(m_colText) : GetSysColor(COLOR_WINDOWTEXT);
+ colBack = m_colBack.Ok() ? wxColourToPalRGB(m_colBack)
+ : GetSysColor(COLOR_MENU);
+ colText = m_colText.Ok() ? wxColourToPalRGB(m_colText)
+ : GetSysColor(COLOR_MENUTEXT);
}
-
- #ifdef O_DRAW_NATIVE_API
- #define hdc (HDC)dc.GetHDC()
- COLORREF colOldText = ::SetTextColor(hdc, colText),
- colOldBack = ::SetBkColor(hdc, colBack);
- #else
- dc.SetTextForeground(wxColor(UnRGB(colText)));
- dc.SetTextBackground(wxColor(UnRGB(colBack)));
- #endif
+
+ if ( IsOwnerDrawn() )
+ {
+ // don't draw an edge around the bitmap, if background is white ...
+ DWORD menu_bg_color = GetSysColor(COLOR_MENU);
+ if ( ( GetRValue( menu_bg_color ) >= 0xf0 &&
+ GetGValue( menu_bg_color ) >= 0xf0 &&
+ GetBValue( menu_bg_color ) >= 0xf0 )
+ )
+ {
+ draw_bitmap_edge = false;
+ }
+ }
+ else // edge doesn't look well with default Windows drawing
+ {
+ draw_bitmap_edge = false;
+ }
+
+
+ HDC hdc = GetHdcOf(dc);
+ COLORREF colOldText = ::SetTextColor(hdc, colText),
+ colOldBack = ::SetBkColor(hdc, colBack);
+
+ // *2, as in wxSYS_EDGE_Y
+ int margin = GetMarginWidth() + 2 * wxSystemSettings::GetMetric(wxSYS_EDGE_X);
// select the font and draw the text
// ---------------------------------
- // determine where to draw and leave space for a check-mark.
- int x = rc.x + GetMarginWidth();
- // using native API because it reckognizes '&'
- #ifdef O_DRAW_NATIVE_API
+ // determine where to draw and leave space for a check-mark.
+ // + 1 pixel to separate the edge from the highlight rectangle
+ int xText = rc.x + margin + 1;
+
+
+ // using native API because it recognizes '&'
+ if ( IsOwnerDrawn() )
+ {
int nPrevMode = SetBkMode(hdc, TRANSPARENT);
- HBRUSH hbr = CreateSolidBrush(colBack),
- hPrevBrush = (HBRUSH) SelectObject(hdc, hbr);
+ AutoHBRUSH hbr(colBack);
+ SelectInHDC selBrush(hdc, hbr);
- RECT rectAll = { rc.GetLeft(), rc.GetTop(), rc.GetRight(), rc.GetBottom() };
- FillRect(hdc, &rectAll, hbr);
+ RECT rectFill = { rc.GetLeft(), rc.GetTop(),
+ rc.GetRight() + 1, rc.GetBottom() + 1 };
- // use default font if no font set
- HFONT hfont;
- if ( m_font.Ok() ) {
- m_font.RealizeResource();
- hfont = (HFONT)m_font.GetResourceHandle();
- }
- else {
- hfont = (HFONT)::GetStockObject(SYSTEM_FONT);
+ if ( (st & wxODSelected) && m_bmpChecked.Ok() && draw_bitmap_edge ) {
+ // only draw the highlight under the text, not under
+ // the bitmap or checkmark
+ rectFill.left = xText;
}
- HFONT hPrevFont = (HFONT) ::SelectObject(hdc, hfont);
- DrawState(hdc, NULL, NULL,
- (LPARAM)(const char *)m_strName, m_strName.Length(),
- x, rc.y, rc.GetWidth(), rc.GetHeight(),
- DST_PREFIXTEXT | ( st & wxODDisabled ? DSS_DISABLED : 0) );
+ FillRect(hdc, &rectFill, hbr);
+
+ // use default font if no font set
+ wxFont fontToUse = GetFontToUse();
+ SelectInHDC selFont(hdc, GetHfontOf(fontToUse));
+
+ wxString strMenuText = m_strName.BeforeFirst('\t');
+
+ xText += 3; // separate text from the highlight rectangle
+
+ SIZE sizeRect;
+ ::GetTextExtentPoint32(hdc, strMenuText.c_str(), strMenuText.Length(), &sizeRect);
+ ::DrawState(hdc, NULL, NULL,
+ (LPARAM)strMenuText.c_str(), strMenuText.length(),
+ xText, rc.y + (int) ((rc.GetHeight()-sizeRect.cy)/2.0), // centre text vertically
+ rc.GetWidth()-margin, sizeRect.cy,
+ DST_PREFIXTEXT |
+ (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0) |
+ (((st & wxODHidePrefix) && !wxMSWSystemMenuFontModule::ms_showCues) ? 512 : 0)); // 512 == DSS_HIDEPREFIX
+
+ // ::SetTextAlign(hdc, TA_RIGHT) doesn't work with DSS_DISABLED or DSS_MONO
+ // as the last parameter in DrawState() (at least with Windows98). So we have
+ // to take care of right alignment ourselves.
+ if ( !m_strAccel.empty() )
+ {
+ int accel_width, accel_height;
+ dc.GetTextExtent(m_strAccel, &accel_width, &accel_height);
+ // right align accel string with right edge of menu ( offset by the
+ // margin width )
+ ::DrawState(hdc, NULL, NULL,
+ (LPARAM)m_strAccel.c_str(), m_strAccel.length(),
+ rc.GetWidth()-16-accel_width, rc.y+(int) ((rc.GetHeight()-sizeRect.cy)/2.0),
+ 0, 0,
+ DST_TEXT |
+ (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0));
+ }
- (void)SelectObject(hdc, hPrevBrush);
- (void)SelectObject(hdc, hPrevFont);
(void)SetBkMode(hdc, nPrevMode);
- #else
- dc.SetFont(GetFont());
- dc.DrawText(m_strName, x, rc.y);
- #endif //O_DRAW_NATIVE_API
+ }
+
// draw the bitmap
// ---------------
if ( IsCheckable() && !m_bmpChecked.Ok() ) {
if ( st & wxODChecked ) {
- // using native APIs for performance and simplicity
-#ifdef O_DRAW_NATIVE_API
- // what goes on: DrawFrameControl creates a b/w mask,
+ // what goes on: DrawFrameControl creates a b/w mask,
// then we copy it to screen to have right colors
// first create a monochrome bitmap in a memory DC
HDC hdcMem = CreateCompatibleDC(hdc);
- HBITMAP hbmpCheck = CreateBitmap(GetMarginWidth(), m_nHeight, 1, 1, 0);
+ HBITMAP hbmpCheck = CreateBitmap(margin, m_nHeight, 1, 1, 0);
SelectObject(hdcMem, hbmpCheck);
// then draw a check mark into it
- RECT rect = { 0, 0, GetMarginWidth(), m_nHeight };
- DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
+ RECT rect = { 0, 0, margin, m_nHeight };
+ if ( m_nHeight > 0 )
+ {
+ ::DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK);
+ }
// finally copy it to screen DC and clean up
- BitBlt(hdc, rc.x, rc.y, GetMarginWidth(), m_nHeight,
+ BitBlt(hdc, rc.x, rc.y, margin, m_nHeight,
hdcMem, 0, 0, SRCCOPY);
+
DeleteDC(hdcMem);
-#else
- // #### to do: perhaps using Marlett font (create equiv. font under X)
-// wxFAIL("not implemented");
-#endif //O_DRAW_NATIVE_API
+ DeleteObject(hbmpCheck);
}
}
else {
- // for uncheckable item we use only the 'checked' bitmap
- wxBitmap bmp(GetBitmap(IsCheckable() ? ((st & wxODChecked) != 0) : TRUE));
+ wxBitmap bmp;
+
+ if ( st & wxODDisabled )
+ {
+ bmp = GetDisabledBitmap();
+ }
+
+ if ( !bmp.Ok() )
+ {
+ // for not checkable bitmaps we should always use unchecked one because
+ // their checked bitmap is not set
+ bmp = GetBitmap(!IsCheckable() || (st & wxODChecked));
+ }
+
if ( bmp.Ok() ) {
wxMemoryDC dcMem(&dc);
dcMem.SelectObject(bmp);
int nBmpWidth = bmp.GetWidth(),
nBmpHeight = bmp.GetHeight();
- // there should be enough place!
+ // there should be enough space!
wxASSERT((nBmpWidth <= rc.GetWidth()) && (nBmpHeight <= rc.GetHeight()));
- dc.Blit(rc.x + (GetMarginWidth() - nBmpWidth) / 2,
- rc.y + (m_nHeight - nBmpHeight) /2,
- nBmpWidth, nBmpHeight,
- &dcMem, 0, 0, wxCOPY);
+ int heightDiff = m_nHeight - nBmpHeight;
+ dc.Blit(rc.x + (margin - nBmpWidth) / 2,
+ rc.y + heightDiff / 2,
+ nBmpWidth, nBmpHeight,
+ &dcMem, 0, 0, wxCOPY, true /* use mask */);
- if ( st & wxODSelected ) {
- #ifdef O_DRAW_NATIVE_API
- RECT rectBmp = { rc.GetLeft(), rc.GetTop(),
- rc.GetLeft() + GetMarginWidth(),
+ if ( ( st & wxODSelected ) && !( st & wxODDisabled ) && draw_bitmap_edge ) {
+ RECT rectBmp = { rc.GetLeft(), rc.GetTop(),
+ rc.GetLeft() + margin,
rc.GetTop() + m_nHeight };
SetBkColor(hdc, colBack);
- DrawEdge(hdc, &rectBmp, EDGE_RAISED, BF_SOFT | BF_RECT);
- #else
- // ## to write portable DrawEdge
- #endif //O_DRAW_NATIVE_API
+
+ DrawEdge(hdc, &rectBmp, BDR_RAISEDINNER, BF_RECT);
}
}
}
- #ifdef O_DRAW_NATIVE_API
- ::SetTextColor(hdc, colOldText);
- ::SetBkColor(hdc, colOldBack);
-
- #undef hdc
- #endif //O_DRAW_NATIVE_API
+ ::SetTextColor(hdc, colOldText);
+ ::SetBkColor(hdc, colOldBack);
- return TRUE;
+ return true;
}
+
+#endif // wxUSE_OWNER_DRAWN
+
projects / wxWidgets.git / blobdiff