// does not prepare the window DC
#define wxBUFFER_CLIENT_AREA 0x02
+// 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 WXDLLEXPORT wxBufferedDC : public wxMemoryDC
{
public:
// Default ctor, must subsequently call Init for two stage construction.
- wxBufferedDC() : m_dc( 0 ), m_buffer(NULL), m_style(0)
+ wxBufferedDC()
+ : m_dc(NULL),
+ m_buffer(NULL),
+ m_style(0)
{
}
// 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()
{
- if ( m_dc ) UnMask();
+ if ( m_dc )
+ 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)
{
- wxASSERT_MSG( m_dc == 0 && m_buffer == NULL,
- _T("wxBufferedDC already initialised") );
- m_dc = dc;
+ InitCommon(dc, style);
+
m_buffer = &buffer;
- m_style = style;
+
UseBuffer();
}
void Init(wxDC *dc, const wxSize &area, int style = wxBUFFER_CLIENT_AREA)
{
- wxASSERT_MSG( m_dc == 0 && m_buffer == NULL,
- _T("wxBufferedDC already initialised") );
- m_dc = dc;
- m_buffer = NULL;
- m_style = style;
+ InitCommon(dc, style);
+
UseBuffer(area.x, area.y);
}
// 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()
- {
- wxASSERT_MSG( m_dc != 0,
- _T("No underlying DC associated with wxBufferedDC (anymore)") );
-
- 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, _T("wxBufferedDC already initialised") );
+
+ m_dc = dc;
+ m_style = style;
+
+ // inherit the same layout direction as the original DC
+ if (dc && dc->IsOk())
+ SetLayoutDirection(dc->GetLayoutDirection());
+ }
+
// check that the bitmap is valid and use it
void UseBuffer(wxCoord w = -1, wxCoord h = -1);
// 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;
{
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;
else
return new wxBufferedPaintDC(window);
}
-
#endif // _WX_DCBUFFER_H_