]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/dc.h
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
* Typo fix.
[wxWidgets.git] / include / wx / msw / dc.h
CommitLineData
2bda0e17
KB		 1/////////////////////////////////////////////////////////////////////////////
2// Name: dc.h
3// Purpose: wxDC class
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart and Markus Holzem
9// Licence: wxWindows license
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef __DCH__
13#define __DCH__
14
15#ifdef __GNUG__
16#pragma interface "dc.h"
17#endif
18
19#include "wx/pen.h"
20#include "wx/brush.h"
21#include "wx/icon.h"
22#include "wx/font.h"
23#include "wx/gdicmn.h"
24
25class WXDLLEXPORT wxDC: public wxObject
26{
27 DECLARE_ABSTRACT_CLASS(wxDC)
28 protected:
29public:
30 wxDC(void);
31 ~wxDC(void);
32
33 inline void wxDC::BeginDrawing(void) {}
34 inline void wxDC::EndDrawing(void) {}
35
6a6c0a8b
JS		 36 virtual void FloodFill(long x1, long y1, const wxColour& col, int style=wxFLOOD_SURFACE) ;
37 inline void FloodFill(const wxPoint& pt, const wxColour& col, int style=wxFLOOD_SURFACE)
38 {
39 FloodFill(pt.x, pt.y, col, style);
40 }
41
2bda0e17 42 virtual bool GetPixel(long x1, long y1, wxColour *col) const ;
6a6c0a8b
JS		 43 inline bool GetPixel(const wxPoint& pt, wxColour *col) const
44 {
45 return GetPixel(pt.x, pt.y, col);
46 }
2bda0e17
KB		 47
48 virtual void DrawLine(long x1, long y1, long x2, long y2);
6a6c0a8b
JS		 49 inline void DrawLine(const wxPoint& pt1, const wxPoint& pt2)
50 {
51 DrawLine(pt1.x, pt1.y, pt2.x, pt2.y);
52 }
53
2bda0e17 54 virtual void CrossHair(long x, long y) ;
6a6c0a8b
JS		 55 virtual void CrossHair(const wxPoint& pt)
56 {
57 CrossHair(pt.x, pt.y);
58 }
59
2bda0e17 60 virtual void DrawArc(long x1,long y1,long x2,long y2,double xc, double yc);
6a6c0a8b
JS		 61 inline void DrawArc(const wxPoint& pt1, const wxPoint& pt2, double xc, double yc)
62 {
63 DrawArc(pt1.x, pt1.y, pt2.x, pt2.y, xc, yc);
64 }
65
2bda0e17 66 virtual void DrawEllipticArc (long x, long y, long w, long h, double sa, double ea);
6a6c0a8b
JS		 67 virtual void DrawEllipticArc (const wxPoint& pt, const wxSize& sz, double sa, double ea)
68 {
69 DrawEllipticArc(pt.x, pt.y, sz.x, sz.y, sa, ea);
70 }
71
2bda0e17 72 virtual void DrawPoint(long x, long y);
6a6c0a8b
JS		 73 inline void DrawPoint(const wxPoint& pt)
74 {
75 DrawPoint(pt.x, pt.y);
76 }
2bda0e17
KB		 77
78 virtual void DrawLines(int n, wxPoint points[], long xoffset = 0, long yoffset = 0);
79
80 virtual void DrawPolygon(int n, wxPoint points[], long xoffset = 0, long yoffset = 0, int fillStyle=wxODDEVEN_RULE);
81
82 virtual void DrawRectangle(long x, long y, long width, long height);
6a6c0a8b
JS		 83 inline void DrawRectangle(const wxPoint& pt, const wxSize& sz)
84 {
85 DrawRectangle(pt.x, pt.y, sz.x, sz.y);
86 }
87 inline void DrawRectangle(const wxRect& rect)
88 {
89 DrawRectangle(rect.x, rect.y, rect.width, rect.height);
90 }
91
2bda0e17 92 virtual void DrawRoundedRectangle(long x, long y, long width, long height, double radius = 20.0);
6a6c0a8b
JS		 93 inline void DrawRoundedRectangle(const wxPoint& pt, const wxSize& sz, double radius = 20.0)
94 {
95 DrawRoundedRectangle(pt.x, pt.y, sz.x, sz.y, radius);
96 }
97 inline void DrawRoundedRectangle(const wxRect& rect, double radius = 20.0)
98 {
99 DrawRoundedRectangle(rect.x, rect.y, rect.width, rect.height, radius);
100 }
101
2bda0e17 102 virtual void DrawEllipse(long x, long y, long width, long height);
6a6c0a8b
JS		 103 inline void DrawEllipse(const wxPoint& pt, const wxSize& sz)
104 {
105 DrawEllipse(pt.x, pt.y, sz.x, sz.y);
106 }
107 inline void DrawEllipse(const wxRect& rect)
108 {
109 DrawEllipse(rect.x, rect.y, rect.width, rect.height);
110 }
2bda0e17
KB		 111
112 virtual void DrawIcon(const wxIcon& icon, long x, long y);
6a6c0a8b
JS		 113 inline void DrawIcon(const wxIcon& icon, const wxPoint& pt)
114 {
115 DrawIcon(icon, pt.x, pt.y);
116 }
2bda0e17 117
6a6c0a8b
JS		 118 inline void DrawPoint(wxPoint& point) { DrawPoint(point.x, point.y); }
119 virtual void DrawLines(wxList *list, long xoffset = 0, long yoffset = 0);
120 virtual void DrawPolygon(wxList *list, long xoffset = 0, long yoffset = 0, int fillStyle=wxODDEVEN_RULE);
121
122 virtual void DrawText(const wxString& text, long x, long y, bool use16bit = FALSE);
123 inline void DrawText(const wxString& text, const wxPoint& pt, bool use16bit = FALSE)
124 {
125 DrawText(text, pt.x, pt.y, use16bit);
126 }
127
128 virtual bool Blit(long xdest, long ydest, long width, long height,
129 wxDC *source, long xsrc, long ysrc, int rop = wxCOPY, bool useMask = FALSE);
130 inline bool Blit(const wxPoint& destPt, const wxSize& sz,
131 wxDC *source, const wxPoint& srcPt, int rop = wxCOPY, bool useMask = FALSE)
132 {
133 return Blit(destPt.x, destPt.y, sz.x, sz.y, source, srcPt.x, srcPt.y, rop, useMask);
134 }
135
136#if USE_SPLINES
137 // Splines
138 // 3-point spline
139 virtual void DrawSpline(long x1, long y1, long x2, long y2, long x3, long y3);
140 // Any number of control points - a list of pointers to wxPoints
141 virtual void DrawSpline(wxList *points);
142 virtual void DrawSpline(int n, wxPoint points[]);
143#endif
2bda0e17
KB		 144 virtual void Clear(void);
145 virtual void SetFont(const wxFont& font);
146 virtual void SetPen(const wxPen& pen);
147 virtual void SetBrush(const wxBrush& brush);
148 virtual void SetLogicalFunction(int function);
149 virtual void SetBackground(const wxBrush& brush);
150 virtual void SetBackgroundMode(int mode);
6a6c0a8b 151
2bda0e17 152 virtual void SetClippingRegion(long x, long y, long width, long height);
6a6c0a8b
JS		 153 inline void SetClippingRegion(const wxPoint& pt, const wxSize& sz)
154 {
155 SetClippingRegion(pt.x, pt.y, sz.x, sz.y);
156 }
157 inline void SetClippingRegion(const wxRect& rect)
158 {
159 SetClippingRegion(rect.x, rect.y, rect.width, rect.height);
160 }
161
2bda0e17
KB		 162 virtual void SetPalette(const wxPalette& palette);
163#if WXWIN_COMPATIBILITY
164 virtual inline void SetColourMap(const wxPalette& palette) { SetPalette(palette); };
165#endif
166 virtual void DestroyClippingRegion(void);
2bda0e17
KB		 167 virtual long GetCharHeight(void) const;
168 virtual long GetCharWidth(void) const;
169 virtual void GetTextExtent(const wxString& string, long *x, long *y,
170 long *descent = NULL, long *externalLeading = NULL,
171 wxFont *theFont = NULL, bool use16bit = FALSE) const;
172#if WXWIN_COMPATIBILITY
173 void GetTextExtent(const wxString& string, float *x, float *y,
174 float *descent = NULL, float *externalLeading = NULL,
175 wxFont *theFont = NULL, bool use16bit = FALSE) const ;
176#endif
177
178 // Size in device units
179 virtual void GetSize(int* width, int* height) const;
180 inline wxSize GetSize(void) const { int w, h; GetSize(&w, &h); return wxSize(w, h); }
181
182 // Size in mm
183 virtual void GetSizeMM(long* width, long* height) const ;
184
185 // Compatibility
186#if WXWIN_COMPATIBILITY
187 inline void GetSize(float* width, float* height) const { int w, h; GetSize(& w, & h); *width = w; *height = h; }
188 inline void GetSizeMM(float *width, float *height) const { long w, h; GetSizeMM(& w, & h); *width = (float) w; *height = (float) h; }
189#endif
190
191 virtual bool StartDoc(const wxString& message);
192 virtual void EndDoc(void);
193 virtual void StartPage(void);
194 virtual void EndPage(void);
195 virtual void SetMapMode(int mode);
196 virtual void SetUserScale(double x, double y);
197 virtual void SetSystemScale(double x, double y);
198 virtual void SetLogicalOrigin(long x, long y);
199 virtual void SetDeviceOrigin(long x, long y);
6f65e337 200 virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
2bda0e17
KB		 201
202 // This group of functions does actual conversion
203 // of the input, as you'd expect.
204
205 long DeviceToLogicalX(long x) const;
206 long DeviceToLogicalY(long y) const;
207 long DeviceToLogicalXRel(long x) const;
208 long DeviceToLogicalYRel(long y) const;
209 long LogicalToDeviceX(long x) const;
210 long LogicalToDeviceY(long y) const;
211 long LogicalToDeviceXRel(long x) const;
212 long LogicalToDeviceYRel(long y) const;
213
214 // This group of functions may not do any conversion
215 // if m_scaleGDI is TRUE, since the HDC does the
216 // conversion automatically.
217 // m_scaleGDI NOW OBSOLETE
218 long ImplDeviceToLogicalX(long x) const;
219 long ImplDeviceToLogicalY(long y) const;
220 long ImplDeviceToLogicalXRel(long x) const;
221 long ImplDeviceToLogicalYRel(long y) const;
222 long ImplLogicalToDeviceX(long x) const;
223 long ImplLogicalToDeviceY(long y) const;
224 long ImplLogicalToDeviceXRel(long x) const;
225 long ImplLogicalToDeviceYRel(long y) const;
226
2bda0e17
KB		 227 virtual bool CanDrawBitmap(void) const;
228 virtual bool CanGetTextExtent(void) const;
229
2bda0e17
KB		 230 virtual void SetTextForeground(const wxColour& colour);
231 virtual void SetTextBackground(const wxColour& colour);
232 inline virtual bool Ok(void) const {return m_ok;};
233 inline virtual int GetMapMode(void) const {return m_mappingMode;};
234
235 inline virtual wxBrush *GetBackground(void) const { return (wxBrush*) &m_backgroundBrush ;}
236 inline virtual wxBrush *GetBrush(void) const { return (wxBrush*) &m_brush ;}
237 inline virtual wxFont *GetFont(void) const { return (wxFont*) &m_font ;}
238 inline virtual int GetLogicalFunction(void) const { return m_logicalFunction ;}
239 inline virtual wxPen *GetPen(void) const { return (wxPen*) &m_pen ;}
240 inline virtual wxColour&GetTextBackground(void) const { return (wxColour&) m_textBackgroundColour ;}
241 inline virtual wxColour&GetTextForeground(void) const { return (wxColour&) m_textForegroundColour ;}
242
243 virtual void SetLogicalScale(double x, double y);
244 virtual inline void GetUserScale(double* x, double *y) const { *x = m_userScaleX; *y = m_userScaleY; }
245 virtual void CalcBoundingBox(long x, long y);
246 // Get the final bounding box of the PostScript or Metafile picture.
247 virtual inline long MinX(void) const { return m_minX; }
248 virtual inline long MaxX(void) const { return m_maxX; }
249 virtual inline long MinY(void) const { return m_minY; }
250 virtual inline long MaxY(void) const { return m_maxY; }
251 // Sometimes we need to override optimization, e.g.
252 // if other software is drawing onto our surface and we
253 // can't be sure of who's done what.
254 virtual inline void SetOptimization(bool WXUNUSED(opt)) { }
255 virtual inline bool GetOptimization(void) { return FALSE; }
256
257 virtual void GetClippingBox(long *x,long *y,long *w,long *h) const ;
6a6c0a8b
JS		 258 inline void GetClippingBox(wxRect& rect) const
259 {
260 long x, y, w, h;
261 GetClippingBox(&x, &y, &w, &h); rect.x = x; rect.y = y; rect.width = w; rect.height = h;
262 }
2bda0e17
KB		 263
264 virtual void SetRop(WXHDC cdc);
265 virtual void DoClipping(WXHDC cdc);
266 virtual void SelectOldObjects(WXHDC dc);
267
268 inline wxWindow *GetWindow(void) const { return m_canvas; }
269 inline void SetWindow(wxWindow *win) { m_canvas = win; }
270 inline WXHDC GetHDC(void) const { return m_hDC; }
271 inline void SetHDC(WXHDC dc, bool bOwnsDC = FALSE) { m_hDC = dc; m_bOwnsDC = bOwnsDC; }
2bda0e17
KB		 272
273protected:
274 bool m_colour;
275 bool m_ok;
276 bool m_clipping;
277 bool m_isInteractive;
278
279 // Coordinate system variables
280 long m_logicalOriginX;
281 long m_logicalOriginY;
282
283 long m_deviceOriginX;
284 long m_deviceOriginY;
285
286 double m_logicalScaleX;
287 double m_logicalScaleY;
288
289 double m_userScaleX;
290 double m_userScaleY;
291
6f65e337
JS		 292 int m_signX; // Used by SetAxisOrientation() to
293 int m_signY; // invert the axes
294
2bda0e17
KB		 295 int m_mappingMode;
296
297 long m_minX; // bounding box
298 long m_minY;
299 long m_maxX;
300 long m_maxY;
301
302 int m_logicalFunction;
303 int m_backgroundMode;
304
305 wxPen m_pen;
306 wxBrush m_brush;
307 wxBrush m_backgroundBrush;
308 wxColour m_textForegroundColour;
309 wxColour m_textBackgroundColour;
310 wxFont m_font;
311 wxPalette m_palette;
2bda0e17
KB		 312 int m_clipX1;
313 int m_clipY1;
314 int m_clipX2;
315 int m_clipY2;
316// bool m_dontDelete;
317 int m_windowExtX;
318 int m_windowExtY;
319 double m_systemScaleX;
320 double m_systemScaleY;
321
322 wxWindow * m_canvas;
323 wxBitmap m_selectedBitmap;
324 wxString m_filename;
325
326 // TRUE => DeleteDC() in dtor, FALSE => only ReleaseDC() it
327 bool m_bOwnsDC;
328
329 WXHDC m_hDC;
330 int m_hDCCount;
331
332 // Store all old GDI objects when do a SelectObject,
333 // so we can select them back in (this unselecting user's
334 // objects) so we can safely delete the DC.
335 WXHBITMAP m_oldBitmap;
336 WXHPEN m_oldPen;
337 WXHBRUSH m_oldBrush;
338 WXHFONT m_oldFont;
339 WXHPALETTE m_oldPalette;
340
341 // Stores scaling, translation, rotation
342// wxTransformMatrix m_transformMatrix;
343
344 // Do we wish to scale GDI objects too, e.g. pen width?
345// bool m_scaleGDI;
346};
347
348// Logical to device
349// Absolute
350#define XLOG2DEV(x) ImplLogicalToDeviceX(x)
351
352#define YLOG2DEV(y) ImplLogicalToDeviceY(y)
353
354// Relative
355#define XLOG2DEVREL(x) ImplLogicalToDeviceXRel(x)
356#define YLOG2DEVREL(y) ImplLogicalToDeviceYRel(y)
357
358// Device to logical
359// Absolute
360#define XDEV2LOG(x) ImplDeviceToLogicalX(x)
361
362#define YDEV2LOG(y) ImplDeviceToLogicalY(y)
363
364// Relative
365#define XDEV2LOGREL(x) ImplDeviceToLogicalXRel(x)
366#define YDEV2LOGREL(y) ImplDeviceToLogicalYRel(y)
367
368/*
369 * Have the same macros as for XView but not for every operation:
370 * just for calculating window/viewport extent (a better way of scaling).
371 */
372
373// Logical to device
374// Absolute
375#define MS_XLOG2DEV(x) LogicalToDevice(x)
376
377#define MS_YLOG2DEV(y) LogicalToDevice(y)
378
379// Relative
380#define MS_XLOG2DEVREL(x) LogicalToDeviceXRel(x)
381#define MS_YLOG2DEVREL(y) LogicalToDeviceYRel(y)
382
383// Device to logical
384// Absolute
385#define MS_XDEV2LOG(x) DeviceToLogicalX(x)
386
387#define MS_YDEV2LOG(y) DeviceToLogicalY(y)
388
389// Relative
390#define MS_XDEV2LOGREL(x) DeviceToLogicalXRel(x)
391#define MS_YDEV2LOGREL(y) DeviceToLogicalYRel(y)
392
393#define MM_POINTS 7
394#define MM_METRIC 8
395
396extern int wxPageNumber;
397
398// Conversion
399#define METRIC_CONVERSION_CONSTANT 0.0393700787
400
401// Scaling factors for various unit conversions
402#define mm2inches (METRIC_CONVERSION_CONSTANT)
403#define inches2mm (1/METRIC_CONVERSION_CONSTANT)
404
405#define mm2twips (METRIC_CONVERSION_CONSTANT*1440)
406#define twips2mm (1/(METRIC_CONVERSION_CONSTANT*1440))
407
408#define mm2pt (METRIC_CONVERSION_CONSTANT*72)
409#define pt2mm (1/(METRIC_CONVERSION_CONSTANT*72))
410
411#define wx_round(a) (int)((a)+.5)
412
413
414#endif
415 // __DCH__
wxWidgets (Impactor)