Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/dcbuffer.h b/interface/wx/dcbuffer.h
index ec2bb28d7000685d7a2b18345035c358b8ba1e9e..9268e437aabf174f681577af4161c06cf88af7f1 100644 (file)
--- a/interface/wx/dcbuffer.h
+++ b/interface/wx/dcbuffer.h
@@ -2,10 +2,22 @@
 // Name:        dcbuffer.h
 // Purpose:     interface of wxBufferedDC
 // Author:      wxWidgets team
 // Name:        dcbuffer.h
 // Purpose:     interface of wxBufferedDC
 // Author:      wxWidgets team

-// RCS-ID:      $Id$

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

+// 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 wxBufferedDC
 
 /**
     @class wxBufferedDC
 


@@ -105,6 +117,27 @@ public:
     void Init(wxDC* dc, wxBitmap& buffer = wxNullBitmap,
               int style = wxBUFFER_CLIENT_AREA);
     //@}
     void Init(wxDC* dc, wxBitmap& buffer = wxNullBitmap,
               int style = wxBUFFER_CLIENT_AREA);
     //@}

+
+
+    /**
+       Blits the buffer to the dc, and detaches the dc from the buffer (so it
+       can be effectively used once only).
+    
+       Usually only called in the destructor or by the destructor 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();
+
+    /**
+       Set the style.
+    */
+    void SetStyle(int style);
+
+    /**
+       Get the style.
+    */
+    int GetStyle() const;

 };
 
 
 };
 
 


@@ -115,7 +148,7 @@ public:
     This wxDC derivative can be used inside of an @c EVT_PAINT() event handler
     to achieve double-buffered drawing. Just use this class instead of
     wxPaintDC and make sure wxWindow::SetBackgroundStyle() is called with
     This wxDC derivative can be used inside of an @c EVT_PAINT() event handler
     to achieve double-buffered drawing. Just use this class instead of
     wxPaintDC and make sure wxWindow::SetBackgroundStyle() is called with

-    wxBG_STYLE_CUSTOM somewhere in the class initialization code, and that's
+    wxBG_STYLE_PAINT somewhere in the class initialization code, and that's

     all you have to do to (mostly) avoid flicker.
 
     The difference between wxBufferedPaintDC and this class is that this class
     all you have to do to (mostly) avoid flicker.
 
     The difference between wxBufferedPaintDC and this class is that this class


@@ -126,7 +159,7 @@ public:
     have native double-buffering, otherwise, it is a typedef of
     wxBufferedPaintDC.
 
     have native double-buffering, otherwise, it is a typedef of
     wxBufferedPaintDC.
 

-    @library{wxbase}
+    @library{wxcore}

     @category{dc}
 
     @see wxDC, wxBufferedPaintDC, wxPaintDC
     @category{dc}
 
     @see wxDC, wxBufferedPaintDC, wxPaintDC


@@ -141,6 +174,13 @@ public:
 };
 
 
 };
 
 

+/**
+ * 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.
+ */
+wxDC* wxAutoBufferedPaintDCFactory(wxWindow* window);
+

 
 /**
     @class wxBufferedPaintDC
 
 /**
     @class wxBufferedPaintDC


@@ -148,7 +188,7 @@ public:
     This is a subclass of wxBufferedDC which can be used inside of an
     @c EVT_PAINT() event handler to achieve double-buffered drawing. Just use
     this class instead of wxPaintDC and make sure
     This is a subclass of wxBufferedDC which can be used inside of an
     @c EVT_PAINT() event handler to achieve double-buffered drawing. Just use
     this class instead of wxPaintDC and make sure

-    wxWindow::SetBackgroundStyle() is called with wxBG_STYLE_CUSTOM somewhere
+    wxWindow::SetBackgroundStyle() is called with wxBG_STYLE_PAINT somewhere

     in the class initialization code, and that's all you have to do to (mostly)
     avoid flicker. The only thing to watch out for is that if you are using
     this class together with wxScrolled, you probably do @b not want to call
     in the class initialization code, and that's all you have to do to (mostly)
     avoid flicker. The only thing to watch out for is that if you are using
     this class together with wxScrolled, you probably do @b not want to call