Several corrections to wxDocManager fields documentation.

[wxWidgets.git] / src / msw / ownerdrw.cpp

diff --git a/src/msw/ownerdrw.cpp b/src/msw/ownerdrw.cpp
index 03519026bc4a4510c426a7461488ccee26be922e..6fb88beabbb392e6ec4f173169226bf8328c192e 100644 (file)
--- a/src/msw/ownerdrw.cpp
+++ b/src/msw/ownerdrw.cpp
@@ -1,369 +1,150 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        msw/ownerdrw.cpp
+// Name:        src/msw/ownerdrw.cpp

 // Purpose:     implementation of wxOwnerDrawn class
 // Author:      Vadim Zeitlin
 // Purpose:     implementation of wxOwnerDrawn class
 // Author:      Vadim Zeitlin

-// Modified by:
+// Modified by: Marcin Malich

 // Created:     13.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     13.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 ///////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"

-#include "wx/msw/private.h"

 
 #ifdef __BORLANDC__
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #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
+#if wxUSE_OWNER_DRAWN

 
 

-#include "wx/settings.h"

 #include "wx/ownerdrw.h"
 #include "wx/ownerdrw.h"

-#include "wx/menuitem.h"
-#include "wx/fontutil.h"
+#include "wx/msw/dc.h"
+#include "wx/msw/private.h"
+#include "wx/msw/private/dc.h"
+#include "wx/msw/wrapcctl.h"            // for HIMAGELIST

 
 

-#if wxUSE_OWNER_DRAWN
+#ifndef DSS_HIDEPREFIX
+#define DSS_HIDEPREFIX  0x0200
+#endif

 
 

+// ----------------------------------------------------------------------------
+// constants for base class
+// ----------------------------------------------------------------------------
+
+int wxOwnerDrawnBase::ms_defaultMargin = 3;

 
 // ============================================================================
 // implementation of wxOwnerDrawn class
 // ============================================================================
 
 
 // ============================================================================
 // implementation of wxOwnerDrawn class
 // ============================================================================
 

