src/msw/dcclient.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dcclient.cpp
   3 // Purpose:     wxClientDC class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ===========================================================================
  13 // declarations
  14 // ===========================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "dcclient.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #include "wx/string.h"
  32 #include "wx/log.h"
  33 #include "wx/window.h"
  34
  35 #include "wx/msw/private.h"
  36
  37 #include "wx/dcclient.h"
  38
  39 // ----------------------------------------------------------------------------
  40 // array/list types
  41 // ----------------------------------------------------------------------------
  42
  43 struct WXDLLEXPORT wxPaintDCInfo
  44 {
  45     wxPaintDCInfo(wxWindow *win, wxDC *dc)
  46     {
  47         hwnd = win->GetHWND();
  48         hdc = dc->GetHDC();
  49         count = 1;
  50     }
  51
  52     WXHWND    hwnd;       // window for this DC
  53     WXHDC     hdc;        // the DC handle
  54     size_t    count;      // usage count
  55 };
  56
  57 #include "wx/arrimpl.cpp"
  58
  59 WX_DEFINE_OBJARRAY(wxArrayDCInfo);
  60
  61 // ----------------------------------------------------------------------------
  62 // macros
  63 // ----------------------------------------------------------------------------
  64
  65 IMPLEMENT_DYNAMIC_CLASS(wxWindowDC, wxDC)
  66 IMPLEMENT_DYNAMIC_CLASS(wxClientDC, wxWindowDC)
  67 IMPLEMENT_DYNAMIC_CLASS(wxPaintDC, wxClientDC)
  68
  69 // ----------------------------------------------------------------------------
  70 // global variables
  71 // ----------------------------------------------------------------------------
  72
  73 static PAINTSTRUCT g_paintStruct;
  74
  75 #ifdef __WXDEBUG__
  76     // a global variable which we check to verify that wxPaintDC are only
  77     // created in resopnse to WM_PAINT message - doing this from elsewhere is a
  78     // common programming error among wxWindows programmers and might lead to
  79     // very subtle and difficult to debug refresh/repaint bugs.
  80     int g_isPainting = 0;
  81 #endif // __WXDEBUG__
  82
  83 // ===========================================================================
  84 // implementation
  85 // ===========================================================================
  86
  87 // ----------------------------------------------------------------------------
  88 // wxWindowDC
  89 // ----------------------------------------------------------------------------
  90
  91 wxWindowDC::wxWindowDC()
  92 {
  93     m_canvas = NULL;
  94 }
  95
  96 wxWindowDC::wxWindowDC(wxWindow *canvas)
  97 {
  98     wxCHECK_RET( canvas, _T("invalid window in wxWindowDC") );
  99
 100     m_canvas = canvas;
 101     m_hDC = (WXHDC) ::GetWindowDC(GetHwndOf(m_canvas));
 102
 103     // m_bOwnsDC was already set to false in the base class ctor, so the DC
 104     // will be released (and not deleted) in ~wxDC
 105     InitDC();
 106 }
 107
 108 void wxWindowDC::InitDC()
 109 {
 110     // the background mode is only used for text background and is set in
 111     // DrawText() to OPAQUE as required, otherwise always TRANSPARENT,
 112     ::SetBkMode(GetHdc(), TRANSPARENT);
 113
 114     // default bg colour is pne of the window
 115     SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
 116
 117     // since we are a window dc we need to grab the palette from the window
 118 #if wxUSE_PALETTE
 119     InitializePalette();
 120 #endif
 121 }
 122
 123 void wxWindowDC::DoGetSize(int *width, int *height) const
 124 {
 125     wxCHECK_RET( m_canvas, _T("wxWindowDC without a window?") );
 126
 127     m_canvas->GetSize(width, height);
 128 }
 129
 130 // ----------------------------------------------------------------------------
 131 // wxClientDC
 132 // ----------------------------------------------------------------------------
 133
 134 wxClientDC::wxClientDC()
 135 {
 136     m_canvas = NULL;
 137 }
 138
 139 wxClientDC::wxClientDC(wxWindow *canvas)
 140 {
 141     wxCHECK_RET( canvas, _T("invalid window in wxClientDC") );
 142
 143     m_canvas = canvas;
 144     m_hDC = (WXHDC)::GetDC(GetHwndOf(m_canvas));
 145
 146     // m_bOwnsDC was already set to false in the base class ctor, so the DC
 147     // will be released (and not deleted) in ~wxDC
 148
 149     InitDC();
 150 }
 151
 152 void wxClientDC::InitDC()
 153 {
 154     wxWindowDC::InitDC();
 155
 156     // in wxUniv build we must manually do some DC adjustments usually
 157     // performed by Windows for us
 158 #ifdef __WXUNIVERSAL__
 159     wxPoint ptOrigin = m_canvas->GetClientAreaOrigin();
 160     if ( ptOrigin.x || ptOrigin.y )
 161     {
 162         // no need to shift DC origin if shift is null
 163         SetDeviceOrigin(ptOrigin.x, ptOrigin.y);
 164     }
 165
 166     // clip the DC to avoid overwriting the non client area
 167     SetClippingRegion(wxPoint(0, 0), m_canvas->GetClientSize());
 168 #endif // __WXUNIVERSAL__
 169 }
 170
 171 wxClientDC::~wxClientDC()
 172 {
 173 }
 174
 175 void wxClientDC::DoGetSize(int *width, int *height) const
 176 {
 177     wxCHECK_RET( m_canvas, _T("wxClientDC without a window?") );
 178
 179     m_canvas->GetClientSize(width, height);
 180 }
 181
 182 // ----------------------------------------------------------------------------
 183 // wxPaintDC
 184 // ----------------------------------------------------------------------------
 185
 186 // VZ: initial implementation (by JACS) only remembered the last wxPaintDC
 187 //     created and tried to reuse it - this was supposed to take care of a
 188 //     situation when a derived class OnPaint() calls base class OnPaint()
 189 //     because in this case ::BeginPaint() shouldn't be called second time.
 190 //
 191 //     I'm not sure how useful this is, however we must remember the HWND
 192 //     associated with the last HDC as well - otherwise we may (and will!) try
 193 //     to reuse the HDC for another HWND which is a nice recipe for disaster.
 194 //
 195 //     So we store a list of windows for which we already have the DC and not
 196 //     just one single hDC. This seems to work, but I'm really not sure about
 197 //     the usefullness of the whole idea - IMHO it's much better to not call
 198 //     base class OnPaint() at all, or, if we really want to allow it, add a
 199 //     "wxPaintDC *" parameter to wxPaintEvent which should be used if it's
 200 //     !NULL instead of creating a new DC.
 201
 202 wxArrayDCInfo wxPaintDC::ms_cache;
 203
 204 wxPaintDC::wxPaintDC()
 205 {
 206     m_canvas = NULL;
 207 }
 208
 209 wxPaintDC::wxPaintDC(wxWindow *canvas)
 210 {
 211     wxCHECK_RET( canvas, wxT("NULL canvas in wxPaintDC ctor") );
 212
 213 #ifdef __WXDEBUG__
 214     if ( g_isPainting <= 0 )
 215     {
 216         wxFAIL_MSG( wxT("wxPaintDC may be created only in EVT_PAINT handler!") );
 217
 218         return;
 219     }
 220 #endif // __WXDEBUG__
 221
 222     m_canvas = canvas;
 223
 224     // do we have a DC for this window in the cache?
 225     wxPaintDCInfo *info = FindInCache();
 226     if ( info )
 227     {
 228         m_hDC = info->hdc;
 229         info->count++;
 230     }
 231     else // not in cache, create a new one
 232     {
 233         m_hDC = (WXHDC)::BeginPaint(GetHwndOf(m_canvas), &g_paintStruct);
 234         if (m_hDC)
 235             ms_cache.Add(new wxPaintDCInfo(m_canvas, this));
 236     }
 237
 238     // (re)set the DC parameters.
 239     // Note: at this point m_hDC can be NULL under MicroWindows, when dragging.
 240     if (GetHDC())
 241         InitDC();
 242 }
 243
 244 wxPaintDC::~wxPaintDC()
 245 {
 246     if ( m_hDC )
 247     {
 248         SelectOldObjects(m_hDC);
 249
 250         size_t index;
 251         wxPaintDCInfo *info = FindInCache(&index);
 252
 253         wxCHECK_RET( info, wxT("existing DC should have a cache entry") );
 254
 255         if ( !--info->count )
 256         {
 257             ::EndPaint(GetHwndOf(m_canvas), &g_paintStruct);
 258
 259             ms_cache.RemoveAt(index);
 260
 261             // Reduce the number of bogus reports of non-freed memory
 262             // at app exit
 263             if (ms_cache.IsEmpty())
 264                 ms_cache.Clear();
 265         }
 266         //else: cached DC entry is still in use
 267
 268         // prevent the base class dtor from ReleaseDC()ing it again
 269         m_hDC = 0;
 270     }
 271 }
 272
 273 wxPaintDCInfo *wxPaintDC::FindInCache(size_t *index) const
 274 {
 275     wxPaintDCInfo *info = NULL;
 276     size_t nCache = ms_cache.GetCount();
 277     for ( size_t n = 0; n < nCache; n++ )
 278     {
 279         wxPaintDCInfo *info1 = &ms_cache[n];
 280         if ( info1->hwnd == m_canvas->GetHWND() )
 281         {
 282             info = info1;
 283             if ( index )
 284                 *index = n;
 285             break;
 286         }
 287     }
 288
 289     return info;
 290 }
 291
 292 // find the entry for this DC in the cache (keyed by the window)
 293 WXHDC wxPaintDC::FindDCInCache(wxWindow* win)
 294 {
 295     wxPaintDCInfo *info = NULL;
 296     size_t nCache = ms_cache.GetCount();
 297     for ( size_t n = 0; n < nCache; n++ )
 298     {
 299         info = &ms_cache[n];
 300         if ( info->hwnd == win->GetHWND() )
 301         {
 302             return info->hdc;
 303         }
 304     }
 305     return 0;
 306 }
 307