fix a typo in comment

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

diff --git a/src/os2/dcclient.cpp b/src/os2/dcclient.cpp
index 75ffabc6ff7b5998f4c8182176a351e9e98e504f..11160fbf97b95d9d4eb7ca7bf63aeb554a769d67 100644 (file)
--- a/src/os2/dcclient.cpp
+++ b/src/os2/dcclient.cpp
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        dcclient.cpp
+// Name:        src/os2/dcclient.cpp

 // Purpose:     wxClientDC class
 // Purpose:     wxClientDC class

-// Author:      Julian Smart
+// Author:      David Webster

 // Modified by:
 // Modified by:

-// Created:     01/02/97
+// Created:     09/21/99

 // RCS-ID:      $Id$
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
+// Copyright:   (c) David Webster

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -17,24 +17,20 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "dcclient.h"
-#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"
 

-#ifdef __BORLANDC__
-    #pragma hdrstop
-#endif
-
-#include "wx/string.h"
-#include "wx/log.h"
-#include "wx/window.h"
+#include "wx/dcclient.h"
+#include "wx/os2/dcclient.h"

 
 

-#include "wx/msw/private.h"
+#ifndef WX_PRECOMP
+    #include "wx/string.h"
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/window.h"
+#endif

 
 

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

 
 // ----------------------------------------------------------------------------
 // array/list types
 
 // ----------------------------------------------------------------------------
 // array/list types


@@ -42,42 +38,34 @@
 
 struct WXDLLEXPORT wxPaintDCInfo
 {
 
 struct WXDLLEXPORT wxPaintDCInfo
 {

-    wxPaintDCInfo(wxWindow *win, wxDC *dc)
+    wxPaintDCInfo( wxWindow* pWin
+                  ,wxPaintDCImpl*     pDC
+                 )

     {
     {

-        hwnd = win->GetHWND();
-        hdc = dc->GetHDC();
-        count = 1;
+        m_hWnd = pWin->GetHWND();
+        m_hDC = pDC->GetHDC();
+        m_nCount = 1;

     }
 
     }
 

-    WXHWND    hwnd;       // window for this DC
-    WXHDC     hdc;        // the DC handle
-    size_t    count;      // usage count
-};
+    WXHWND                          m_hWnd;   // window for this DC
+    WXHDC                           m_hDC;    // the DC handle
+    size_t                          m_nCount; // usage count
+}; // end of wxPaintDCInfot

 
 #include "wx/arrimpl.cpp"
 
 WX_DEFINE_OBJARRAY(wxArrayDCInfo);
 
 
 #include "wx/arrimpl.cpp"
 
 WX_DEFINE_OBJARRAY(wxArrayDCInfo);
 

-// ----------------------------------------------------------------------------
-// macros
-// ----------------------------------------------------------------------------
-
-#if !USE_SHARED_LIBRARY
-    IMPLEMENT_DYNAMIC_CLASS(wxWindowDC, wxDC)
-    IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxWindowDC)
-    IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxWindowDC)
-#endif
-

 // ----------------------------------------------------------------------------
 // global variables
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // global variables
 // ----------------------------------------------------------------------------
 

-static PAINTSTRUCT g_paintStruct;
+static RECT        g_paintStruct;

 
 #ifdef __WXDEBUG__
     // a global variable which we check to verify that wxPaintDC are only
     // created in resopnse to WM_PAINT message - doing this from elsewhere is a
 
 #ifdef __WXDEBUG__
     // a global variable which we check to verify that wxPaintDC are only
     // created in resopnse to WM_PAINT message - doing this from elsewhere is a

-    // common programming error among wxWindows programmers and might lead to
+    // common programming error among wxWidgets programmers and might lead to

     // very subtle and difficult to debug refresh/repaint bugs.
     int g_isPainting = 0;
 #endif // __WXDEBUG__
     // very subtle and difficult to debug refresh/repaint bugs.
     int g_isPainting = 0;
 #endif // __WXDEBUG__


@@ -87,152 +75,317 @@ static PAINTSTRUCT g_paintStruct;
 // ===========================================================================
 
 // ----------------------------------------------------------------------------
 // ===========================================================================
 
 // ----------------------------------------------------------------------------

-// wxWindowDC
+// wxWindowDCImpl

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

