Some improvements to accessibility behaviour

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

diff --git a/src/msw/ownerdrw.cpp b/src/msw/ownerdrw.cpp
index 364d175a89368eac751ee757a602345e760e4c8f..cc87619eef0aa8cebc0f430528c26b1677288b0f 100644 (file)
--- a/src/msw/ownerdrw.cpp
+++ b/src/msw/ownerdrw.cpp
@@ -23,7 +23,7 @@
 
 #ifndef WX_PRECOMP
   #include "wx/window.h"
 
 #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"
   #include "wx/font.h"
   #include "wx/bitmap.h"
   #include "wx/dcmemory.h"


@@ -34,6 +34,7 @@
 #include "wx/settings.h"
 #include "wx/ownerdrw.h"
 #include "wx/menuitem.h"
 #include "wx/settings.h"
 #include "wx/ownerdrw.h"
 #include "wx/menuitem.h"

+#include "wx/fontutil.h"

 
 #if wxUSE_OWNER_DRAWN
 
 
 #if wxUSE_OWNER_DRAWN
 


@@ -48,42 +49,95 @@ wxOwnerDrawn::wxOwnerDrawn(const wxString& str,
                            bool bCheckable, bool WXUNUSED(bMenuItem))
             : m_strName(str)
 {
                            bool bCheckable, bool WXUNUSED(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 defined(__WXMSW__) && defined(__WIN32__) && defined(SM_CXMENUCHECK)
 #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;
+    // 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;
+    }
+
+    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
 
 #endif
 

-size_t wxOwnerDrawn::ms_nLastMarginWidth = ms_nDefaultMarginWidth;
+    m_bCheckable   = bCheckable;
+    m_bOwnerDrawn  = FALSE;
+    m_nHeight      = 0;
+    m_nMarginWidth = ms_nLastMarginWidth;
+}
+
+
+// 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
 // -------
 
 // get size of the item
 
 // drawing
 // -------
 
 // 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);
 
 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 we have a valid accel string, then pad out
+  // the menu string so the menu and accel string are not
+  // placed ontop of eachother.
+  if ( !m_strAccel.empty() )
+   {
+       str.Pad(str.Length()%8);
+       str += m_strAccel;
+   }

 
   if (m_font.Ok())
       dc.SetFont(GetFont());
 
   dc.GetTextExtent(str, (long *)pwidth, (long *)pheight);
 
 
   if (m_font.Ok())
       dc.SetFont(GetFont());
 
   dc.GetTextExtent(str, (long *)pwidth, (long *)pheight);
 

-  // JACS: items still look too tightly packed, so adding 2 pixels.
-  (*pheight) = (*pheight) + 2;
+  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;
+  }
+
+  // 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 += (size_t) (GetDefaultMarginWidth() * 1.5);
+
+  // 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
 
   // Ray Gilbert's changes - Corrects the problem of a BMP
   // being placed next to text in a menu item, and the BMP does


@@ -101,14 +155,26 @@ bool wxOwnerDrawn::OnMeasureItem(size_t *pwidth, size_t *pheight)
       // Does BMP encroach on default check menu position?
       size_t adjustedWidth = m_bmpChecked.GetWidth() +
                              (wxSystemSettings::GetMetric(wxSYS_EDGE_X) * 2);
       // 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;
+//      if (ms_nDefaultMarginWidth < adjustedWidth)
+//          *pwidth += adjustedWidth - ms_nDefaultMarginWidth;

 
       // Do we need to widen margin to fit BMP?
 
       // Do we need to widen margin to fit BMP?

-      if ((size_t)GetMarginWidth() < adjustedWidth)
+      if ((size_t)GetMarginWidth() != adjustedWidth)

           SetMarginWidth(adjustedWidth);
           SetMarginWidth(adjustedWidth);

+        
+      // add the size of the bitmap to our total size...
+      *pwidth += GetMarginWidth(); 

   }
 
   }
 

+  // add the size of the bitmap to our total size - even if we don't have
+  // a bitmap we leave room for one...
+  *pwidth += GetMarginWidth();
+  
+  // 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;
   m_nHeight = *pheight;                // remember height for use in OnDrawItem
 
   return TRUE;


@@ -145,7 +211,14 @@ bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
   DWORD colBack, colText;
   if ( st & wxODSelected ) {
     colBack = GetSysColor(COLOR_HIGHLIGHT);
   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
   }
   else {
     // fall back to default colors if none explicitly specified


@@ -165,8 +238,11 @@ bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
   // select the font and draw the text
   // ---------------------------------
 
   // select the font and draw the text
   // ---------------------------------
 

+

   // determine where to draw and leave space for a check-mark.
   // determine where to draw and leave space for a check-mark.

-  int x = rc.x + GetMarginWidth();
+  // 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
 
   // using native API because it reckognizes '&'
   #ifdef  O_DRAW_NATIVE_API


@@ -174,10 +250,15 @@ bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
     HBRUSH hbr = CreateSolidBrush(colBack),
            hPrevBrush = (HBRUSH)SelectObject(hdc, hbr);
 
     HBRUSH hbr = CreateSolidBrush(colBack),
            hPrevBrush = (HBRUSH)SelectObject(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() };

 
 

-    DeleteObject(hbr);
+    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;
+    }
+
+    FillRect(hdc, &rectFill, hbr);

 
     // use default font if no font set
     HFONT hfont;
 
     // use default font if no font set
     HFONT hfont;


