]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/dc.h
activating DrawRectangle optimization
[wxWidgets.git] / include / wx / msw / dc.h
CommitLineData
2bda0e17 1/////////////////////////////////////////////////////////////////////////////
ad0ac642 2// Name: wx/msw/dc.h
2bda0e17
KB
3// Purpose: wxDC class
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
bbcdf8bc 8// Copyright: (c) Julian Smart
65571936 9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
7d09b97f
VZ
12#ifndef _WX_MSW_DC_H_
13#define _WX_MSW_DC_H_
2bda0e17 14
2662e49e 15#include "wx/defs.h"
888dde65 16#include "wx/dc.h"
2662e49e 17
e6f1ad22
HH
18// ---------------------------------------------------------------------------
19// macros
20// ---------------------------------------------------------------------------
21
0cbff120
JS
22#if wxUSE_DC_CACHEING
23/*
24 * Cached blitting, maintaining a cache
25 * of bitmaps required for transparent blitting
26 * instead of constant creation/deletion
27 */
28
29class wxDCCacheEntry: public wxObject
30{
31public:
32 wxDCCacheEntry(WXHBITMAP hBitmap, int w, int h, int depth);
33 wxDCCacheEntry(WXHDC hDC, int depth);
d3c7fc99 34 virtual ~wxDCCacheEntry();
0cbff120
JS
35
36 WXHBITMAP m_bitmap;
37 WXHDC m_dc;
38 int m_width;
39 int m_height;
40 int m_depth;
41};
42#endif
43
7d09b97f
VZ
44// this is an ABC: use one of the derived classes to create a DC associated
45// with a window, screen, printer and so on
53a2db12 46class WXDLLIMPEXP_CORE wxMSWDCImpl: public wxDCImpl
2bda0e17 47{
2bda0e17 48public:
888dde65
RR
49 wxMSWDCImpl(wxDC *owner, WXHDC hDC);
50 virtual ~wxMSWDCImpl();
a23fd0e1
VZ
51
52 // implement base class pure virtuals
53 // ----------------------------------
54
55 virtual void Clear();
56
57 virtual bool StartDoc(const wxString& message);
58 virtual void EndDoc();
59
60 virtual void StartPage();
61 virtual void EndPage();
62
63 virtual void SetFont(const wxFont& font);
64 virtual void SetPen(const wxPen& pen);
65 virtual void SetBrush(const wxBrush& brush);
66 virtual void SetBackground(const wxBrush& brush);
67 virtual void SetBackgroundMode(int mode);
d275c7eb 68#if wxUSE_PALETTE
a23fd0e1 69 virtual void SetPalette(const wxPalette& palette);
d275c7eb 70#endif // wxUSE_PALETTE
a23fd0e1
VZ
71
72 virtual void DestroyClippingRegion();
73
72cdf4c9
VZ
74 virtual wxCoord GetCharHeight() const;
75 virtual wxCoord GetCharWidth() const;
a23fd0e1
VZ
76
77 virtual bool CanDrawBitmap() const;
78 virtual bool CanGetTextExtent() const;
79 virtual int GetDepth() const;
80 virtual wxSize GetPPI() const;
81
621b83d9 82
89efaf2b 83 virtual void SetMapMode(wxMappingMode mode);
a23fd0e1 84 virtual void SetUserScale(double x, double y);
a23fd0e1 85 virtual void SetLogicalScale(double x, double y);
72cdf4c9
VZ
86 virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
87 virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
a23fd0e1 88 virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
f0875501 89
e71508e1
VZ
90#if wxUSE_DC_TRANSFORM_MATRIX
91 virtual bool CanUseTransformMatrix() const;
92 virtual bool SetTransformMatrix(const wxAffineMatrix2D& matrix);
93 virtual wxAffineMatrix2D GetTransformMatrix() const;
94 virtual void ResetTransformMatrix();
95#endif // wxUSE_DC_TRANSFORM_MATRIX
96
89efaf2b 97 virtual void SetLogicalFunction(wxRasterOperationMode function);
a23fd0e1
VZ
98
99 // implementation from now on
100 // --------------------------
101
102 virtual void SetRop(WXHDC cdc);
a23fd0e1
VZ
103 virtual void SelectOldObjects(WXHDC dc);
104
b95edd47
VZ
105 void SetWindow(wxWindow *win)
106 {
888dde65 107 m_window = win;
b95edd47 108
574c939e
KB
109#if wxUSE_PALETTE
110 // if we have palettes use the correct one for this window
111 InitializePalette();
b95edd47
VZ
112#endif // wxUSE_PALETTE
113 }
a23fd0e1
VZ
114
115 WXHDC GetHDC() const { return m_hDC; }
d71cc120 116 void SetHDC(WXHDC dc, bool bOwnsDC = false)
a23fd0e1
VZ
117 {
118 m_hDC = dc;
119 m_bOwnsDC = bOwnsDC;
2e76da54
VZ
120
121 // we might have a pre existing clipping region, make sure that we
122 // return it if asked -- but avoid calling ::GetClipBox() right now as
123 // it could be unnecessary wasteful
124 m_clipping = true;
125 m_clipX1 =
126 m_clipX2 = 0;
a23fd0e1 127 }
2bda0e17 128
6d4b1e27
RD
129 void* GetHandle() const { return (void*)GetHDC(); }
130
4b7f2165
VZ
131 const wxBitmap& GetSelectedBitmap() const { return m_selectedBitmap; }
132 wxBitmap& GetSelectedBitmap() { return m_selectedBitmap; }
133
1e6feb95
VZ
134 // update the internal clip box variables
135 void UpdateClipBox();
136
0cbff120
JS
137#if wxUSE_DC_CACHEING
138 static wxDCCacheEntry* FindBitmapInCache(WXHDC hDC, int w, int h);
139 static wxDCCacheEntry* FindDCInCache(wxDCCacheEntry* notThis, WXHDC hDC);
140
141 static void AddToBitmapCache(wxDCCacheEntry* entry);
142 static void AddToDCCache(wxDCCacheEntry* entry);
143 static void ClearCache();
144#endif
145
6ae7410f
VZ
146 // RTL related functions
147 // ---------------------
148
149 // get or change the layout direction (LTR or RTL) for this dc,
150 // wxLayout_Default is returned if layout direction is not supported
151 virtual wxLayoutDirection GetLayoutDirection() const;
152 virtual void SetLayoutDirection(wxLayoutDirection dir);
153
a23fd0e1 154protected:
7d09b97f
VZ
155 void Init()
156 {
7d09b97f
VZ
157 m_bOwnsDC = false;
158 m_hDC = NULL;
159
160 m_oldBitmap = NULL;
161 m_oldPen = NULL;
162 m_oldBrush = NULL;
163 m_oldFont = NULL;
164
165#if wxUSE_PALETTE
166 m_oldPalette = NULL;
167#endif // wxUSE_PALETTE
168 }
169
170 // create an uninitialized DC: this should be only used by the derived
171 // classes
888dde65 172 wxMSWDCImpl( wxDC *owner ) : wxDCImpl( owner ) { Init(); }
7d09b97f 173
04ab8b6d
RR
174 void RealizeScaleAndOrigin();
175
512cfcc3 176public:
e29bf4b0
VZ
177 virtual void DoGetFontMetrics(int *height,
178 int *ascent,
179 int *descent,
180 int *internalLeading,
181 int *externalLeading,
182 int *averageWidth) const;
6f02a879
VZ
183 virtual void DoGetTextExtent(const wxString& string,
184 wxCoord *x, wxCoord *y,
185 wxCoord *descent = NULL,
186 wxCoord *externalLeading = NULL,
c94f845b 187 const wxFont *theFont = NULL) const;
6f02a879
VZ
188 virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
189
387ebd3e 190 virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
89efaf2b 191 wxFloodFillStyle style = wxFLOOD_SURFACE);
a23fd0e1 192
213ad8e7
VZ
193 virtual void DoGradientFillLinear(const wxRect& rect,
194 const wxColour& initialColour,
195 const wxColour& destColour,
196 wxDirection nDirection = wxEAST);
197
72cdf4c9 198 virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const;
a23fd0e1 199
72cdf4c9
VZ
200 virtual void DoDrawPoint(wxCoord x, wxCoord y);
201 virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
a23fd0e1 202
72cdf4c9
VZ
203 virtual void DoDrawArc(wxCoord x1, wxCoord y1,
204 wxCoord x2, wxCoord y2,
205 wxCoord xc, wxCoord yc);
cd9da200
VZ
206 virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
207 wxCoord width, wxCoord height);
72cdf4c9 208 virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
a23fd0e1
VZ
209 double sa, double ea);
210
72cdf4c9
VZ
211 virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
212 virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
213 wxCoord width, wxCoord height,
a23fd0e1 214 double radius);
72cdf4c9 215 virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
a23fd0e1 216
3e9db38e 217#if wxUSE_SPLINES && !defined(__WXWINCE__)
b0d7707b 218 virtual void DoDrawSpline(const wxPointList *points);
ad0ac642
WS
219#endif
220
72cdf4c9 221 virtual void DoCrossHair(wxCoord x, wxCoord y);
a23fd0e1 222
72cdf4c9
VZ
223 virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
224 virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
d71cc120 225 bool useMask = false);
a23fd0e1 226
72cdf4c9 227 virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
95724b1a
VZ
228 virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
229 double angle);
a23fd0e1 230
72cdf4c9
VZ
231 virtual bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
232 wxDC *source, wxCoord xsrc, wxCoord ysrc,
03647350 233 wxRasterOperationMode rop = wxCOPY, bool useMask = false,
89efaf2b 234 wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
a23fd0e1 235
e3b81044
VZ
236 virtual bool DoStretchBlit(wxCoord xdest, wxCoord ydest,
237 wxCoord dstWidth, wxCoord dstHeight,
238 wxDC *source,
239 wxCoord xsrc, wxCoord ysrc,
240 wxCoord srcWidth, wxCoord srcHeight,
89efaf2b 241 wxRasterOperationMode rop = wxCOPY, bool useMask = false,
e3b81044
VZ
242 wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
243
72cdf4c9
VZ
244 virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
245 wxCoord width, wxCoord height);
fdaad94e 246 virtual void DoSetDeviceClippingRegion(const wxRegion& region);
2e76da54
VZ
247 virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
248 wxCoord *w, wxCoord *h) const;
a23fd0e1 249
a23fd0e1
VZ
250 virtual void DoGetSizeMM(int* width, int* height) const;
251
252 virtual void DoDrawLines(int n, wxPoint points[],
72cdf4c9 253 wxCoord xoffset, wxCoord yoffset);
a23fd0e1 254 virtual void DoDrawPolygon(int n, wxPoint points[],
72cdf4c9 255 wxCoord xoffset, wxCoord yoffset,
89efaf2b 256 wxPolygonFillMode fillStyle = wxODDEVEN_RULE);
793db755 257 virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
6e76b35d 258 wxCoord xoffset, wxCoord yoffset,
89efaf2b 259 wxPolygonFillMode fillStyle = wxODDEVEN_RULE);
f0875501
VZ
260 virtual wxBitmap DoGetAsBitmap(const wxRect *subrect) const
261 {
262 return subrect == NULL ? GetSelectedBitmap()
263 : GetSelectedBitmap().GetSubBitmap(*subrect);
264 }
6a6c0a8b 265
a23fd0e1 266
574c939e
KB
267#if wxUSE_PALETTE
268 // MSW specific, select a logical palette into the HDC
269 // (tell windows to translate pixel from other palettes to our custom one
270 // and vice versa)
271 // Realize tells it to also reset the system palette to this one.
d71cc120 272 void DoSelectPalette(bool realize = false);
b95edd47 273
574c939e
KB
274 // Find out what palette our parent window has, then select it into the dc
275 void InitializePalette();
b95edd47
VZ
276#endif // wxUSE_PALETTE
277
512cfcc3 278protected:
4314ec48
VZ
279 // common part of DoDrawText() and DoDrawRotatedText()
280 void DrawAnyText(const wxString& text, wxCoord x, wxCoord y);
281
fdaad94e 282 // common part of DoSetClippingRegion() and DoSetDeviceClippingRegion()
5230934a
VZ
283 void SetClippingHrgn(WXHRGN hrgn);
284
7d09b97f
VZ
285 // implementation of DoGetSize() for wxScreen/PrinterDC: this simply
286 // returns the size of the entire device this DC is associated with
287 //
288 // notice that we intentionally put it in a separate function instead of
289 // DoGetSize() itself because we want it to remain pure virtual both
290 // because each derived class should take care to define it as needed (this
291 // implementation is not at all always appropriate) and because we want
292 // wxDC to be an ABC to prevent it from being created directly
293 void GetDeviceSize(int *width, int *height) const;
294
295
a23fd0e1 296 // MSW-specific member variables
1e2081a1 297 // -----------------------------
a23fd0e1
VZ
298
299 // the window associated with this DC (may be NULL)
300 wxWindow *m_canvas;
301
302 wxBitmap m_selectedBitmap;
303
304 // TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
305 bool m_bOwnsDC:1;
306
b5badcb5 307 // our HDC
a23fd0e1 308 WXHDC m_hDC;
a23fd0e1
VZ
309
310 // Store all old GDI objects when do a SelectObject, so we can select them
311 // back in (this unselecting user's objects) so we can safely delete the
312 // DC.
313 WXHBITMAP m_oldBitmap;
314 WXHPEN m_oldPen;
315 WXHBRUSH m_oldBrush;
316 WXHFONT m_oldFont;
d275c7eb
VZ
317
318#if wxUSE_PALETTE
a23fd0e1 319 WXHPALETTE m_oldPalette;
d275c7eb 320#endif // wxUSE_PALETTE
7561aacd 321
0cbff120 322#if wxUSE_DC_CACHEING
888dde65
RR
323 static wxObjectList sm_bitmapCache;
324 static wxObjectList sm_dcCache;
0cbff120
JS
325#endif
326
888dde65 327 DECLARE_CLASS(wxMSWDCImpl)
c0c133e1 328 wxDECLARE_NO_COPY_CLASS(wxMSWDCImpl);
7561aacd
VZ
329};
330
331// ----------------------------------------------------------------------------
77ffb593 332// wxDCTemp: a wxDC which doesn't free the given HDC (used by wxWidgets
7561aacd
VZ
333// only/mainly)
334// ----------------------------------------------------------------------------
335
53a2db12 336class WXDLLIMPEXP_CORE wxDCTempImpl : public wxMSWDCImpl
7561aacd
VZ
337{
338public:
e0e6ac8a
VZ
339 // construct a temporary DC with the specified HDC and size (it should be
340 // specified whenever we know it for this HDC)
888dde65
RR
341 wxDCTempImpl(wxDC *owner, WXHDC hdc, const wxSize& size )
342 : wxMSWDCImpl( owner, hdc ),
e0e6ac8a 343 m_size(size)
7d09b97f
VZ
344 {
345 }
346
888dde65 347 virtual ~wxDCTempImpl()
7d09b97f
VZ
348 {
349 // prevent base class dtor from freeing it
350 SetHDC((WXHDC)NULL);
351 }
352
353 virtual void DoGetSize(int *w, int *h) const
354 {
e0e6ac8a 355 wxASSERT_MSG( m_size.IsFullySpecified(),
9a83f860 356 wxT("size of this DC hadn't been set and is unknown") );
7d09b97f
VZ
357
358 if ( w )
e0e6ac8a 359 *w = m_size.x;
7d09b97f 360 if ( h )
e0e6ac8a 361 *h = m_size.y;
7d09b97f 362 }
fc7a2a60
VZ
363
364private:
e0e6ac8a
VZ
365 // size of this DC must be explicitly set by SetSize() as we have no way to
366 // find it ourselves
367 const wxSize m_size;
368
c0c133e1 369 wxDECLARE_NO_COPY_CLASS(wxDCTempImpl);
2bda0e17
KB
370};
371
53a2db12 372class WXDLLIMPEXP_CORE wxDCTemp : public wxDC
888dde65
RR
373{
374public:
f0875501
VZ
375 wxDCTemp(WXHDC hdc, const wxSize& size = wxDefaultSize)
376 : wxDC(new wxDCTempImpl(this, hdc, size))
888dde65 377 {
888dde65 378 }
888dde65
RR
379};
380
7d09b97f
VZ
381#endif // _WX_MSW_DC_H_
382