-wxWindowDC::wxWindowDC()
+IMPLEMENT_ABSTRACT_CLASS(wxWindowDCImpl, wxPMDCImpl)
+
+wxWindowDCImpl::wxWindowDCImpl( wxDC *owner ) :
+   wxPMDCImpl( owner )

 {
 {

-  m_canvas = NULL;
+    m_PageSize.cx = m_PageSize.cy = 0;

 }
 
 }
 

-wxWindowDC::wxWindowDC(wxWindow *the_canvas)
+wxWindowDCImpl::wxWindowDCImpl( wxDC *owner, wxWindow* pTheCanvas) :
+   wxPMDCImpl( owner )

 {
 {

-  m_canvas = the_canvas;
-  m_hDC = (WXHDC) ::WinOpenWindowDC(GetWinHwnd(the_canvas) );
-  m_hDCCount++;
+    ERRORID                         vError;
+    wxString                        sError;
+    int                             nWidth, nHeight;

 
 

-  SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
-}
+    m_pCanvas = pTheCanvas;
+    DoGetSize(&nWidth, &nHeight);
+    m_PageSize.cx = nWidth;
+    m_PageSize.cy = nHeight;
+    m_hDC = (WXHDC) ::WinOpenWindowDC(GetWinHwnd(pTheCanvas) );
+
+    //
+    // default under PM is that Window and Client DC's are the same
+    // so we offer a separate Presentation Space to use for the
+    // entire window.  Otherwise, calling BeginPaint will just create
+    // chached-micro client presentation space
+    //
+     m_hPS = ::GpiCreatePS( vHabmain
+                           ,m_hDC
+                           ,&m_PageSize
+                           ,PU_PELS | GPIF_LONG | GPIA_ASSOC
+                          );
+    if (!m_hPS)
+    {
+        vError = ::WinGetLastError(vHabmain);
+        sError = wxPMErrorToStr(vError);
+        wxLogError(_T("Unable to create presentation space. Error: %s\n"), sError.c_str());
+    }
+    ::GpiAssociate(m_hPS, NULLHANDLE);
+    ::GpiAssociate(m_hPS, m_hDC);

 
 

-wxWindowDC::~wxWindowDC()
+    //
+    // Set the wxWidgets color table
+    //
+    if (!::GpiCreateLogColorTable( m_hPS
+                                  ,0L
+                                  ,LCOLF_CONSECRGB
+                                  ,0L
+                                  ,(LONG)wxTheColourDatabase->m_nSize
+                                  ,(PLONG)wxTheColourDatabase->m_palTable
+                                 ))
+    {
+        vError = ::WinGetLastError(vHabmain);
+        sError = wxPMErrorToStr(vError);
+        wxLogError(_T("Unable to set current color table (3). Error: %s\n"), sError.c_str());
+    }
+    ::GpiCreateLogColorTable( m_hPS
+                             ,0L
+                             ,LCOLF_RGB
+                             ,0L
+                             ,0L
+                             ,NULL
+                            );
+    ::WinQueryWindowRect( GetWinHwnd(m_pCanvas)
+                         ,&m_vRclPaint
+                        );
+    InitDC();
+} // end of wxWindowDCImpl::wxWindowDCImpl
+
+void wxWindowDCImpl::InitDC()

 {
 {

-  if (m_canvas && m_hDC)
-  {
-    SelectOldObjects(m_hDC);

 
     //
 
     //

-    // In PM one does not explicitly close or release an open WindowDC
-    // They automatically close with the window, unless explicitly detached
+    // The background mode is only used for text background and is set in
+    // DrawText() to OPAQUE as required, otherwise always TRANSPARENT,

     //
     //

-    m_hDC = 0;
-  }
+    ::GpiSetBackMix(GetHPS(), BM_LEAVEALONE);

 
 

-  m_hDCCount--;
-}
+    //
+    // Default bg colour is pne of the window
+    //
+    SetBackground(wxBrush(m_pCanvas->GetBackgroundColour(), wxSOLID));
+
+    m_pen.SetColour(*wxBLACK);
+    m_brush.SetColour(*wxWHITE);
+    // since we are a window dc we need to grab the palette from the window
+#if wxUSE_PALETTE
+    InitializePalette();
+#endif
+    wxFont* pFont = new wxFont( 10, wxMODERN, wxNORMAL, wxBOLD );
+    SetFont(*pFont);
+    delete pFont;
+    //
+    // OS/2 default vertical character alignment needs to match the other OS's
+    //
+    ::GpiSetTextAlignment((HPS)GetHPS(), TA_NORMAL_HORIZ, TA_BOTTOM);
+
+} // end of wxWindowDCImpl::InitDC
+
+void wxWindowDCImpl::DoGetSize(
+  int*                              pnWidth
+, int*                              pnHeight
+) const
+{
+    wxCHECK_RET( m_pCanvas, _T("wxWindowDC without a window?") );
+    m_pCanvas->GetSize( pnWidth
+                       ,pnHeight
+                      );
+} // end of wxWindowDCImpl::DoGetSize

 
 // ----------------------------------------------------------------------------
 // wxClientDC
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxClientDC
 // ----------------------------------------------------------------------------
 

