]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dcbuffer.h
support SDK < 10.6, fixes #14902
[wxWidgets.git] / include / wx / dcbuffer.h
index 37988bef0404d9b66afbe7c765ffd38724a03654..40cb8179cd56863608d9e27a5d9f22556ddf1261 100644 (file)
 #ifndef _WX_DCBUFFER_H_
 #define _WX_DCBUFFER_H_
 
 #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"
 #include "wx/dcmemory.h"
 #include "wx/dcclient.h"
+#include "wx/window.h"
+
+// Split platforms into two groups - those which have well-working
+// double-buffering by default, and those which do not.
+#if defined(__WXMAC__) || defined(__WXGTK20__) || defined(__WXDFB__)
+    #define wxALWAYS_NATIVE_DOUBLE_BUFFER       1
+#else
+    #define wxALWAYS_NATIVE_DOUBLE_BUFFER       0
+#endif
 
 
-// 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
-};
 
 // ----------------------------------------------------------------------------
 // Double buffering helper.
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // Double buffering helper.
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_ADV wxBufferedDC : public wxMemoryDC
+// Assumes the buffer bitmap covers the entire scrolled window,
+// and prepares the window DC accordingly
+#define wxBUFFER_VIRTUAL_AREA       0x01
+
+// Assumes the buffer bitmap only covers the client area;
+// 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 WXDLLIMPEXP_CORE wxBufferedDC : public wxMemoryDC
 {
 public:
     // Default ctor, must subsequently call Init for two stage construction.
 {
 public:
     // Default ctor, must subsequently call Init for two stage construction.
-    wxBufferedDC() : m_dc( 0 )
+    wxBufferedDC()
+        : m_dc(NULL),
+          m_buffer(NULL),
+          m_style(0)
     {
     }
 
     // Construct a wxBufferedDC using a user supplied buffer.
     {
     }
 
     // Construct a wxBufferedDC using a user supplied buffer.
-    wxBufferedDC(wxDC *dc, const wxBitmap &buffer);
+    wxBufferedDC(wxDC *dc,
+                 wxBitmap& buffer = wxNullBitmap,
+                 int style = wxBUFFER_CLIENT_AREA)
+        : m_dc(NULL), m_buffer(NULL)
+    {
+        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)
 
     // 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);
-
-    // default copy ctor ok.
+    wxBufferedDC(wxDC *dc, const wxSize& area, int style = wxBUFFER_CLIENT_AREA)
+        : m_dc(NULL), m_buffer(NULL)
+    {
+        Init(dc, area, style);
+    }
 
     // The usually desired  action in the dtor is to blit the buffer.
 
     // 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
+    void Init(wxDC *dc,
+              wxBitmap& buffer = wxNullBitmap,
+              int style = wxBUFFER_CLIENT_AREA)
+    {
+        InitCommon(dc, style);
 
 
-    // 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);
+        m_buffer = &buffer;
+
+        UseBuffer();
+    }
+
+    void Init(wxDC *dc, const wxSize &area, int style = wxBUFFER_CLIENT_AREA)
+    {
+        InitCommon(dc, style);
+
+        UseBuffer(area.x, area.y);
+    }
 
     // Blits the buffer to the dc, and detaches the dc from the buffer (so it
     // can be effectively used once only).
 
     // Blits the buffer to the dc, and detaches the dc from the buffer (so it
     // can be effectively used once only).
@@ -71,31 +104,40 @@ public:
     // blitting to) is destroyed.
     void UnMask();
 
     // blitting to) is destroyed.
     void UnMask();
 
+    // Set and get the style
+    void SetStyle(int style) { m_style = style; }
+    int GetStyle() const { return m_style & ~wxBUFFER_USES_SHARED_BUFFER; }
+
 private:
 private:
-    // check that the bitmap is valid and use it
-    void UseBuffer()
+    // common part of Init()s
+    void InitCommon(wxDC *dc, int style)
     {
     {
-        wxASSERT_MSG( m_buffer.Ok(), _T("invalid bitmap in wxBufferedDC") );
+        wxASSERT_MSG( !m_dc, wxT("wxBufferedDC already initialised") );
 
 
-        SelectObject(m_buffer);
+        m_dc = dc;
+        m_style = style;
     }
 
     }
 
-    // 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);
-        }
-    }
+    // check that the bitmap is valid and use it
+    void UseBuffer(wxCoord w = -1, wxCoord h = -1);
 
 
-    // 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;
+
+    // the buffer (selected in this DC), initially invalid
+    wxBitmap *m_buffer;
 
 
-    wxBitmap    m_buffer;
+    // the buffering style
+    int m_style;
 
 
-    DECLARE_NO_COPY_CLASS(wxBufferedDC)
+    wxSize m_area;
+    
+    DECLARE_DYNAMIC_CLASS(wxBufferedDC)
+    wxDECLARE_NO_COPY_CLASS(wxBufferedDC);
 };
 
 
 };
 
 
