Doc fixes A-M edition. Thanks to Arnout for pointing these out. Also I fixed some...

[wxWidgets.git] / include / wx / dcbuffer.h

diff --git a/include/wx/dcbuffer.h b/include/wx/dcbuffer.h
index 7cf03a4a66d969b38d8f1b2e2863f2cf9702d63c..9cd95e0ac3e2e2f048051352ea63c62292146317 100644 (file)
--- a/include/wx/dcbuffer.h
+++ b/include/wx/dcbuffer.h
@@ -12,32 +12,15 @@
 #ifndef _WX_DCBUFFER_H_
 #define _WX_DCBUFFER_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "dcbuffer.h"
-#endif
-
 #include "wx/dcmemory.h"
 #include "wx/dcclient.h"
-
-// flags for wxBufferedDC ctor/Init()
-enum
-{
-    // this is more efficient and hence default
-    wxBUFFER_DC_OVERWRITE_BG = 0,
-
-    // preserve the old background: more time consuming
-    wxBUFFER_DC_PRESERVE_BG = 1,
-
-
-    // flags used by default
-    wxBUFFER_DC_DEFAULT = wxBUFFER_DC_PRESERVE_BG
-};
+#include "wx/window.h"
 
 // ----------------------------------------------------------------------------
 // Double buffering helper.
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_ADV wxBufferedDC : public wxMemoryDC
+class wxBufferedDC : public wxMemoryDC
 {
 public:
     // Default ctor, must subsequently call Init for two stage construction.
@@ -46,22 +29,46 @@ public:
     }
 
     // Construct a wxBufferedDC using a user supplied buffer.
-    wxBufferedDC(wxDC *dc, const wxBitmap &buffer);
+    wxBufferedDC(wxDC *dc, const wxBitmap &buffer)
+        : m_dc( dc ),
+          m_buffer( buffer )
+    {
+        UseBuffer();
+    }
 
     // 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 flags = wxBUFFER_DC_DEFAULT);
+    wxBufferedDC(wxDC *dc, const wxSize &area)
+        : m_dc( dc ),
+          m_buffer( area.GetWidth(), area.GetHeight() )
+    {
+        UseBuffer();
+    }
 
     // default copy ctor ok.
 
     // The usually desired  action in the dtor is to blit the buffer.
-    virtual ~wxBufferedDC() { if ( m_dc ) UnMask(); }
+    virtual ~wxBufferedDC()
+    {
+        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.
-    void Init(wxDC *dc, const wxBitmap &bitmap);
-    void Init(wxDC *dc, const wxSize &area, int flags = wxBUFFER_DC_DEFAULT);
+    void Init(wxDC *dc, const wxBitmap &buffer)
+    {
+        wxASSERT_MSG( m_dc == 0 && m_buffer == wxNullBitmap,
+                      _T("wxBufferedDC already initialised") );
+        m_dc = dc;
+        m_buffer = buffer;
+        UseBuffer();
+    }
+
+    void Init(wxDC *dc, const wxSize &area)
+    {
+        Init(dc, wxBitmap(area.GetWidth(), area.GetHeight()));
+    }
 
     // Blits the buffer to the dc, and detaches the dc from the buffer (so it
     // can be effectively used once only).
@@ -69,7 +76,16 @@ public:
     // 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();
+    void UnMask()
+    {
+        wxASSERT_MSG( m_dc != 0,
+                      _T("No underlying DC associated with wxBufferedDC (anymore)") );
+
+        m_dc->Blit( 0, 0,
+                    m_buffer.GetWidth(), m_buffer.GetHeight(), this,
+                    0, 0 );
+        m_dc = NULL;
+    }
 
 private:
     // check that the bitmap is valid and use it
@@ -80,20 +96,15 @@ private:
         SelectObject(m_buffer);
     }
 
-    // preserve the background if necessary
-    void SaveBg(const wxSize& area, int flags)
-    {
-        if ( flags & wxBUFFER_DC_PRESERVE_BG )
-        {
-            Blit(0, 0, area.GetWidth(), area.GetHeight(), m_dc, 0, 0);
-        }
-    }
-
-    // Without the existence of a wxNullDC, this must be
-    // a pointer, else it could probably be a reference.
-    wxDC       *m_dc;
+    // the underlying DC to which we copy everything drawn on this one in
+    // UnMask()
+    //
+    // NB: Without the existence of a wxNullDC, this must be a pointer, else it
+    //     could probably be a reference.
+    wxDC *m_dc;
 
-    wxBitmap    m_buffer;
+    // the buffer (selected in this DC)
+    wxBitmap m_buffer;
 
     DECLARE_NO_COPY_CLASS(wxBufferedDC)
 };
@@ -105,25 +116,19 @@ private:
 
 // Creates a double buffered wxPaintDC, optionally allowing the
 // user to specify their own buffer to use.
-class WXDLLIMPEXP_ADV wxBufferedPaintDC : public wxBufferedDC
+class wxBufferedPaintDC : public wxBufferedDC
 {
 public:
-    // this ctor creates a bitmap of the size of the window for buffering
-    wxBufferedPaintDC(wxWindow *window, int flags = wxBUFFER_DC_DEFAULT)
+    // If no bitmap is supplied by the user, a temporary one wil; be created.
+    wxBufferedPaintDC(wxWindow *window, const wxBitmap& buffer = wxNullBitmap)
         : m_paintdc(window)
     {
-        Prepare(window);
+        window->PrepareDC( m_paintdc );
 
-        Init(&m_paintdc, window->GetClientSize(), flags);
-    }
-
-    // the bitmap must be valid here
-    wxBufferedPaintDC(wxWindow *window, const wxBitmap& buffer)
-        : m_paintdc(window)
-    {
-        Prepare(window);
-
-        Init(&m_paintdc, buffer);
+        if( buffer != wxNullBitmap )
+            Init(&m_paintdc, buffer);
+        else
+            Init(&m_paintdc, window->GetClientSize());
     }
 
     // default copy ctor ok.
@@ -136,12 +141,6 @@ public:
     }
 
 private:
-    // prepare the underlying DC
-    void Prepare(wxWindow *window)
-    {
-        window->PrepareDC(m_paintdc);
-    }
-
     wxPaintDC m_paintdc;
 
     DECLARE_NO_COPY_CLASS(wxBufferedPaintDC)