@@ -190,29 +271,39 @@ bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
     }
 
     HFONT hPrevFont = (HFONT) ::SelectObject(hdc, hfont);
     }
 
     HFONT hPrevFont = (HFONT) ::SelectObject(hdc, hfont);

-    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));
+
+    wxString strMenuText = m_strName.BeforeFirst('\t');
+
+    SIZE sizeRect;
+    GetTextExtentPoint32(hdc,strMenuText.c_str(), strMenuText.Length(),&sizeRect);
+    ::DrawState(hdc, NULL, NULL,
+                (LPARAM)strMenuText.c_str(), strMenuText.length(),
+                x, rc.y+( (int) ((rc.GetHeight()-sizeRect.cy)/2.0) )-1, // centre text vertically
+                rc.GetWidth()-GetMarginWidth(), sizeRect.cy,
+                DST_PREFIXTEXT |
+                (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0));

 
     if ( !m_strAccel.empty() )
     {
 
     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);
+        // right align accel string with right edge of menu ( offset by the margin width )
+        ::SetTextAlign(hdc, TA_RIGHT);
+        ::DrawState(hdc, NULL, NULL,
+                    (LPARAM)m_strAccel.c_str(), m_strAccel.length(),
+                    rc.GetWidth()-(GetMarginWidth()), rc.y+(int) ((rc.GetHeight()-sizeRect.cy)/2.0),
+                    rc.GetWidth()-GetMarginWidth(), sizeRect.cy,
+                    DST_TEXT |
+                    (((st & wxODDisabled) && !(st & wxODSelected)) ? DSS_DISABLED : 0));
+        ::SetTextAlign(hdc, TA_LEFT);

     }
 
     (void)SelectObject(hdc, hPrevBrush);
     (void)SelectObject(hdc, hPrevFont);
     (void)SetBkMode(hdc, nPrevMode);
     }
 
     (void)SelectObject(hdc, hPrevBrush);
     (void)SelectObject(hdc, hPrevFont);
     (void)SetBkMode(hdc, nPrevMode);

+
+    DeleteObject(hbr);

   #else
     dc.SetFont(GetFont());
   #else
     dc.SetFont(GetFont());

-    dc.DrawText(m_strName, x, rc.y);
+    dc.DrawText(wxStripMenuCodes(m_strName), x, rc.y);

   #endif  //O_DRAW_NATIVE_API
 
   // draw the bitmap
   #endif  //O_DRAW_NATIVE_API
 
   // draw the bitmap


@@ -233,9 +324,7 @@ bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
       RECT rect = { 0, 0, GetMarginWidth(), m_nHeight };
       if ( m_nHeight > 0 )
       {
       RECT rect = { 0, 0, GetMarginWidth(), 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
       }
 
         // finally copy it to screen DC and clean up


@@ -264,25 +353,32 @@ bool wxOwnerDrawn::OnDrawItem(wxDC& dc,
       // there should be enough place!
       wxASSERT((nBmpWidth <= rc.GetWidth()) && (nBmpHeight <= rc.GetHeight()));
 
       // there should be enough place!
       wxASSERT((nBmpWidth <= rc.GetWidth()) && (nBmpHeight <= rc.GetHeight()));
 

-      int heightDiff = (m_nHeight - nBmpHeight);
-//      if (heightDiff = -1)
-//        heightDiff = -2;
-
-      //MT: blit with mask enabled.
+      int heightDiff = m_nHeight - nBmpHeight;

       dc.Blit(rc.x + (GetMarginWidth() - nBmpWidth) / 2,
               rc.y + heightDiff / 2,
               nBmpWidth, nBmpHeight,
       dc.Blit(rc.x + (GetMarginWidth() - 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
           RECT rectBmp = { rc.GetLeft(), rc.GetTop(),
                            rc.GetLeft() + GetMarginWidth(),
 
       if ( st & wxODSelected ) {
         #ifdef  O_DRAW_NATIVE_API
           RECT rectBmp = { rc.GetLeft(), rc.GetTop(),
                            rc.GetLeft() + GetMarginWidth(),

-                           rc.GetTop() + m_nHeight };
+                           rc.GetTop() + m_nHeight-1 };

           SetBkColor(hdc, colBack);
           DrawEdge(hdc, &rectBmp, EDGE_RAISED, BF_SOFT | BF_RECT);
         #else
           SetBkColor(hdc, colBack);
           DrawEdge(hdc, &rectBmp, EDGE_RAISED, BF_SOFT | BF_RECT);
         #else

-          // ## to write portable DrawEdge
+          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);

         #endif  //O_DRAW_NATIVE_API
       }
     }
         #endif  //O_DRAW_NATIVE_API
       }
     }