X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dbc38199c0d74ba6cddeced769765a2e445e380d..b9efe021b554fa3967d1442cf758435c5cd5ae8f:/src/msw/ownerdrw.cpp diff --git a/src/msw/ownerdrw.cpp b/src/msw/ownerdrw.cpp index 37ea1f8b81..6fa6d77340 100644 --- a/src/msw/ownerdrw.cpp +++ b/src/msw/ownerdrw.cpp @@ -6,10 +6,10 @@ // Created: 13.11.97 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma implementation #endif @@ -23,7 +23,7 @@ #ifndef WX_PRECOMP #include "wx/window.h" -// #include "wx/msw/private.h" + #include "wx/msw/private.h" #include "wx/font.h" #include "wx/bitmap.h" #include "wx/dcmemory.h" @@ -34,9 +34,98 @@ #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 + +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 @@ -45,86 +134,139 @@ // ctor // ---- wxOwnerDrawn::wxOwnerDrawn(const wxString& str, - bool bCheckable, bool WXUNUSED(bMenuItem)) + bool bCheckable, + bool bMenuItem) : m_strName(str) { - m_bCheckable = bCheckable; - m_bOwnerDrawn = FALSE; - m_nHeight = 0; - m_nMarginWidth = ms_nLastMarginWidth; - if (wxNORMAL_FONT) - m_font = * wxNORMAL_FONT; + 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); +} + +bool wxOwnerDrawn::IsMenuItem() const +{ + // TODO: in 2.7, replace this with simple "return m_isMenuItem" + return gs_menuItems.count(this) == 1; } -#if defined(__WXMSW__) && defined(__WIN32__) && defined(SM_CXMENUCHECK) - size_t wxOwnerDrawn::ms_nDefaultMarginWidth = GetSystemMetrics(SM_CXMENUCHECK); -#else // # what is the reasonable default? - size_t wxOwnerDrawn::ms_nDefaultMarginWidth = 15; -#endif -size_t wxOwnerDrawn::ms_nLastMarginWidth = ms_nDefaultMarginWidth; +// 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; + // 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 +// 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; - - wxString str = wxStripMenuCodes(m_strName); + if ( IsOwnerDrawn() ) + { + wxMemoryDC dc; - // # without this menu items look too tightly packed (at least under Windows) - str += wxT('W'); // 'W' is typically the widest letter + wxString str = wxStripMenuCodes(m_strName); - if (m_font.Ok()) - dc.SetFont(GetFont()); + // 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); + dc.SetFont(GetFontToUse()); - // JACS: items still look too tightly packed, so adding 2 pixels. - (*pheight) = (*pheight) + 2; + dc.GetTextExtent(str, (long *)pwidth, (long *)pheight); - // Ray Gilbert's changes - Corrects the problem of a BMP - // being placed next to text in a menu item, and the BMP does - // not match the size expected by the system. This will - // resize the space so the BMP will fit. Without this, BMPs - // must be no larger or smaller than 16x16. - if (m_bmpChecked.Ok()) - { - // Is BMP height larger then text height? - size_t adjustedHeight = m_bmpChecked.GetHeight() + - wxSystemSettings::GetMetric(wxSYS_EDGE_Y); - if (*pheight < adjustedHeight) - *pheight = adjustedHeight; - - // Does BMP encroach on default check menu position? - size_t adjustedWidth = m_bmpChecked.GetWidth() + - (wxSystemSettings::GetMetric(wxSYS_EDGE_X) * 2); - if (ms_nDefaultMarginWidth < adjustedWidth) - *pwidth += adjustedWidth - ms_nDefaultMarginWidth; - - // Do we need to widen margin to fit BMP? - if ((size_t)GetMarginWidth() < adjustedWidth) - SetMarginWidth(adjustedWidth); - } + // 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; + } - m_nHeight = *pheight; // remember height for use in OnDrawItem + // 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; + } + } - return TRUE; -} + // add a 4-pixel separator, otherwise menus look cluttered + *pwidth += 4; -// 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) + // make sure that this item is at least as tall as the system menu height + if ( *pheight < m_nMinHeight ) + *pheight = m_nMinHeight; -// JACS: TODO. Why does a disabled but highlighted item still -// get drawn embossed? How can we tell DrawState that we don't want the -// embossing? + // remember height for use in OnDrawItem + m_nHeight = *pheight; -#if defined(__WIN32__) && !defined(__SC__) && !defined(__TWIN32__) -#define O_DRAW_NATIVE_API // comments below explain why I use it -#endif + return true; +} // draw the item bool wxOwnerDrawn::OnDrawItem(wxDC& dc, @@ -134,143 +276,175 @@ bool wxOwnerDrawn::OnDrawItem(wxDC& dc, { // we do nothing on focus change if ( act == wxODFocusChanged ) - return TRUE; + return true; + + + // 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) - // wxColor <-> RGB - #define ToRGB(col) PALETTERGB(col.Red(), col.Green(), col.Blue()) - #define UnRGB(col) GetRValue(col), GetGValue(col), GetBValue(col) + 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); + } + + 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); - #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 + // *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(); + // + 1 pixel to separate the edge from the highlight rectangle + int xText = rc.x + margin + 1; - // using native API because it reckognizes '&' - #ifdef O_DRAW_NATIVE_API - int nPrevMode = SetBkMode(hdc, TRANSPARENT); - HBRUSH hbr = CreateSolidBrush(colBack), - hPrevBrush = (HBRUSH)SelectObject(hdc, hbr); - RECT rectAll = { rc.GetLeft(), rc.GetTop(), rc.GetRight(), rc.GetBottom() }; - FillRect(hdc, &rectAll, hbr); + // using native API because it recognizes '&' + if ( IsOwnerDrawn() ) + { + int nPrevMode = SetBkMode(hdc, TRANSPARENT); + AutoHBRUSH hbr(colBack); + SelectInHDC selBrush(hdc, hbr); - DeleteObject(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); - - -#if wxUSE_UNICODE_MSLU - if ( wxGetOsVersion() == wxWIN95 /* using unicows.dll */ ) - { - // VS: There's yet another bug in MSLU: DrawStateW behaves - // like if it was expecting char*, not wchar_t* input. - // We have to use DrawStateA explicitly. - DrawStateA(hdc, NULL, NULL, - (LPARAM)(const char*)m_strName.mb_str(wxConvLocal), - m_strName.length(), - x, rc.y, rc.GetWidth(), rc.GetHeight(), - DST_PREFIXTEXT | - (st & wxODDisabled ? DSS_DISABLED : 0)); - } - else -#else - DrawState(hdc, NULL, NULL, - (LPARAM)m_strName.c_str(), m_strName.length(), - x, rc.y, rc.GetWidth(), rc.GetHeight(), - DST_PREFIXTEXT | (st & wxODDisabled ? DSS_DISABLED : 0)); -#endif + FillRect(hdc, &rectFill, hbr); - if ( !m_strAccel.empty() ) + // 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() ) { - RECT r; - r.top = rc.GetTop(); - r.left = rc.GetLeft(); - r.right = rc.GetRight() - GetMarginWidth(); - r.bottom = rc.GetBottom(); - - DrawText(hdc, m_strAccel, m_strAccel.length(), &r, - DT_SINGLELINE | DT_RIGHT | DT_VCENTER); + 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, // 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 }; + RECT rect = { 0, 0, margin, m_nHeight }; if ( m_nHeight > 0 ) { -#ifndef __SC__ - DrawFrameControl(hdcMem, &rect, DFC_MENU, DFCS_MENUCHECK); -#endif + ::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); DeleteObject(hbmpCheck); -#else - // #### to do: perhaps using Marlett font (create equiv. font under X) -// wxFAIL("not implemented"); -#endif //O_DRAW_NATIVE_API } } 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); @@ -279,41 +453,30 @@ bool wxOwnerDrawn::OnDrawItem(wxDC& dc, int nBmpWidth = bmp.GetWidth(), nBmpHeight = bmp.GetHeight(); - // there should be enough place! + // there should be enough space! wxASSERT((nBmpWidth <= rc.GetWidth()) && (nBmpHeight <= rc.GetHeight())); - int heightDiff = (m_nHeight - nBmpHeight); -// if (heightDiff = -1) -// heightDiff = -2; - - //MT: blit with mask enabled. - dc.Blit(rc.x + (GetMarginWidth() - nBmpWidth) / 2, + int heightDiff = m_nHeight - nBmpHeight; + dc.Blit(rc.x + (margin - nBmpWidth) / 2, rc.y + heightDiff / 2, nBmpWidth, nBmpHeight, - &dcMem, 0, 0, wxCOPY, TRUE); + &dcMem, 0, 0, wxCOPY, true /* use mask */); - if ( st & wxODSelected ) { - #ifdef O_DRAW_NATIVE_API + if ( ( st & wxODSelected ) && !( st & wxODDisabled ) && draw_bitmap_edge ) { RECT rectBmp = { rc.GetLeft(), rc.GetTop(), - rc.GetLeft() + GetMarginWidth(), + 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; }