-// ctor
-// ----
-wxOwnerDrawn::wxOwnerDrawn(const wxString& str,
-                           bool bCheckable, bool WXUNUSED(bMenuItem))
-            : m_strName(str)
+// draw the item
+bool wxOwnerDrawn::OnDrawItem(wxDC& dc, const wxRect& rc,
+                              wxODAction, wxODStatus stat)

 {
 {

-#if defined(__WXMSW__) && defined(__WIN32__) && defined(SM_CXMENUCHECK)
-    // get the default menu height and font from the system
-    NONCLIENTMETRICS nm;
-    nm.cbSize = sizeof (NONCLIENTMETRICS);
-    SystemParametersInfo (SPI_GETNONCLIENTMETRICS,0,&nm,0); 
-    m_nMinHeight = nm.iMenuHeight;
-    
-    // nm.iMenuWidth is the system default for the width of
-    // menu icons and checkmarks
-    if (ms_nDefaultMarginWidth == 0)
-    {
-       ms_nDefaultMarginWidth = nm.iMenuWidth;
-       ms_nLastMarginWidth = nm.iMenuWidth;
-    }
+    // we do nothing if item isn't ownerdrawn
+    if ( !IsOwnerDrawn() )
+        return true;
+
+    wxMSWDCImpl *impl = (wxMSWDCImpl*) dc.GetImpl();
+    HDC hdc = GetHdcOf(*impl);
+
+    RECT rect;
+    wxCopyRectToRECT(rc, rect);

 
 

-    wxNativeFontInfo info;
-    memcpy(&info.lf, &nm.lfMenuFont, sizeof(LOGFONT));
-    m_font.Create(info);
-#else
-    // windows clean install default
-    m_nMinHeight = 18;
-    
-    if (ms_nDefaultMarginWidth == 0)

     {
     {

-        ms_nDefaultMarginWidth = 18;
-        ms_nLastMarginWidth = 18;
-    }
-    if (wxNORMAL_FONT)
-       m_font = *wxNORMAL_FONT;
-#endif
+        // set the font and colors
+        wxFont font;
+        GetFontToUse(font);

 
 

-    m_bCheckable   = bCheckable;
-    m_bOwnerDrawn  = FALSE;
-    m_nHeight      = 0;
-    m_nMarginWidth = ms_nLastMarginWidth;
-}
+        wxColour colText, colBack;
+        GetColourToUse(stat, colText, colBack);

 
 

+        SelectInHDC selFont(hdc, GetHfontOf(font));

 
 

-// 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;
+        wxMSWImpl::wxTextColoursChanger textCol(hdc, colText, colBack);
+        wxMSWImpl::wxBkModeChanger bkMode(hdc, wxBRUSHSTYLE_TRANSPARENT);

 
 
 
 

-// drawing
-// -------
+        AutoHBRUSH hbr(wxColourToPalRGB(colBack));
+        SelectInHDC selBrush(hdc, hbr);

 
 

-// get size of the item
-bool wxOwnerDrawn::OnMeasureItem(size_t *pwidth, size_t *pheight)
-{
-  wxMemoryDC dc;
-
-  wxString str = wxStripMenuCodes(m_strName);
-
-  // # without this menu items look too tightly packed (at least under Windows)
-  str += wxT('W'); // 'W' is typically the widest letter
-
-  if (m_font.Ok())
-      dc.SetFont(GetFont());
-
-  dc.GetTextExtent(str, (long *)pwidth, (long *)pheight);
-
-  if (!m_strAccel.IsEmpty())
-  {
-      // measure the accelerator string, and add it's width to
-      // the total item width, plus 16 (Accelerators are right justified,
-      // with the right edge of the text rectangle 16 pixels left of
-      // the right edge of the menu)
-
-      int accel_width, accel_height;
-      dc.GetTextExtent(m_strAccel, &accel_width, &accel_height);
-      *pwidth += (accel_width + 16);
-  }
-
-  // JACS: items still look too tightly packed, so adding 5 pixels.
-  (*pheight) = (*pheight) + 5;
-
-  // 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);
-  }
-
-  // make sure that this item is at least as
-  // tall as the user's system settings specify
-  if (*pheight < m_nMinHeight)
-    *pheight = m_nMinHeight;
-
-  m_nHeight = *pheight;                // remember height for use in OnDrawItem
-
-  return TRUE;
-}
+        ::FillRect(hdc, &rect, hbr);

 
 

-// 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)
+        // using native API because it recognizes '&'

 
 

-// 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?
+        wxString text = GetName();

 
 

-#if defined(__WIN32__) && !defined(__SC__) && !defined(__TWIN32__)
-#define   O_DRAW_NATIVE_API     // comments below explain why I use it
-#endif
+        SIZE sizeRect;
+        ::GetTextExtentPoint32(hdc, text.c_str(), text.length(), &sizeRect);

 
 

-// draw the item
-bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
-                              const wxRect& rc,
-                              wxODAction act,
-                              wxODStatus st)
-{
-  // we do nothing on focus change
-  if ( act == wxODFocusChanged )
-    return TRUE;
-
-  // wxColor <-> RGB
-  #define   ToRGB(col)  PALETTERGB(col.Red(), col.Green(), col.Blue())
-  #define   UnRGB(col)  GetRValue(col), GetGValue(col), GetBValue(col)
-
-  // set the colors
-  // --------------
-  DWORD colBack, colText;
-  if ( st & wxODSelected ) {
-    colBack = GetSysColor(COLOR_HIGHLIGHT);
-    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);
-  }
-
-  #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
-
-  // select the font and draw the text
-  // ---------------------------------
-
-
-  // determine where to draw and leave space for a check-mark.
-  // Add 3 pixel padding so text appears well within highlight rectangle
-  int x = rc.x + GetMarginWidth() + 3;
-
-
-  // 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 rectFill = { rc.GetLeft(), rc.GetTop(), rc.GetRight()+1, rc.GetBottom() };
-
-    if ( st & wxODSelected && m_bmpChecked.Ok()) {
-        // only draw the highlight under the text, not under
-        // the bitmap or checkmark; leave a 1-pixel gap.
-        rectFill.left = GetMarginWidth() + 1;
-    }
+        int flags = DST_PREFIXTEXT;
+        if ( (stat & wxODDisabled) && !(stat & wxODSelected) )
+            flags |= DSS_DISABLED;

 
 

-    FillRect(hdc, &rectFill, hbr);
+        if ( (stat & wxODHidePrefix) )
+            flags |= DSS_HIDEPREFIX;

 
 

-    // 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);
-    }
+        int x = rc.x + GetMarginWidth();
+        int y = rc.y + (rc.GetHeight() - sizeRect.cy) / 2;
+        int cx = rc.GetWidth() - GetMarginWidth();
+        int cy = sizeRect.cy;

 
 

-    HFONT hPrevFont = (HFONT) ::SelectObject(hdc, hfont);
+        ::DrawState(hdc, NULL, NULL, (LPARAM)text.wx_str(),
+                    text.length(), x, y, cx, cy, flags);

 
 

-    wxString strMenuText = m_strName.BeforeFirst('\t');
+    } // reset to default the font, colors and brush

 
 

-    ::DrawState(hdc, NULL, NULL,
-                (LPARAM)strMenuText.c_str(), strMenuText.length(),
-                x, rc.y + 1, rc.GetWidth(), rc.GetHeight(),
-                DST_PREFIXTEXT |
-                (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0));
+    if (stat & wxODHasFocus)
+        ::DrawFocusRect(hdc, &rect);

 
 