-wxClientDC::wxClientDC()
+IMPLEMENT_ABSTRACT_CLASS(wxClientDCImpl, wxWindowDCImpl)
+
+wxClientDCImpl::wxClientDCImpl( wxDC *owner ) :
+   wxWindowDCImpl( owner )

 {
 {

-  m_canvas = NULL;
+    m_pCanvas = NULL;

 }
 
 }
 

-wxClientDC::wxClientDC(wxWindow *the_canvas)
+wxClientDCImpl::wxClientDCImpl( wxDC *owner, wxWindow *pTheCanvas) :
+   wxWindowDCImpl( owner )

 {
 {

-  m_canvas = the_canvas;
-  m_hDC = (WXHDC) ::GetDC(GetWinHwnd(the_canvas));
+    SIZEL                           vSizl = { 0,0};
+    ERRORID                         vError;
+    wxString                        sError;

 
 

-  // the background mode is only used for text background
-  // and is set in DrawText() to OPAQUE as required, other-
-  // wise always TRANSPARENT, RR
-  ::SetBkMode( GetHdc(), TRANSPARENT );
+    m_pCanvas = pTheCanvas;

 
 

-  SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
-}
+    //
+    // default under PM is that Window and Client DC's are the same
+    //

 
 

-wxClientDC::~wxClientDC()
+    m_hDC = (WXHDC) ::WinOpenWindowDC(GetWinHwnd(pTheCanvas));
+    printf("Got WindowDC %X for window handle %X\n", m_hDC, pTheCanvas);
+
+    m_hPS = ::GpiCreatePS( wxGetInstance()
+                          ,m_hDC
+                          ,&vSizl
+                          ,PU_PELS | GPIF_LONG | GPIA_ASSOC
+                         );
+    ::GpiAssociate(m_hPS, NULLHANDLE);
+    ::GpiAssociate(m_hPS, m_hDC);
+
+    printf("Got m_hPS %X\n", m_hPS);
+    // Set the wxWidgets color table
+    if (!::GpiCreateLogColorTable( m_hPS
+                                  ,0L
+                                  ,LCOLF_CONSECRGB
+                                  ,0L
+                                  ,(LONG)wxTheColourDatabase->m_nSize
+                                  ,(PLONG)wxTheColourDatabase->m_palTable
+                                 ))
+    {
+        vError = ::WinGetLastError(vHabmain);
+        sError = wxPMErrorToStr(vError);
+        wxLogError(_T("Unable to set current color table (4). Error: %s\n"), sError.c_str());
+    }
+    ::GpiCreateLogColorTable( m_hPS
+                             ,0L
+                             ,LCOLF_RGB
+                             ,0L
+                             ,0L
+                             ,NULL
+                            );
+    //
+    // Set the DC/PS rectangle
+    //
+    ::WinQueryWindowRect( GetWinHwnd(m_pCanvas)
+                         ,&m_vRclPaint
+                        );
+    InitDC();
+} // end of wxClientDCImpl::wxClientDCImpl
+
+void wxClientDCImpl::InitDC()

 {
 {

-  if ( m_canvas && GetHdc() )
-  {
-    SelectOldObjects(m_hDC);
+    wxWindowDCImpl::InitDC();

 
 

-    ::ReleaseDC(GetWinHwnd(m_canvas), GetHdc());
-    m_hDC = 0;
-  }
-}
+    // in wxUniv build we must manually do some DC adjustments usually
+    // performed by Windows for us
+#ifdef __WXUNIVERSAL__
+    wxPoint ptOrigin = m_pCanvas->GetClientAreaOrigin();
+    if ( ptOrigin.x || ptOrigin.y )
+    {
+        // no need to shift DC origin if shift is null
+        SetDeviceOrigin(ptOrigin.x, ptOrigin.y);
+    }
+
+    // clip the DC to avoid overwriting the non client area
+    SetClippingRegion(wxPoint(0, 0), m_pCanvas->GetClientSize());
+#endif // __WXUNIVERSAL__
+} // end of wxClientDCImpl::InitDC
+
+wxClientDCImpl::~wxClientDCImpl()
+{
+} // end of wxClientDCImpl::~wxClientDCImpl
+
+void wxClientDCImpl::DoGetSize(
+  int*                              pnWidth
+, int*                              pnHeight
+) const
+{
+    wxCHECK_RET( m_pCanvas, _T("wxWindowDC without a window?") );
+    m_pCanvas->GetClientSize( pnWidth
+                             ,pnHeight
+                            );
+} // end of wxClientDCImpl::DoGetSize

 
 // ----------------------------------------------------------------------------
 // wxPaintDC
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxPaintDC
 // ----------------------------------------------------------------------------
 

