/////////////////////////////////////////////////////////////////////////////
-// Name: dcclient.cpp
+// Name: src/msw/dcclient.cpp
// Purpose: wxClientDC class
// Author: Julian Smart
// Modified by:
// Created: 01/02/97
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
+// Copyright: (c) Julian Smart
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "dcclient.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
-#include "wx/string.h"
-#include "wx/log.h"
-#include "wx/window.h"
+#include "wx/dcclient.h"
+#include "wx/msw/dcclient.h"
-#include "wx/msw/private.h"
+#ifndef WX_PRECOMP
+ #include "wx/string.h"
+ #include "wx/log.h"
+ #include "wx/window.h"
+#endif
-#include "wx/dcclient.h"
+#include "wx/msw/private.h"
// ----------------------------------------------------------------------------
// array/list types
struct WXDLLEXPORT wxPaintDCInfo
{
- wxPaintDCInfo(wxWindow *win, wxDC *dc)
+ wxPaintDCInfo(wxWindow *win, wxPaintDCImpl *dc)
{
hwnd = win->GetHWND();
hdc = dc->GetHDC();
#include "wx/arrimpl.cpp"
-WX_DEFINE_OBJARRAY(wxArrayDCInfo);
+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
// ----------------------------------------------------------------------------
static PAINTSTRUCT g_paintStruct;
-#ifdef __WXDEBUG__
+#ifdef wxHAS_PAINT_DEBUG
// 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
+ // created in response to WM_PAINT message - doing this from elsewhere is a
+ // common programming error among wxWidgets programmers and might lead to
// very subtle and difficult to debug refresh/repaint bugs.
- bool g_isPainting = FALSE;
-#endif // __WXDEBUG__
+ int g_isPainting = 0;
+#endif // wxHAS_PAINT_DEBUG
// ===========================================================================
// implementation
// ===========================================================================
// ----------------------------------------------------------------------------
-// wxWindowDC
+// wxMSWWindowDCImpl
// ----------------------------------------------------------------------------
-wxWindowDC::wxWindowDC()
+IMPLEMENT_ABSTRACT_CLASS(wxWindowDCImpl, wxMSWDCImpl)
+
+wxWindowDCImpl::wxWindowDCImpl( wxDC *owner ) :
+ wxMSWDCImpl( owner )
{
- m_canvas = NULL;
}
-wxWindowDC::wxWindowDC(wxWindow *the_canvas)
+wxWindowDCImpl::wxWindowDCImpl( wxDC *owner, wxWindow *window ) :
+ wxMSWDCImpl( owner )
{
- m_canvas = the_canvas;
- m_hDC = (WXHDC) ::GetWindowDC(GetWinHwnd(the_canvas) );
- m_hDCCount++;
+ wxCHECK_RET( window, wxT("invalid window in wxWindowDCImpl") );
- SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
+ m_window = window;
+ m_hDC = (WXHDC) ::GetWindowDC(GetHwndOf(m_window));
+
+ // m_bOwnsDC was already set to false in the base class ctor, so the DC
+ // will be released (and not deleted) in ~wxDC
+ InitDC();
}
-wxWindowDC::~wxWindowDC()
+void wxWindowDCImpl::InitDC()
{
- if (m_canvas && m_hDC)
- {
- SelectOldObjects(m_hDC);
+ // the background mode is only used for text background and is set in
+ // DrawText() to OPAQUE as required, otherwise always TRANSPARENT,
+ ::SetBkMode(GetHdc(), TRANSPARENT);
- ::ReleaseDC(GetWinHwnd(m_canvas), GetHdc());
- m_hDC = 0;
- }
+ // since we are a window dc we need to grab the palette from the window
+#if wxUSE_PALETTE
+ InitializePalette();
+#endif
+}
+
+void wxWindowDCImpl::DoGetSize(int *width, int *height) const
+{
+ wxCHECK_RET( m_window, wxT("wxWindowDCImpl without a window?") );
- m_hDCCount--;
+ m_window->GetSize(width, height);
}
// ----------------------------------------------------------------------------
-// wxClientDC
+// wxClientDCImpl
// ----------------------------------------------------------------------------
-wxClientDC::wxClientDC()
+IMPLEMENT_ABSTRACT_CLASS(wxClientDCImpl, wxWindowDCImpl)
+
+wxClientDCImpl::wxClientDCImpl( wxDC *owner ) :
+ wxWindowDCImpl( owner )
{
- m_canvas = NULL;
}
-wxClientDC::wxClientDC(wxWindow *the_canvas)
+wxClientDCImpl::wxClientDCImpl( wxDC *owner, wxWindow *window ) :
+ wxWindowDCImpl( owner )
+{
+ wxCHECK_RET( window, wxT("invalid window in wxClientDCImpl") );
+
+ m_window = window;
+ m_hDC = (WXHDC)::GetDC(GetHwndOf(window));
+
+ // m_bOwnsDC was already set to false in the base class ctor, so the DC
+ // will be released (and not deleted) in ~wxDC
+
+ InitDC();
+}
+
+void wxClientDCImpl::InitDC()
{
- m_canvas = the_canvas;
- m_hDC = (WXHDC) ::GetDC(GetWinHwnd(the_canvas));
+ wxWindowDCImpl::InitDC();
+
+ // in wxUniv build we must manually do some DC adjustments usually
+ // performed by Windows for us
+ //
+ // we also need to take the menu/toolbar manually into account under
+ // Windows CE because they're just another control there, not anything
+ // special as usually under Windows
+#if defined(__WXUNIVERSAL__) || defined(__WXWINCE__)
+ wxPoint ptOrigin = m_window->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
+ wxSize size = m_window->GetClientSize();
+ DoSetClippingRegion(0, 0, size.x, size.y);
+#endif // __WXUNIVERSAL__ || __WXWINCE__
+}
- SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
+wxClientDCImpl::~wxClientDCImpl()
+{
}
-wxClientDC::~wxClientDC()
+void wxClientDCImpl::DoGetSize(int *width, int *height) const
{
- if ( m_canvas && GetHdc() )
- {
- SelectOldObjects(m_hDC);
+ wxCHECK_RET( m_window, wxT("wxClientDCImpl without a window?") );
- ::ReleaseDC(GetWinHwnd(m_canvas), GetHdc());
- m_hDC = 0;
- }
+ m_window->GetClientSize(width, height);
}
// ----------------------------------------------------------------------------
-// wxPaintDC
+// wxPaintDCImpl
// ----------------------------------------------------------------------------
// VZ: initial implementation (by JACS) only remembered the last wxPaintDC
-// created and tried to reuse - this was supposed to take care of a
+// created and tried to reuse it - 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.
//
// 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 realyl want to allow it, add a
+// 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;
+IMPLEMENT_ABSTRACT_CLASS(wxPaintDCImpl, wxClientDCImpl)
+
+wxArrayDCInfo wxPaintDCImpl::ms_cache;
-wxPaintDC::wxPaintDC()
+wxPaintDCImpl::wxPaintDCImpl( wxDC *owner ) :
+ wxClientDCImpl( owner )
{
- m_canvas = NULL;
- m_hDC = 0;
}
-wxPaintDC::wxPaintDC(wxWindow *canvas)
+wxPaintDCImpl::wxPaintDCImpl( wxDC *owner, wxWindow *window ) :
+ wxClientDCImpl( owner )
{
- wxCHECK_RET( canvas, "NULL canvas in wxPaintDC ctor" );
+ wxCHECK_RET( window, wxT("NULL canvas in wxPaintDCImpl ctor") );
-#ifdef __WXDEBUG__
- if ( !g_isPainting )
+#ifdef wxHAS_PAINT_DEBUG
+ if ( g_isPainting <= 0 )
{
- wxFAIL_MSG( _T("wxPaintDC may be created only in EVT_PAINT handler!") );
+ wxFAIL_MSG( wxT("wxPaintDCImpl may be created only in EVT_PAINT handler!") );
return;
}
-#endif // __WXDEBUG__
+#endif // wxHAS_PAINT_DEBUG
- m_canvas = canvas;
+ m_window = window;
// do we have a DC for this window in the cache?
wxPaintDCInfo *info = FindInCache();
}
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));
+ // see comments in src/msw/window.cpp where this is defined
+ extern bool wxDidCreatePaintDC;
+
+ wxDidCreatePaintDC = true;
+
+ m_hDC = (WXHDC)::BeginPaint(GetHwndOf(m_window), &g_paintStruct);
+ if (m_hDC)
+ ms_cache.Add(new wxPaintDCInfo(m_window, this));
}
- SetBackground(wxBrush(m_canvas->GetBackgroundColour(), wxSOLID));
+ // Note: at this point m_hDC can be NULL under MicroWindows, when dragging.
+ if (!GetHDC())
+ return;
+
+ // (re)set the DC parameters.
+ InitDC();
+
+ // the HDC can have a clipping box (which we didn't set), make sure our
+ // DoGetClippingBox() checks for it
+ m_clipping = true;
}
-wxPaintDC::~wxPaintDC()
+wxPaintDCImpl::~wxPaintDCImpl()
{
if ( m_hDC )
{
+ SelectOldObjects(m_hDC);
+
size_t index;
wxPaintDCInfo *info = FindInCache(&index);
- wxCHECK_RET( info, _T("existing DC should have a cache entry") );
+ wxCHECK_RET( info, wxT("existing DC should have a cache entry") );
- if ( !--info->count )
+ if ( --info->count == 0 )
{
- ::EndPaint(GetWinHwnd(m_canvas), &g_paintStruct);
+ ::EndPaint(GetHwndOf(m_window), &g_paintStruct);
+
+ ms_cache.RemoveAt(index);
- ms_cache.Remove(index);
+ // Reduce the number of bogus reports of non-freed memory
+ // at app exit
+ if (ms_cache.IsEmpty())
+ ms_cache.Clear();
}
//else: cached DC entry is still in use
+
+ // prevent the base class dtor from ReleaseDC()ing it again
+ m_hDC = 0;
}
}
-wxPaintDCInfo *wxPaintDC::FindInCache(size_t *index) const
+wxPaintDCInfo *wxPaintDCImpl::FindInCache(size_t *index) const
{
wxPaintDCInfo *info = 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() )
+ wxPaintDCInfo *info1 = &ms_cache[n];
+ if ( info1->hwnd == m_window->GetHWND() )
{
+ info = info1;
if ( index )
*index = n;
break;
return info;
}
+
+// find the entry for this DC in the cache (keyed by the window)
+WXHDC wxPaintDCImpl::FindDCInCache(wxWindow* win)
+{
+ size_t nCache = ms_cache.GetCount();
+ for ( size_t n = 0; n < nCache; n++ )
+ {
+ wxPaintDCInfo *info = &ms_cache[n];
+ if ( info->hwnd == win->GetHWND() )
+ {
+ return info->hdc;
+ }
+ }
+ return 0;
+}
+
+/*
+ * wxPaintDCEx
+ */
+
+// TODO: don't duplicate wxPaintDCImpl code here!!
+
+class wxPaintDCExImpl: public wxPaintDCImpl
+{
+public:
+ wxPaintDCExImpl( wxDC *owner, wxWindow *window, WXHDC dc );
+ ~wxPaintDCExImpl();
+
+ int m_saveState;
+};
+
+
+IMPLEMENT_ABSTRACT_CLASS(wxPaintDCEx,wxPaintDC)
+
+wxPaintDCEx::wxPaintDCEx(wxWindow *window, WXHDC dc)
+ : wxPaintDC(new wxPaintDCExImpl(this, window, dc))
+{
+}
+
+wxPaintDCExImpl::wxPaintDCExImpl(wxDC *owner, wxWindow *window, WXHDC dc)
+ : wxPaintDCImpl( owner )
+{
+ wxCHECK_RET( dc, wxT("wxPaintDCEx requires an existing device context") );
+
+ m_saveState = 0;
+
+ m_window = window;
+
+ wxPaintDCInfo *info = FindInCache();
+ if ( info )
+ {
+ m_hDC = info->hdc;
+ info->count++;
+ }
+ else // not in cache, create a new one
+ {
+ m_hDC = dc;
+ ms_cache.Add(new wxPaintDCInfo(m_window, this));
+ m_saveState = SaveDC((HDC) dc);
+ }
+}
+
+wxPaintDCExImpl::~wxPaintDCExImpl()
+{
+ size_t index;
+ wxPaintDCInfo *info = FindInCache(&index);
+
+ wxCHECK_RET( info, wxT("existing DC should have a cache entry") );
+
+ if ( --info->count == 0 )
+ {
+ RestoreDC((HDC) m_hDC, m_saveState);
+ ms_cache.RemoveAt(index);
+
+ // Reduce the number of bogus reports of non-freed memory
+ // at app exit
+ if (ms_cache.IsEmpty())
+ ms_cache.Clear();
+ }
+ //else: cached DC entry is still in use
+
+ // prevent the base class dtor from ReleaseDC()ing it again
+ m_hDC = 0;
+}
+
+