-    if ( !m_strAccel.empty() )
-    {
-        int accel_width, accel_height;
-        dc.GetTextExtent(m_strAccel, &accel_width, &accel_height);
-
-        ::DrawState(hdc, NULL, NULL,
-                    (LPARAM)m_strAccel.c_str(), m_strAccel.length(),
-                    rc.GetRight() - accel_width - 16, rc.y + 1, 0, 0,
-                    DST_TEXT |
-                    (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0));
-    }
+    return true;
+}

 
 

-    (void)SelectObject(hdc, hPrevBrush);
-    (void)SelectObject(hdc, hPrevFont);
-    (void)SetBkMode(hdc, nPrevMode);
-
-    DeleteObject(hbr);
-  #else
-    dc.SetFont(GetFont());
-    dc.DrawText(wxStripMenuCodes(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);
-      SelectObject(hdcMem, hbmpCheck);
-
-        // then draw a check mark into it
-      RECT rect = { 0, 0, GetMarginWidth(), 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,
-             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));
-    if ( bmp.Ok() ) {
-      wxMemoryDC dcMem(&dc);
-      dcMem.SelectObject(bmp);
-
-      // center bitmap
-      int nBmpWidth = bmp.GetWidth(),
-          nBmpHeight = bmp.GetHeight();
-
-      // there should be enough place!
-      wxASSERT((nBmpWidth <= rc.GetWidth()) && (nBmpHeight <= rc.GetHeight()));
-
-      int heightDiff = m_nHeight - nBmpHeight;
-      dc.Blit(rc.x + (GetMarginWidth() - nBmpWidth) / 2,
-              rc.y + heightDiff / 2,
-              nBmpWidth, nBmpHeight,
-              &dcMem, 0, 0, wxCOPY, TRUE /* use mask */);
-
-      if ( st & wxODSelected ) {
-
-          int x1, y1, x2, y2;
-          x1 = rc.x;
-          y1 = rc.y;
-          x2 = x1 + GetMarginWidth() - 1;
-          y2 = y1 + m_nHeight - 1;
-
-          dc.SetPen(*wxWHITE_PEN);
-          dc.DrawLine(x1, y1, x2, y1);
-          dc.DrawLine(x1, y1, x1, y2);
-          dc.SetPen(*wxGREY_PEN);
-          dc.DrawLine(x1, y2-1, x2, y2-1);
-          dc.DrawLine(x2, y1, x2, y2);
-      }
-    }
-  }
+// ----------------------------------------------------------------------------
+// global helper functions implemented here
+// ----------------------------------------------------------------------------
+
+BOOL wxDrawStateBitmap(HDC hDC, HBITMAP hBitmap, int x, int y, UINT uState)
+{
+    // determine size of bitmap image
+    BITMAP bmp;
+    if ( !::GetObject(hBitmap, sizeof(BITMAP), &bmp) )
+        return FALSE;

 
 

-  #ifdef  O_DRAW_NATIVE_API
-    ::SetTextColor(hdc, colOldText);
-    ::SetBkColor(hdc, colOldBack);
+    BOOL result;

 
 

-    #undef  hdc
-  #endif  //O_DRAW_NATIVE_API
+    switch ( uState )
+    {
+        case wxDSB_NORMAL:
+        case wxDSB_SELECTED:
+            {
+                // uses image list functions to draw
+                //  - normal bitmap with support transparency
+                //    (image list internally create mask etc.)
+                //  - blend bitmap with the background colour
+                //    (like default selected items)
+                HIMAGELIST hIml = ::ImageList_Create(bmp.bmWidth, bmp.bmHeight,
+                                                     ILC_COLOR32 | ILC_MASK, 1, 1);
+                ::ImageList_Add(hIml, hBitmap, NULL);
+                UINT fStyle = uState == wxDSB_SELECTED ? ILD_SELECTED : ILD_NORMAL;
+                result = ::ImageList_Draw(hIml, 0, hDC, x, y, fStyle);
+                ::ImageList_Destroy(hIml);
+            }
+            break;
+
+        case wxDSB_DISABLED:
+            result = ::DrawState(hDC, NULL, NULL, (LPARAM)hBitmap, 0, x, y,
+                                 bmp.bmWidth, bmp.bmHeight,
+                                 DST_BITMAP | DSS_DISABLED);
+            break;
+
+        default:
+            wxFAIL_MSG( wxT("DrawStateBitmap: unknown wxDSBStates value") );
+            result = FALSE;
+    }

 
 

-  return TRUE;
+    return result;

 }
 
 }
 

-

 #endif // wxUSE_OWNER_DRAWN
 #endif // wxUSE_OWNER_DRAWN

-