-// VZ: initial implementation (by JACS) only remembered the last wxPaintDC
-//     created and tried to reuse - this was supposed to take care of a
-//     situation when a derived class OnPaint() calls base class OnPaint()
-//     because in this case ::BeginPaint() shouldn't be called second time.
-//
-//     I'm not sure how useful this is, however we must remember the HWND
-//     associated with the last HDC as well - otherwise we may (and will!) try
-//     to reuse the HDC for another HWND which is a nice recipe for disaster.
-//
-//     So we store a list of windows for which we already have the DC and not
-//     just one single hDC. This seems to work, but I'm really not sure about
-//     the usefullness of the whole idea - IMHO it's much better to not call
-//     base class OnPaint() at all, or, if we really want to allow it, add a
-//     "wxPaintDC *" parameter to wxPaintEvent which should be used if it's
-//     !NULL instead of creating a new DC.
-
-wxArrayDCInfo wxPaintDC::ms_cache;
-
-wxPaintDC::wxPaintDC()
+IMPLEMENT_ABSTRACT_CLASS(wxPaintDCImpl, wxWindowDCImpl)
+
+wxArrayDCInfo wxPaintDCImpl::ms_cache;
+
+wxPaintDCImpl::wxPaintDCImpl( wxDC *owner ) :
+   wxClientDCImpl( owner )

 {
 {

-    m_canvas = NULL;
+    m_pCanvas = NULL;

     m_hDC = 0;
 }
 
     m_hDC = 0;
 }
 

-wxPaintDC::wxPaintDC(wxWindow *canvas)
+wxPaintDCImpl::wxPaintDCImpl( wxDC *owner, wxWindow *pCanvas) :
+   wxClientDCImpl( owner )

 {
 {

-    wxCHECK_RET( canvas, _T("NULL canvas in wxPaintDC ctor") );
+    wxCHECK_RET(pCanvas, wxT("NULL canvas in wxPaintDC ctor"));

 
 #ifdef __WXDEBUG__
 
 #ifdef __WXDEBUG__

-    if ( g_isPainting <= 0 )
+    if (g_isPainting <= 0)

     {
     {

-        wxFAIL_MSG( _T("wxPaintDC may be created only in EVT_PAINT handler!") );
-
+        wxFAIL_MSG( wxT("wxPaintDC may be created only in EVT_PAINT handler!") );

         return;
     }
 #endif // __WXDEBUG__
 
         return;
     }
 #endif // __WXDEBUG__
 

-    m_canvas = canvas;
+    m_pCanvas = pCanvas;

 
 

-    // do we have a DC for this window in the cache?
-    wxPaintDCInfo *info = FindInCache();
-    if ( info )
+    //
+    // Do we have a DC for this window in the cache?
+    //
+    wxPaintDCInfo*                  pInfo = FindInCache();
+
+    if (pInfo)

     {
     {

-        m_hDC = info->hdc;
-        info->count++;
+        m_hDC = pInfo->m_hDC;
+        pInfo->m_nCount++;

     }
     else // not in cache, create a new one
     {
     }
     else // not in cache, create a new one
     {

-        m_hDC = (WXHDC)::BeginPaint(GetWinHwnd(m_canvas), &g_paintStruct);
-        ms_cache.Add(new wxPaintDCInfo(m_canvas, this));
-    }
-
-    // the background mode is only used for text background
-    // and is set in DrawText() to OPAQUE as required, other-
-    // wise always TRANSPARENT, RR
-    ::SetBkMode( GetHdc(), TRANSPARENT );
+        HPS                         hPS;
+
+        m_hDC = ::WinOpenWindowDC(GetWinHwnd(m_pCanvas));
+        hPS = ::WinBeginPaint( GetWinHwnd(m_pCanvas)
+                              ,NULLHANDLE
+                              ,&g_paintStruct
+                             );
+        if(hPS)
+        {
+            ::GpiAssociate(hPS, m_hDC);
+            m_hOldPS = m_hPS;
+            m_hPS = hPS;
+            ::GpiCreateLogColorTable( m_hPS
+                                     ,0L
+                                     ,LCOLF_CONSECRGB
+                                     ,0L
+                                     ,(LONG)wxTheColourDatabase->m_nSize
+                                     ,(PLONG)wxTheColourDatabase->m_palTable
+                                    );
+            ::GpiCreateLogColorTable( m_hPS
+                                     ,0L
+                                     ,LCOLF_RGB
+                                     ,0L
+                                     ,0L
+                                     ,NULL
+                                    );
+
+            ::WinFillRect(hPS, &g_paintStruct,  m_pCanvas->GetBackgroundColour().GetPixel());
+            ::WinQueryWindowRect( GetWinHwnd(m_pCanvas)
+                                 ,&m_vRclPaint
+                                );
+        }

 
 

-    SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
-}
+        m_bIsPaintTime   = true;
+        ms_cache.Add(new wxPaintDCInfo(m_pCanvas, this));
+    }
+    InitDC();
+} // end of wxPaintDCImpl::wxPaintDCImpl

 
 

