wxRichTextCtrl native caret now flashes, for wxMac/Core Graphics mode

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

diff --git a/src/os2/ownerdrw.cpp b/src/os2/ownerdrw.cpp
index 1be1044bda76b84a761b74ada2317593efe9abd3..8f7d425b094be7972847ae7dd94ab654a4205d04 100644 (file)
--- a/src/os2/ownerdrw.cpp
+++ b/src/os2/ownerdrw.cpp
@@ -1,197 +1,496 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     implementation of wxOwnerDrawn class
 // Author:      David Webster
 // Modified by:
 // Created:     10/12/99
 // RCS-ID:      $Id$
 // Copyright:   (c) David Webster
 // Purpose:     implementation of wxOwnerDrawn class
 // Author:      David Webster
 // Modified by:
 // Created:     10/12/99
 // RCS-ID:      $Id$
 // Copyright:   (c) David Webster

-// 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"
 

+#if wxUSE_OWNER_DRAWN
+

 #ifndef WX_PRECOMP
 #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"
+    #include "wx/window.h"
+    #include "wx/os2/private.h"
+    #include "wx/font.h"
+    #include "wx/bitmap.h"
+    #include "wx/dcmemory.h"
+    #include "wx/menu.h"
+    #include "wx/utils.h"
+    #include "wx/settings.h"
+    #include "wx/menuitem.h"

 #endif
 
 #endif
 

-#if wxUSE_OWNER_DRAWN
-

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

-#include "wx/menuitem.h"
-
+#include "wx/os2/dcclient.h"

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

+//

 // ctor
 // ----
 // ctor
 // ----

-wxOwnerDrawn::wxOwnerDrawn(const wxString& str,
-                           bool bCheckable, bool bMenuItem)
-            : m_strName(str)
+//
+wxOwnerDrawn::wxOwnerDrawn( const wxString& rsStr,
+                            bool            bCheckable,
+                            bool            WXUNUSED(bMenuItem) )
+: m_strName(rsStr)

 {
 {

-  m_bCheckable   = bCheckable;
-  m_bOwnerDrawn  = FALSE;
-  m_nHeight      = 0;
-  m_nMarginWidth = ms_nLastMarginWidth;
-}
+    m_bCheckable   = bCheckable;
+    m_bOwnerDrawn  = false;
+    m_nHeight      = 0;
+    m_nMarginWidth = ms_nLastMarginWidth;
+    if (wxNORMAL_FONT)
+        m_font = *wxNORMAL_FONT;
+} // end of wxOwnerDrawn::wxOwnerDrawn
+
+wxOwnerDrawn::~wxOwnerDrawn() { }

 
 

-  size_t wxOwnerDrawn::ms_nDefaultMarginWidth = 15;
+size_t wxOwnerDrawn::ms_nDefaultMarginWidth = 15;

 
 size_t wxOwnerDrawn::ms_nLastMarginWidth = ms_nDefaultMarginWidth;
 
 
 size_t wxOwnerDrawn::ms_nLastMarginWidth = ms_nDefaultMarginWidth;
 

-// drawing
+//
+// Drawing

 // -------
 // -------

+//

 
 

