Commit | Line | Data |
---|---|---|
67e2efca RL |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/dcbuffer.h | |
3 | // Purpose: wxBufferedDC class | |
4 | // Author: Ron Lee <ron@debian.org> | |
1cc8c8b7 | 5 | // Modified by: Vadim Zeitlin (refactored, added bg preservation) |
67e2efca RL |
6 | // Created: 16/03/02 |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Ron Lee | |
65571936 | 9 | // Licence: wxWindows licence |
67e2efca RL |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
12 | #ifndef _WX_DCBUFFER_H_ | |
13 | #define _WX_DCBUFFER_H_ | |
14 | ||
67e2efca | 15 | #include "wx/dcmemory.h" |
aeb500e6 | 16 | #include "wx/dcclient.h" |
d910fe28 | 17 | #include "wx/window.h" |
67e2efca | 18 | |
2e992e06 VZ |
19 | // Split platforms into two groups - those which have well-working |
20 | // double-buffering by default, and those which do not. | |
77f62aa7 | 21 | #if defined(__WXMAC__) || defined(__WXGTK20__) || defined(__WXDFB__) |
2e992e06 VZ |
22 | #define wxALWAYS_NATIVE_DOUBLE_BUFFER 1 |
23 | #else | |
24 | #define wxALWAYS_NATIVE_DOUBLE_BUFFER 0 | |
25 | #endif | |
26 | ||
27 | ||
1cc8c8b7 VZ |
28 | // ---------------------------------------------------------------------------- |
29 | // Double buffering helper. | |
30 | // ---------------------------------------------------------------------------- | |
67e2efca | 31 | |
265a3864 JS |
32 | // Assumes the buffer bitmap covers the entire scrolled window, |
33 | // and prepares the window DC accordingly | |
34 | #define wxBUFFER_VIRTUAL_AREA 0x01 | |
35 | ||
36 | // Assumes the buffer bitmap only covers the client area; | |
37 | // does not prepare the window DC | |
38 | #define wxBUFFER_CLIENT_AREA 0x02 | |
39 | ||
125817d0 VZ |
40 | // Set when not using specific buffer bitmap. Note that this |
41 | // is private style and not returned by GetStyle. | |
42 | #define wxBUFFER_USES_SHARED_BUFFER 0x04 | |
43 | ||
888dde65 | 44 | class WXDLLIMPEXP_CORE wxBufferedDC : public wxMemoryDC |
1cc8c8b7 VZ |
45 | { |
46 | public: | |
47 | // Default ctor, must subsequently call Init for two stage construction. | |
b1ed79a9 VZ |
48 | wxBufferedDC() |
49 | : m_dc(NULL), | |
3754c856 | 50 | m_buffer(NULL), |
b1ed79a9 | 51 | m_style(0) |
1cc8c8b7 VZ |
52 | { |
53 | } | |
67e2efca | 54 | |
1cc8c8b7 | 55 | // Construct a wxBufferedDC using a user supplied buffer. |
116627da | 56 | wxBufferedDC(wxDC *dc, |
3754c856 | 57 | wxBitmap& buffer = wxNullBitmap, |
116627da | 58 | int style = wxBUFFER_CLIENT_AREA) |
3754c856 | 59 | : m_dc(NULL), m_buffer(NULL) |
dbd22c6a | 60 | { |
c4a34cf8 | 61 | Init(dc, buffer, style); |
dbd22c6a | 62 | } |
67e2efca | 63 | |
1cc8c8b7 VZ |
64 | // Construct a wxBufferedDC with an internal buffer of 'area' |
65 | // (where area is usually something like the size of the window | |
66 | // being buffered) | |
c4a34cf8 | 67 | wxBufferedDC(wxDC *dc, const wxSize& area, int style = wxBUFFER_CLIENT_AREA) |
3754c856 | 68 | : m_dc(NULL), m_buffer(NULL) |
dbd22c6a | 69 | { |
c4a34cf8 | 70 | Init(dc, area, style); |
dbd22c6a | 71 | } |
67e2efca | 72 | |
1cc8c8b7 | 73 | // The usually desired action in the dtor is to blit the buffer. |
dbd22c6a RL |
74 | virtual ~wxBufferedDC() |
75 | { | |
b1ed79a9 VZ |
76 | if ( m_dc ) |
77 | UnMask(); | |
dbd22c6a | 78 | } |
67e2efca | 79 | |
c4a34cf8 | 80 | // These reimplement the actions of the ctors for two stage creation |
116627da | 81 | void Init(wxDC *dc, |
3754c856 | 82 | wxBitmap& buffer = wxNullBitmap, |
116627da | 83 | int style = wxBUFFER_CLIENT_AREA) |
dbd22c6a | 84 | { |
b1ed79a9 VZ |
85 | InitCommon(dc, style); |
86 | ||
3754c856 | 87 | m_buffer = &buffer; |
b1ed79a9 | 88 | |
dbd22c6a RL |
89 | UseBuffer(); |
90 | } | |
91 | ||
19c9f36f | 92 | void Init(wxDC *dc, const wxSize &area, int style = wxBUFFER_CLIENT_AREA) |
dbd22c6a | 93 | { |
b1ed79a9 VZ |
94 | InitCommon(dc, style); |
95 | ||
77f62aa7 | 96 | UseBuffer(area.x, area.y); |
dbd22c6a | 97 | } |
67e2efca | 98 | |
1cc8c8b7 VZ |
99 | // Blits the buffer to the dc, and detaches the dc from the buffer (so it |
100 | // can be effectively used once only). | |
101 | // | |
102 | // Usually called in the dtor or by the dtor of derived classes if the | |
103 | // BufferedDC must blit before the derived class (which may own the dc it's | |
104 | // blitting to) is destroyed. | |
125817d0 | 105 | void UnMask(); |
67e2efca | 106 | |
265a3864 JS |
107 | // Set and get the style |
108 | void SetStyle(int style) { m_style = style; } | |
125817d0 | 109 | int GetStyle() const { return m_style & ~wxBUFFER_USES_SHARED_BUFFER; } |
265a3864 | 110 | |
1cc8c8b7 | 111 | private: |
b1ed79a9 VZ |
112 | // common part of Init()s |
113 | void InitCommon(wxDC *dc, int style) | |
114 | { | |
9a83f860 | 115 | wxASSERT_MSG( !m_dc, wxT("wxBufferedDC already initialised") ); |
b1ed79a9 VZ |
116 | |
117 | m_dc = dc; | |
118 | m_style = style; | |
b1ed79a9 VZ |
119 | } |
120 | ||
19c9f36f | 121 | // check that the bitmap is valid and use it |
77f62aa7 | 122 | void UseBuffer(wxCoord w = -1, wxCoord h = -1); |
1cc8c8b7 | 123 | |
19c9f36f RD |
124 | // the underlying DC to which we copy everything drawn on this one in |
125 | // UnMask() | |
74f4dabb VZ |
126 | // |
127 | // NB: Without the existence of a wxNullDC, this must be a pointer, else it | |
128 | // could probably be a reference. | |
19c9f36f | 129 | wxDC *m_dc; |
67e2efca | 130 | |
1a9a3ce9 | 131 | // the buffer (selected in this DC), initially invalid |
3754c856 | 132 | wxBitmap *m_buffer; |
22f3361e | 133 | |
265a3864 | 134 | // the buffering style |
19c9f36f | 135 | int m_style; |
265a3864 | 136 | |
0681e07a RD |
137 | wxSize m_area; |
138 | ||
653752be | 139 | DECLARE_DYNAMIC_CLASS(wxBufferedDC) |
c0c133e1 | 140 | wxDECLARE_NO_COPY_CLASS(wxBufferedDC); |
67e2efca RL |
141 | }; |
142 | ||
143 | ||
1cc8c8b7 VZ |
144 | // ---------------------------------------------------------------------------- |
145 | // Double buffered PaintDC. | |
146 | // ---------------------------------------------------------------------------- | |
67e2efca RL |
147 | |
148 | // Creates a double buffered wxPaintDC, optionally allowing the | |
149 | // user to specify their own buffer to use. | |
888dde65 | 150 | class WXDLLIMPEXP_CORE wxBufferedPaintDC : public wxBufferedDC |
67e2efca | 151 | { |
67e2efca | 152 | public: |
265a3864 | 153 | // If no bitmap is supplied by the user, a temporary one will be created. |
3754c856 | 154 | wxBufferedPaintDC(wxWindow *window, wxBitmap& buffer, int style = wxBUFFER_CLIENT_AREA) |
a66f2f42 | 155 | : m_paintdc(window) |
1cc8c8b7 | 156 | { |
265a3864 JS |
157 | // If we're buffering the virtual window, scale the paint DC as well |
158 | if (style & wxBUFFER_VIRTUAL_AREA) | |
159 | window->PrepareDC( m_paintdc ); | |
160 | ||
55ccdb93 | 161 | if( buffer.IsOk() ) |
265a3864 | 162 | Init(&m_paintdc, buffer, style); |
dbd22c6a | 163 | else |
d38819f5 | 164 | Init(&m_paintdc, GetBufferedSize(window, style), style); |
265a3864 JS |
165 | } |
166 | ||
167 | // If no bitmap is supplied by the user, a temporary one will be created. | |
168 | wxBufferedPaintDC(wxWindow *window, int style = wxBUFFER_CLIENT_AREA) | |
169 | : m_paintdc(window) | |
170 | { | |
171 | // If we're using the virtual window, scale the paint DC as well | |
172 | if (style & wxBUFFER_VIRTUAL_AREA) | |
173 | window->PrepareDC( m_paintdc ); | |
174 | ||
d38819f5 | 175 | Init(&m_paintdc, GetBufferedSize(window, style), style); |
1cc8c8b7 | 176 | } |
67e2efca RL |
177 | |
178 | // default copy ctor ok. | |
179 | ||
1cc8c8b7 VZ |
180 | virtual ~wxBufferedPaintDC() |
181 | { | |
182 | // We must UnMask here, else by the time the base class | |
183 | // does it, the PaintDC will have already been destroyed. | |
184 | UnMask(); | |
185 | } | |
186 | ||
d38819f5 VZ |
187 | protected: |
188 | // return the size needed by the buffer: this depends on whether we're | |
189 | // buffering just the currently shown part or the total (scrolled) window | |
190 | static wxSize GetBufferedSize(wxWindow *window, int style) | |
191 | { | |
192 | return style & wxBUFFER_VIRTUAL_AREA ? window->GetVirtualSize() | |
193 | : window->GetClientSize(); | |
194 | } | |
195 | ||
1cc8c8b7 | 196 | private: |
1cc8c8b7 | 197 | wxPaintDC m_paintdc; |
fc7a2a60 | 198 | |
653752be | 199 | DECLARE_ABSTRACT_CLASS(wxBufferedPaintDC) |
c0c133e1 | 200 | wxDECLARE_NO_COPY_CLASS(wxBufferedPaintDC); |
67e2efca RL |
201 | }; |
202 | ||
67e2efca | 203 | |
2e992e06 VZ |
204 | |
205 | // | |
206 | // wxAutoBufferedPaintDC is a wxPaintDC in toolkits which have double- | |
207 | // buffering by default. Otherwise it is a wxBufferedPaintDC. Thus, | |
208 | // you can only expect it work with a simple constructor that | |
209 | // accepts single wxWindow* argument. | |
210 | // | |
211 | #if wxALWAYS_NATIVE_DOUBLE_BUFFER | |
212 | #define wxAutoBufferedPaintDCBase wxPaintDC | |
213 | #else | |
214 | #define wxAutoBufferedPaintDCBase wxBufferedPaintDC | |
215 | #endif | |
216 | ||
888dde65 | 217 | class WXDLLIMPEXP_CORE wxAutoBufferedPaintDC : public wxAutoBufferedPaintDCBase |
2e992e06 VZ |
218 | { |
219 | public: | |
220 | ||
221 | wxAutoBufferedPaintDC(wxWindow* win) | |
222 | : wxAutoBufferedPaintDCBase(win) | |
223 | { | |
9c61c5b0 VZ |
224 | wxASSERT_MSG( win->GetBackgroundStyle() == wxBG_STYLE_PAINT, |
225 | "You need to call SetBackgroundStyle(wxBG_STYLE_PAINT) in ctor, " | |
657a8a35 VZ |
226 | "and also, if needed, paint the background in wxEVT_PAINT handler." |
227 | ); | |
2e992e06 VZ |
228 | } |
229 | ||
230 | virtual ~wxAutoBufferedPaintDC() { } | |
231 | ||
232 | private: | |
c0c133e1 | 233 | wxDECLARE_NO_COPY_CLASS(wxAutoBufferedPaintDC); |
2e992e06 VZ |
234 | }; |
235 | ||
2e992e06 VZ |
236 | |
237 | ||
19c9f36f RD |
238 | // Check if the window is natively double buffered and will return a wxPaintDC |
239 | // if it is, a wxBufferedPaintDC otherwise. It is the caller's responsibility | |
240 | // to delete the wxDC pointer when finished with it. | |
241 | inline wxDC* wxAutoBufferedPaintDCFactory(wxWindow* window) | |
242 | { | |
243 | if ( window->IsDoubleBuffered() ) | |
244 | return new wxPaintDC(window); | |
245 | else | |
246 | return new wxBufferedPaintDC(window); | |
247 | } | |
19c9f36f | 248 | |
2e992e06 | 249 | #endif // _WX_DCBUFFER_H_ |