-wxPaintDC::~wxPaintDC()
+wxPaintDCImpl::~wxPaintDCImpl()

 {
     if ( m_hDC )
     {
         SelectOldObjects(m_hDC);
 
 {
     if ( m_hDC )
     {
         SelectOldObjects(m_hDC);
 

-        size_t index;
-        wxPaintDCInfo *info = FindInCache(&index);
+        size_t                      nIndex;
+        wxPaintDCInfo*              pInfo = FindInCache(&nIndex);

 
 

-        wxCHECK_RET( info, _T("existing DC should have a cache entry") );
+        wxCHECK_RET( pInfo, wxT("existing DC should have a cache entry") );

 
 

-        if ( !--info->count )
+        if ( !--pInfo->m_nCount )

         {
         {

-            ::EndPaint(GetWinHwnd(m_canvas), &g_paintStruct);
-
-            ms_cache.Remove(index);
+            ::WinEndPaint(m_hPS);
+            m_hPS          = m_hOldPS;
+            m_bIsPaintTime = false;
+            ms_cache.RemoveAt(nIndex);

         }
         //else: cached DC entry is still in use
 
         }
         //else: cached DC entry is still in use
 


@@ -241,20 +394,41 @@ wxPaintDC::~wxPaintDC()
     }
 }
 
     }
 }
 

-wxPaintDCInfo *wxPaintDC::FindInCache(size_t *index) const
+wxPaintDCInfo* wxPaintDCImpl::FindInCache(
+  size_t*                           pIndex
+) const

 {
 {

-    wxPaintDCInfo *info = NULL;
-    size_t nCache = ms_cache.GetCount();
-    for ( size_t n = 0; n < nCache; n++ )
+    wxPaintDCInfo*                  pInfo = NULL;
+    size_t                          nCache = ms_cache.GetCount();
+
+    for (size_t n = 0; n < nCache; n++)

     {
     {

-        info = &ms_cache[n];
-        if ( info->hwnd == m_canvas->GetHWND() )
+        pInfo = &ms_cache[n];
+        if (pInfo->m_hWnd == m_pCanvas->GetHWND())

         {
         {

-            if ( index )
-                *index = n;
+            if (pIndex)
+                *pIndex = n;

             break;
         }
     }
             break;
         }
     }

+    return pInfo;
+} // end of wxPaintDCImpl::FindInCache

 
 

-    return info;
-}
+// find the entry for this DC in the cache (keyed by the window)
+WXHDC wxPaintDCImpl::FindDCInCache(
+  wxWindow*                         pWin
+)
+{
+    wxPaintDCInfo*                  pInfo = NULL;
+    size_t                          nCache = ms_cache.GetCount();
+
+    for (size_t n = 0; n < nCache; n++)
+    {
+        pInfo = &ms_cache[n];
+        if (pInfo->m_hWnd == pWin->GetHWND())
+        {
+            return pInfo->m_hDC;
+        }
+    }
+    return 0;
+} // end of wxPaintDCImpl::FindInCache