// does not prepare the window DC
#define wxBUFFER_CLIENT_AREA 0x02
-class WXDLLEXPORT wxBufferedDC : public wxMemoryDC
+// Set when not using specific buffer bitmap. Note that this
+// is private style and not returned by GetStyle.
+#define wxBUFFER_USES_SHARED_BUFFER 0x04
+
+class WXDLLIMPEXP_CORE wxBufferedDC : public wxMemoryDC
{
public:
// Default ctor, must subsequently call Init for two stage construction.
// Construct a wxBufferedDC using a user supplied buffer.
wxBufferedDC(wxDC *dc,
- const wxBitmap &buffer = wxNullBitmap,
+ wxBitmap& buffer = wxNullBitmap,
int style = wxBUFFER_CLIENT_AREA)
- : m_dc(dc),
- m_buffer(&buffer),
- m_style(style)
+ : m_dc(NULL), m_buffer(NULL)
{
- UseBuffer();
+ Init(dc, buffer, style);
}
// Construct a wxBufferedDC with an internal buffer of 'area'
// (where area is usually something like the size of the window
// being buffered)
- wxBufferedDC(wxDC *dc, const wxSize &area, int style = wxBUFFER_CLIENT_AREA)
- : m_dc(dc),
- m_buffer(NULL),
- m_style(style)
-
+ wxBufferedDC(wxDC *dc, const wxSize& area, int style = wxBUFFER_CLIENT_AREA)
+ : m_dc(NULL), m_buffer(NULL)
{
- UseBuffer(area.x, area.y);
+ Init(dc, area, style);
}
- // default copy ctor ok.
-
// The usually desired action in the dtor is to blit the buffer.
virtual ~wxBufferedDC()
{
UnMask();
}
- // These reimplement the actions of the ctors for two stage creation, but
- // are not used by the ctors themselves to save a few cpu cycles.
+ // These reimplement the actions of the ctors for two stage creation
void Init(wxDC *dc,
- const wxBitmap& buffer = wxNullBitmap,
+ wxBitmap& buffer = wxNullBitmap,
int style = wxBUFFER_CLIENT_AREA)
{
InitCommon(dc, style);
// Usually called in the dtor or by the dtor of derived classes if the
// BufferedDC must blit before the derived class (which may own the dc it's
// blitting to) is destroyed.
- void UnMask()
- {
- wxCHECK_RET( m_dc, _T("No underlying DC in wxBufferedDC") );
-
- wxCoord x = 0,
- y = 0;
-
- if ( m_style & wxBUFFER_CLIENT_AREA )
- GetDeviceOrigin(&x, &y);
-
- m_dc->Blit(0, 0, m_buffer->GetWidth(), m_buffer->GetHeight(),
- this, -x, -y );
- m_dc = NULL;
- }
+ void UnMask();
// Set and get the style
void SetStyle(int style) { m_style = style; }
- int GetStyle() const { return m_style; }
+ int GetStyle() const { return m_style & ~wxBUFFER_USES_SHARED_BUFFER; }
private:
// common part of Init()s
void InitCommon(wxDC *dc, int style)
{
- wxASSERT_MSG( !m_dc && !m_buffer, _T("wxBufferedDC already initialised") );
- wxCHECK_RET( dc, _T("can't associate NULL DC with wxBufferedDC") );
+ wxASSERT_MSG( !m_dc, wxT("wxBufferedDC already initialised") );
m_dc = dc;
m_style = style;
-
- // inherit the same layout direction as the original DC
- SetLayoutDirection(dc->GetLayoutDirection());
}
// check that the bitmap is valid and use it
// could probably be a reference.
wxDC *m_dc;
- // the buffer (selected in this DC)
- const wxBitmap *m_buffer;
+ // the buffer (selected in this DC), initially invalid
+ wxBitmap *m_buffer;
// the buffering style
int m_style;
+ wxSize m_area;
+
DECLARE_DYNAMIC_CLASS(wxBufferedDC)
- DECLARE_NO_COPY_CLASS(wxBufferedDC)
+ wxDECLARE_NO_COPY_CLASS(wxBufferedDC);
};
// Creates a double buffered wxPaintDC, optionally allowing the
// user to specify their own buffer to use.
-class WXDLLEXPORT wxBufferedPaintDC : public wxBufferedDC
+class WXDLLIMPEXP_CORE wxBufferedPaintDC : public wxBufferedDC
{
public:
// If no bitmap is supplied by the user, a temporary one will be created.
- wxBufferedPaintDC(wxWindow *window, const wxBitmap& buffer, int style = wxBUFFER_CLIENT_AREA)
+ wxBufferedPaintDC(wxWindow *window, wxBitmap& buffer, int style = wxBUFFER_CLIENT_AREA)
: m_paintdc(window)
{
// If we're buffering the virtual window, scale the paint DC as well
if (style & wxBUFFER_VIRTUAL_AREA)
window->PrepareDC( m_paintdc );
- if( buffer != wxNullBitmap )
+ if( buffer.IsOk() )
Init(&m_paintdc, buffer, style);
else
- Init(&m_paintdc, window->GetClientSize(), style);
+ Init(&m_paintdc, GetBufferedSize(window, style), style);
}
// If no bitmap is supplied by the user, a temporary one will be created.
if (style & wxBUFFER_VIRTUAL_AREA)
window->PrepareDC( m_paintdc );
- Init(&m_paintdc, window->GetClientSize(), style);
+ Init(&m_paintdc, GetBufferedSize(window, style), style);
}
// default copy ctor ok.
UnMask();
}
+protected:
+ // return the size needed by the buffer: this depends on whether we're
+ // buffering just the currently shown part or the total (scrolled) window
+ static wxSize GetBufferedSize(wxWindow *window, int style)
+ {
+ return style & wxBUFFER_VIRTUAL_AREA ? window->GetVirtualSize()
+ : window->GetClientSize();
+ }
+
private:
wxPaintDC m_paintdc;
DECLARE_ABSTRACT_CLASS(wxBufferedPaintDC)
- DECLARE_NO_COPY_CLASS(wxBufferedPaintDC)
+ wxDECLARE_NO_COPY_CLASS(wxBufferedPaintDC);
};
#define wxAutoBufferedPaintDCBase wxBufferedPaintDC
#endif
-
-#ifdef __WXDEBUG__
-
-class wxAutoBufferedPaintDC : public wxAutoBufferedPaintDCBase
+class WXDLLIMPEXP_CORE wxAutoBufferedPaintDC : public wxAutoBufferedPaintDCBase
{
public:
wxAutoBufferedPaintDC(wxWindow* win)
: wxAutoBufferedPaintDCBase(win)
{
- TestWinStyle(win);
+ wxASSERT_MSG( win->GetBackgroundStyle() == wxBG_STYLE_PAINT,
+ "You need to call SetBackgroundStyle(wxBG_STYLE_PAINT) in ctor, "
+ "and also, if needed, paint the background in wxEVT_PAINT handler."
+ );
}
virtual ~wxAutoBufferedPaintDC() { }
private:
-
- void TestWinStyle(wxWindow* win)
- {
- // Help the user to get the double-buffering working properly.
- wxASSERT_MSG( win->GetBackgroundStyle() == wxBG_STYLE_CUSTOM,
- wxT("In constructor, you need to call SetBackgroundStyle(wxBG_STYLE_CUSTOM), ")
- wxT("and also, if needed, paint the background manually in the paint event handler."));
- }
-
- DECLARE_NO_COPY_CLASS(wxAutoBufferedPaintDC)
+ wxDECLARE_NO_COPY_CLASS(wxAutoBufferedPaintDC);
};
-#else // !__WXDEBUG__
-
-// In release builds, just use typedef
-typedef wxAutoBufferedPaintDCBase wxAutoBufferedPaintDC;
-
-#endif
// Check if the window is natively double buffered and will return a wxPaintDC
else
return new wxBufferedPaintDC(window);
}
-
#endif // _WX_DCBUFFER_H_