-// get size of the item
-bool wxOwnerDrawn::OnMeasureItem(size_t *pwidth, size_t *pheight)
+bool wxOwnerDrawn::OnMeasureItem( size_t* pWidth,
+                                  size_t* pHeight )

 {
 {

-  wxMemoryDC dc;
-  dc.SetFont(GetFont());
+    wxMemoryDC vDC;
+
+    wxString  sStr = wxStripMenuCodes(m_strName);
+
+    //
+    // 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() )
+    {
+        sStr.Pad(sStr.length()%8);
+        sStr += m_strAccel;
+    }
+    vDC.SetFont(GetFont());
+    vDC.GetTextExtent( sStr
+                      ,(wxCoord *)pWidth
+                      ,(wxCoord *)pHeight
+                     );
+    if (!m_strAccel.empty())
+    {
+        //
+        // Measure the accelerator string, and add its 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                         nAccelWidth;
+        int                         nAccelHeight;
+
+        vDC.GetTextExtent( m_strAccel
+                          ,&nAccelWidth
+                          ,&nAccelHeight
+                         );
+        *pWidth += nAccelWidth;
+    }

 
 

-  // ## ugly...
-  wxChar *szStripped = new wxChar[m_strName.Len()];
-  wxStripMenuCodes((wxChar *)m_strName.c_str(), szStripped);
-  wxString str = szStripped;
-  delete [] szStripped;
+    //
+    // 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)(*pWidth + GetDefaultMarginWidth() * 1.5);
+
+    //
+    // JACS: items still look too tightly packed, so adding 5 pixels.
+    //
+    (*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                      nAdjustedHeight = m_bmpChecked.GetHeight() +
+                                                      wxSystemSettings::GetMetric(wxSYS_EDGE_Y);
+        if (*pHeight < nAdjustedHeight)
+            *pHeight = nAdjustedHeight;
+
+        //
+        // Does BMP encroach on default check menu position?
+        //
+        size_t                      nAdjustedWidth = m_bmpChecked.GetWidth() +
+                                                     (wxSystemSettings::GetMetric(wxSYS_EDGE_X) * 2);
+
+        //
+        // Do we need to widen margin to fit BMP?
+        //
+        if ((size_t)GetMarginWidth() < nAdjustedWidth)
+            SetMarginWidth(nAdjustedWidth);
+
+        //
+        // Add the size of the bitmap to our total size...
+        //
+        *pWidth += GetMarginWidth();
+    }

 
 

-  // # without this menu items look too tightly packed (at least under Windows)
-  str += wxT('W'); // 'W' is typically the widest letter
+    //
+    // 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
+    //
+    const size_t heightStd = 6;                 // FIXME: get value from the system
+    if ( *pHeight < heightStd )
+      *pHeight = heightStd;
+    m_nHeight = *pHeight;                // remember height for use in OnDrawItem
+    return true;
+} // end of wxOwnerDrawn::OnMeasureItem

 
 

-  dc.GetTextExtent(str, (long *)pwidth, (long *)pheight);
+// draw the item
+bool wxOwnerDrawn::OnDrawItem( wxDC& rDC,
+                               const wxRect& rRect,
+                               wxODAction eAction,
+                               wxODStatus eStatus )
+{
+    //
+    // We do nothing on focus change
+    //
+    if (eAction == wxODFocusChanged )
+        return true;
+
+    //
+    // Select the font and draw the text
+    // ---------------------------------
+    //
+
+    CHARBUNDLE                      vCbnd;
+    wxPMDCImpl                      *impl = (wxPMDCImpl*) rDC.GetImpl();
+    HPS                             hPS= impl->GetHPS();
+    wxColour                        vColBack;
+    wxColour                        vColText;
+    COLORREF                        vRef;
+    RECTL                           vRect = {rRect.x + 4, rRect.y + 1, rRect.x + (rRect.width - 2), rRect.y + rRect.height};
+
+    memset(&vCbnd, 0, sizeof(CHARBUNDLE));
+
+    //
+    // Use default font if no font set
+    //
+    if (m_font.Ok())
+    {
+        m_font.RealizeResource();
+    }
+    else
+    {
+        ::GpiSetCharSet(hPS, LCID_DEFAULT);
+    }

 
 

-  // JACS: items still look too tightly packed, so adding 2 pixels.
-  (*pheight) = (*pheight) + 2;
+    //
+    // Based on the status of the menu item, pick the right colors
+    //
+    if (eStatus & wxODSelected)
+    {
+        vRef = (ULONG)::WinQuerySysColor( HWND_DESKTOP
+                                         ,SYSCLR_MENUHILITEBGND
+                                         ,0L
+                                        );
+        vColBack.Set( GetRValue(vRef)
+                     ,GetGValue(vRef)
+                     ,GetBValue(vRef)
+                    );
+        vRef = (ULONG)::WinQuerySysColor( HWND_DESKTOP
+                                         ,SYSCLR_MENUHILITE
+                                         ,0L
+                                        );
+        vColText.Set( GetRValue(vRef)
+                     ,GetGValue(vRef)
+                     ,GetBValue(vRef)
+                    );
+    }
+    else if (eStatus & wxODDisabled)
+    {
+        vRef = (ULONG)::WinQuerySysColor( HWND_DESKTOP
+                                         ,SYSCLR_MENU // Light gray
+                                         ,0L
+                                        );
+        vColBack.Set( GetRValue(vRef)
+                     ,GetGValue(vRef)
+                     ,GetBValue(vRef)
+                    );
+        vRef = (ULONG)::WinQuerySysColor( HWND_DESKTOP
+                                         ,SYSCLR_MENUDISABLEDTEXT // dark gray
+                                         ,0L
+                                        );
+        vColText.Set( GetRValue(vRef)
+                     ,GetGValue(vRef)
+                     ,GetBValue(vRef)
+                    );
+    }
+    else
+    {
+        //
+        // Fall back to default colors if none explicitly specified
+        //
+        vRef = ::WinQuerySysColor( HWND_DESKTOP
+                                  ,SYSCLR_MENU  // we are using gray for all our window backgrounds in wxWidgets
+                                  ,0L
+                                 );
+        vColBack.Set( GetRValue(vRef)
+                     ,GetGValue(vRef)
+                     ,GetBValue(vRef)
+                    );
+        vRef = ::WinQuerySysColor( HWND_DESKTOP
+                                  ,SYSCLR_WINDOWTEXT // Black
+                                  ,0L
+                                 );
+        vColText.Set( GetRValue(vRef)
+                     ,GetGValue(vRef)
+                     ,GetBValue(vRef)
+                    );
+    }

 
 

-  m_nHeight = *pheight;                // remember height for use in OnDrawItem
+    rDC.SetTextBackground(vColBack);
+    rDC.SetTextForeground(vColText);
+    rDC.SetBackgroundMode(wxTRANSPARENT);
+    vCbnd.lColor     = vColText.GetPixel();
+    vCbnd.lBackColor = vColBack.GetPixel();
+    ::GpiSetAttrs( hPS
+                  ,PRIM_CHAR
+                  ,CBB_BACK_COLOR | CBB_COLOR
+                  ,0
+                  ,&vCbnd
+                 );
+    ::GpiSetBackMix( hPS
+                    ,BM_LEAVEALONE
+                   );
+
+    //
+    // Paint the background
+    //
+    ::WinFillRect(hPS, &vRect, vColBack.GetPixel());
+
+    //
+    // Determine where to draw and leave space for a check-mark.
+    //
+    int                             nX = rRect.x + GetMarginWidth();
+
+    //
+    // Unfortunately, unlike Win32, PM has no owner drawn specific text
+    // drawing methods like ::DrawState that can cleanly handle accel
+    // mnemonics and deal, automatically, with various states, so we have
+    // to handle them ourselves. Notice Win32 can't handle \t in ownerdrawn
+    // strings either.  We cannot handle mnemonics either.  We display
+    // them, though, in the hope we can figure them out some day.
+    //
+
+    //
+    // Display main text and accel text separately to align better
+    //
+    wxString sTgt = wxT("\t");
+    wxString sFullString = m_strName; // need to save the original text
+    wxString sAccel;
+    int      nIndex;
+    size_t   nWidth;
+    size_t   nCharWidth;
+    size_t   nHeight;
+    bool     bFoundMnemonic = false;
+    bool     bFoundAccel = false;
+
+    //
+    // Deal with the tab, extracting the Accel text
+    //
+    nIndex = sFullString.Find(sTgt);
+    if (nIndex != -1)
+    {
+        bFoundAccel = true;
+        sAccel = sFullString.Mid(nIndex + 1);
+        sFullString.Remove(nIndex);
+    }

 
 

-  return TRUE;
-}
+    //
+    // Deal with the mnemonic character
+    //
+    sTgt = wxT("~");
+    nIndex = sFullString.Find(sTgt);
+    if (nIndex != -1)
+    {
+        wxString sTmp = sFullString;
+
+        bFoundMnemonic = true;
+        sTmp.Remove(nIndex);
+        rDC.GetTextExtent( sTmp
+                          ,(wxCoord *)&nWidth
+                          ,(wxCoord *)&nHeight
+                         );
+        sTmp = sFullString[(size_t)(nIndex + 1)];
+        rDC.GetTextExtent( sTmp
+                          ,(wxCoord *)&nCharWidth
+                          ,(wxCoord *)&nHeight
+                         );
+        sFullString.Replace(sTgt.c_str(), wxEmptyString, true);
+    }

 
 

-// 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)
+    //
+    // Draw the main item text sans the accel text
+    //
+    POINTL                      vPntStart = {nX, rRect.y + 4};
+    ::GpiCharStringAt( impl->GetHPS()
+                      ,&vPntStart
+                      ,sFullString.length()
+                      ,sFullString.char_str()
+                     );
+    if (bFoundMnemonic)
+    {
+        //
+        // Underline the mnemonic -- still won't work, but at least it "looks" right
+        //
+        wxPen                       vPen;
+        POINTL                      vPntEnd = {nX + nWidth + nCharWidth - 3, rRect.y + 2}; //CharWidth is bit wide
+
+        vPntStart.x = nX + nWidth - 1;
+        vPntStart.y = rRect.y + 2; // Make it look pretty!
+        vPen = wxPen(vColText, 1, wxSOLID); // Assuming we are always black
+        rDC.SetPen(vPen);
+        ::GpiMove(hPS, &vPntStart);
+        ::GpiLine(hPS, &vPntEnd);
+    }

 
 

-// 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?
+    //
+    // Now draw the accel text
+    //
+    if (bFoundAccel)
+    {
+        size_t                      nWidth;
+        size_t                      nHeight;
+
+        rDC.GetTextExtent( sAccel
+                          ,(wxCoord *)&nWidth
+                          ,(wxCoord *)&nHeight
+                         );
+        //
+        // Back off the starting position from the right edge
+        //
+        vPntStart.x = rRect.width - (nWidth + 7);
+        vPntStart.y = rRect.y + 4;
+        ::GpiCharStringAt( impl->GetHPS()
+                          ,&vPntStart
+                          ,sAccel.length()
+                          ,sAccel.char_str()
+                         );
+    }

 
 

-// draw the item
-bool wxOwnerDrawn::OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus st)
-{
-///////////////////////////////////////////////////////////////////////////////////////////////////
-// Might want to check the native drawing apis for here and doo something like MSW does for WIN95
-///////////////////////////////////////////////////////////////////////////////////////////////////
-
-  // we do nothing on focus change
-  if ( act == wxODFocusChanged )
-    return TRUE;
-
-  // wxColor <-> RGB
-  #define   ToRGB(col)  RGB(col.Red(), col.Green(), col.Blue())
-  #define   UnRGB(col)  GetRValue(col), GetGValue(col), GetBValue(col)
-
-  // set the colors
-  // --------------
-  DWORD colBack, colText;
-// TODO:
-/*
-  if ( st & wxODSelected ) {
-    colBack = GetSysColor(COLOR_HIGHLIGHT);
-    colText = GetSysColor(COLOR_HIGHLIGHTTEXT);
-  }
-  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);
-  }
-*/
-//    dc.SetTextForeground(wxColor(UnRGB(colText)));
-//    dc.SetTextBackground(wxColor(UnRGB(colBack)));
-
-  // select the font and draw the text
-  // ---------------------------------
-
-  // determine where to draw and leave space for a check-mark.
-  int x = rc.x + GetMarginWidth();
-
-    dc.SetFont(GetFont());
-    dc.DrawText(m_strName, x, rc.y);
-
-  // draw the bitmap
-  // ---------------
-  if ( IsCheckable() && !m_bmpChecked.Ok() ) {
-    if ( st & wxODChecked ) {
-      // using native APIs for performance and simplicity
-// TODO:
-/*
-      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 };
-
-        // finally copy it to screen DC and clean up
-      BitBlt(hdc, rc.x, rc.y, GetMarginWidth(), m_nHeight,
-             hdcMem, 0, 0, SRCCOPY);
-      DeleteDC(hdcMem);
-*/
+    //
+    // Draw the bitmap
+    // ---------------
+    //
+    if (IsCheckable() && !m_bmpChecked.Ok())
+    {
+        if (eStatus & wxODChecked)
+        {
+            RECTL                   vRect;
+            HBITMAP                 hBmpCheck = ::WinGetSysBitmap(HWND_DESKTOP, SBMP_MENUCHECK);
+
+            vRect.xLeft   = rRect.x;
+            vRect.xRight  = rRect.x + GetMarginWidth();
+            vRect.yBottom = rRect.y;
+            vRect.yTop    = rRect.y + m_nHeight - 3;
+
+            ::WinDrawBitmap( hPS             // PS for this menuitem
+                            ,hBmpCheck       // system checkmark
+                            ,NULL            // draw the whole bitmap
+                            ,(PPOINTL)&vRect // destination -- bottom left corner of the menuitem area
+                            ,0L              // ignored
+                            ,0L              // draw a bitmap
+                            ,DBM_NORMAL      // draw normal size
+                           );
+        }

     }
     }

-  }
-  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()));
-
-      //MT: blit with mask enabled.
-// TODO:
-/*
-      dc.Blit(rc.x + (GetMarginWidth() - nBmpWidth) / 2,
-              rc.y + (m_nHeight - nBmpHeight) /2,
-              nBmpWidth, nBmpHeight,
-              &dcMem, 0, 0, wxCOPY,true);
-
-      if ( st & wxODSelected ) {
-        #ifdef  O_DRAW_NATIVE_API
-          RECT rectBmp = { rc.GetLeft(), rc.GetTop(),
-                           rc.GetLeft() + GetMarginWidth(),
-                           rc.GetTop() + m_nHeight };
-          SetBkColor(hdc, colBack);
-          DrawEdge(hdc, &rectBmp, EDGE_RAISED, BF_SOFT | BF_RECT);
-      }
-*/
+    else
+    {
+        //
+        // For uncheckable item we use only the 'checked' bitmap
+        //
+        wxBitmap vBmp(GetBitmap(IsCheckable() ? ((eStatus & wxODChecked) != 0) : TRUE));
+
+        if (vBmp.Ok())
+        {
+
+            wxMemoryDC              vDCMem(&rDC);
+            wxMemoryDC*             pOldDC = (wxMemoryDC*)vBmp.GetSelectedInto();
+
+            if(pOldDC != NULL)
+            {
+                vBmp.SetSelectedInto(NULL);
+            }
+            vDCMem.SelectObject(vBmp);
+
+            //
+            // Center bitmap
+            //
+            int                     nBmpWidth = vBmp.GetWidth();
+            int                     nBmpHeight = vBmp.GetHeight();
+
+            //
+            // There should be enough space!
+            //
+            wxASSERT((nBmpWidth <= rRect.width) && (nBmpHeight <= rRect.height));
+
+            int                     nHeightDiff = m_nHeight - nBmpHeight;
+
+            rDC.Blit( rRect.x + (GetMarginWidth() - nBmpWidth) / 2
+                     ,rRect.y + nHeightDiff / 2
+                     ,nBmpWidth
+                     ,nBmpHeight
+                     ,&vDCMem
+                     ,0
+                     ,0
+                     ,wxCOPY
+                     ,true
+                    );
+
+            if (eStatus & wxODSelected)
+            {
+                POINTL              vPnt1 = {rRect.x + 1, rRect.y + 3}; // Leave a little background border
+                POINTL              vPnt2 = {rRect.x + GetMarginWidth(), rRect.y + m_nHeight - 3};
+
+                LINEBUNDLE          vLine;
+
+                vLine.lColor = vColBack.GetPixel();
+                ::GpiSetAttrs( hPS
+                              ,PRIM_LINE
+                              ,LBB_COLOR
+                              ,0
+                              ,&vLine
+                             );
+                ::GpiMove(hPS, &vPnt1);
+                ::GpiBox( hPS
+                         ,DRO_OUTLINE
+                         ,&vPnt2
+                         ,0L
+                         ,0L
+                        );
+            }
+            vBmp.SetSelectedInto(NULL);
+        }

     }
     }

-  }
-/*
-  #ifdef  O_DRAW_NATIVE_API
-    ::SetTextColor(hdc, colOldText);
-    ::SetBkColor(hdc, colOldBack);
-
-    #undef  hdc
-  #endif  //O_DRAW_NATIVE_API
-*/
-  return TRUE;
-}
+    return true;
+} // end of wxOwnerDrawn::OnDrawItem

 
 #endif //wxUSE_OWNER_DRAWN
 
 #endif //wxUSE_OWNER_DRAWN