@@ -105,22 +147,32 @@ private:
 
 // Creates a double buffered wxPaintDC, optionally allowing the
 // user to specify their own buffer to use.
 
 // Creates a double buffered wxPaintDC, optionally allowing the
 // user to specify their own buffer to use.
-class WXDLLIMPEXP_ADV wxBufferedPaintDC : public wxBufferedDC
+class WXDLLIMPEXP_CORE wxBufferedPaintDC : public wxBufferedDC
 {
 public:
 {
 public:
-    // this ctor creates a bitmap of the size of the window for buffering
-    wxBufferedPaintDC(wxWindow *window, int flags = wxBUFFER_DC_DEFAULT)
-        : wxBufferedDC(&m_paintdc, window->GetClientSize(), flags),
-          m_paintdc(window)
+    // If no bitmap is supplied by the user, a temporary one will be created.
+    wxBufferedPaintDC(wxWindow *window, wxBitmap& buffer, int style = wxBUFFER_CLIENT_AREA)
+        : m_paintdc(window)
     {
     {
-        Prepare(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.IsOk() )
+            Init(&m_paintdc, buffer, style);
+        else
+            Init(&m_paintdc, GetBufferedSize(window, style), style);
     }
 
     }
 
-    // the bitmap must be valid here
-    wxBufferedPaintDC(wxWindow *window, const wxBitmap& buffer)
-        : wxBufferedDC(&m_paintdc, buffer)
+    // If no bitmap is supplied by the user, a temporary one will be created.
+    wxBufferedPaintDC(wxWindow *window, int style = wxBUFFER_CLIENT_AREA)
+        : m_paintdc(window)
     {
     {
-        Prepare(window);
+        // If we're using the virtual window, scale the paint DC as well
+        if (style & wxBUFFER_VIRTUAL_AREA)
+            window->PrepareDC( m_paintdc );
+
+        Init(&m_paintdc, GetBufferedSize(window, style), style);
     }
 
     // default copy ctor ok.
     }
 
     // default copy ctor ok.
@@ -132,17 +184,66 @@ public:
         UnMask();
     }
 
         UnMask();
     }
 
-private:
-    // prepare the underlying DC
-    void Prepare(wxWindow *window)
+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)
     {
     {
-        window->PrepareDC(m_paintdc);
+        return style & wxBUFFER_VIRTUAL_AREA ? window->GetVirtualSize()
+                                             : window->GetClientSize();
     }
 
     }
 
+private:
     wxPaintDC m_paintdc;
 
     wxPaintDC m_paintdc;
 
-    DECLARE_NO_COPY_CLASS(wxBufferedPaintDC)
+    DECLARE_ABSTRACT_CLASS(wxBufferedPaintDC)
+    wxDECLARE_NO_COPY_CLASS(wxBufferedPaintDC);
 };
 
 };
 
-#endif  // _WX_DCBUFFER_H_
 
 
+
+//
+// wxAutoBufferedPaintDC is a wxPaintDC in toolkits which have double-
+// buffering by default. Otherwise it is a wxBufferedPaintDC. Thus,
+// you can only expect it work with a simple constructor that
+// accepts single wxWindow* argument.
+//
+#if wxALWAYS_NATIVE_DOUBLE_BUFFER
+    #define wxAutoBufferedPaintDCBase           wxPaintDC
+#else
+    #define wxAutoBufferedPaintDCBase           wxBufferedPaintDC
+#endif
+
+class WXDLLIMPEXP_CORE wxAutoBufferedPaintDC : public wxAutoBufferedPaintDCBase
+{
+public:
+
+    wxAutoBufferedPaintDC(wxWindow* win)
+        : wxAutoBufferedPaintDCBase(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:
+    wxDECLARE_NO_COPY_CLASS(wxAutoBufferedPaintDC);
+};
+
+
+
+// Check if the window is natively double buffered and will return a wxPaintDC
+// if it is, a wxBufferedPaintDC otherwise.  It is the caller's responsibility
+// to delete the wxDC pointer when finished with it.
+inline wxDC* wxAutoBufferedPaintDCFactory(wxWindow* window)
+{
+    if ( window->IsDoubleBuffered() )
+        return new wxPaintDC(window);
+    else
+        return new wxBufferedPaintDC(window);
+}
+
+#endif  // _WX_DCBUFFER_H_