]>
Commit | Line | Data |
---|---|---|
9b6dbb09 JS |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: dc.h | |
3 | // Purpose: wxDC class | |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 17/09/98 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Julian Smart | |
9 | // Licence: wxWindows licence | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_DC_H_ | |
13 | #define _WX_DC_H_ | |
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 | ||
25 | //----------------------------------------------------------------------------- | |
26 | // constants | |
27 | //----------------------------------------------------------------------------- | |
28 | ||
29 | #ifndef MM_TEXT | |
30 | #define MM_TEXT 0 | |
31 | #define MM_ISOTROPIC 1 | |
32 | #define MM_ANISOTROPIC 2 | |
33 | #define MM_LOMETRIC 3 | |
34 | #define MM_HIMETRIC 4 | |
35 | #define MM_TWIPS 5 | |
36 | #define MM_POINTS 6 | |
37 | #define MM_METRIC 7 | |
38 | #endif | |
39 | ||
40 | //----------------------------------------------------------------------------- | |
41 | // global variables | |
42 | //----------------------------------------------------------------------------- | |
43 | ||
44 | extern int wxPageNumber; | |
45 | ||
46 | //----------------------------------------------------------------------------- | |
47 | // wxDC | |
48 | //----------------------------------------------------------------------------- | |
49 | ||
50 | class WXDLLEXPORT wxDC: public wxObject | |
51 | { | |
52 | DECLARE_ABSTRACT_CLASS(wxDC) | |
53 | ||
54 | public: | |
55 | ||
56 | wxDC(void); | |
57 | ~wxDC(void); | |
58 | ||
59 | void BeginDrawing(void) {}; | |
60 | void EndDrawing(void) {}; | |
61 | ||
62 | virtual bool Ok(void) const { return m_ok; }; | |
63 | ||
a367b9b3 | 64 | virtual void FloodFill( long x1, long y1, const wxColour& col, int style=wxFLOOD_SURFACE ) = 0; |
9b6dbb09 JS |
65 | inline void FloodFill(const wxPoint& pt, const wxColour& col, int style=wxFLOOD_SURFACE) |
66 | { | |
a367b9b3 | 67 | FloodFill(pt.x, pt.y, col, style); |
9b6dbb09 JS |
68 | } |
69 | ||
70 | virtual bool GetPixel( long x1, long y1, wxColour *col ) const = 0; | |
71 | inline bool GetPixel(const wxPoint& pt, wxColour *col) const | |
72 | { | |
73 | return GetPixel(pt.x, pt.y, col); | |
74 | } | |
75 | ||
76 | virtual void DrawLine( long x1, long y1, long x2, long y2 ) = 0; | |
77 | inline void DrawLine(const wxPoint& pt1, const wxPoint& pt2) | |
78 | { | |
79 | DrawLine(pt1.x, pt1.y, pt2.x, pt2.y); | |
80 | } | |
81 | ||
82 | virtual void CrossHair( long x, long y ) = 0; | |
83 | inline void CrossHair(const wxPoint& pt) | |
84 | { | |
85 | CrossHair(pt.x, pt.y); | |
86 | } | |
87 | ||
88 | virtual void DrawArc( long x1, long y1, long x2, long y2, long xc, long yc ) = 0; | |
89 | inline void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre) | |
90 | { | |
91 | DrawArc(pt1.x, pt1.y, pt2.x, pt2.y, centre.x, centre.y); | |
92 | } | |
93 | ||
94 | virtual void DrawEllipticArc( long x, long y, long width, long height, double sa, double ea ) = 0; | |
95 | virtual void DrawEllipticArc (const wxPoint& pt, const wxSize& sz, double sa, double ea) | |
96 | { | |
97 | DrawEllipticArc(pt.x, pt.y, sz.x, sz.y, sa, ea); | |
98 | } | |
99 | ||
100 | virtual void DrawPoint( long x, long y ) = 0; | |
101 | virtual void DrawPoint( wxPoint& point ); | |
102 | ||
103 | virtual void DrawLines( int n, wxPoint points[], long xoffset = 0, long yoffset = 0 ) = 0; | |
104 | virtual void DrawLines( wxList *points, long xoffset = 0, long yoffset = 0 ); | |
105 | virtual void DrawPolygon( int n, wxPoint points[], long xoffset = 0, long yoffset = 0, | |
106 | int fillStyle=wxODDEVEN_RULE ) = 0; | |
107 | virtual void DrawPolygon( wxList *lines, long xoffset = 0, long yoffset = 0, | |
108 | int fillStyle=wxODDEVEN_RULE ); | |
109 | ||
110 | virtual void DrawRectangle( long x, long y, long width, long height ) = 0; | |
111 | inline void DrawRectangle(const wxPoint& pt, const wxSize& sz) | |
112 | { | |
113 | DrawRectangle(pt.x, pt.y, sz.x, sz.y); | |
114 | } | |
115 | inline void DrawRectangle(const wxRect& rect) | |
116 | { | |
117 | DrawRectangle(rect.x, rect.y, rect.width, rect.height); | |
118 | } | |
119 | virtual void DrawRoundedRectangle( long x, long y, long width, long height, double radius = 20.0 ) = 0; | |
120 | inline void DrawRoundedRectangle(const wxPoint& pt, const wxSize& sz, double radius = 20.0) | |
121 | { | |
122 | DrawRoundedRectangle(pt.x, pt.y, sz.x, sz.y, radius); | |
123 | } | |
124 | inline void DrawRoundedRectangle(const wxRect& rect, double radius = 20.0) | |
125 | { | |
126 | DrawRoundedRectangle(rect.x, rect.y, rect.width, rect.height, radius); | |
127 | } | |
128 | ||
129 | virtual void DrawEllipse( long x, long y, long width, long height ) = 0; | |
130 | inline void DrawEllipse(const wxPoint& pt, const wxSize& sz) | |
131 | { | |
132 | DrawEllipse(pt.x, pt.y, sz.x, sz.y); | |
133 | } | |
134 | inline void DrawEllipse(const wxRect& rect) | |
135 | { | |
136 | DrawEllipse(rect.x, rect.y, rect.width, rect.height); | |
137 | } | |
138 | ||
139 | virtual void DrawSpline( long x1, long y1, long x2, long y2, long x3, long y3 ); | |
dfad0599 | 140 | virtual void DrawSpline( wxList *points ) = 0; |
9b6dbb09 JS |
141 | virtual void DrawSpline( int n, wxPoint points[] ); |
142 | ||
143 | virtual bool CanDrawBitmap(void) const = 0; | |
144 | ||
145 | virtual void DrawIcon( const wxIcon &icon, long x, long y, bool useMask=FALSE ); | |
146 | inline void DrawIcon(const wxIcon& icon, const wxPoint& pt) | |
147 | { | |
148 | DrawIcon(icon, pt.x, pt.y); | |
149 | } | |
150 | ||
a367b9b3 | 151 | // DrawBitmap is not always the same as DrawIcon, especially if bitmaps and |
9b6dbb09 | 152 | // icons are implemented differently. |
a367b9b3 | 153 | virtual void DrawBitmap( const wxBitmap &bmp, long x, long y, bool useMask=FALSE ) ; |
9b6dbb09 JS |
154 | |
155 | virtual bool Blit( long xdest, long ydest, long width, long height, | |
156 | wxDC *source, long xsrc, long ysrc, int logical_func = wxCOPY, bool useMask=FALSE ) = 0; | |
157 | inline bool Blit(const wxPoint& destPt, const wxSize& sz, | |
158 | wxDC *source, const wxPoint& srcPt, int rop = wxCOPY, bool useMask = FALSE) | |
159 | { | |
160 | return Blit(destPt.x, destPt.y, sz.x, sz.y, source, srcPt.x, srcPt.y, rop, useMask); | |
161 | } | |
162 | ||
163 | virtual void DrawText( const wxString &text, long x, long y, bool use16 = FALSE ) = 0; | |
164 | inline void DrawText(const wxString& text, const wxPoint& pt, bool use16bit = FALSE) | |
165 | { | |
166 | DrawText(text, pt.x, pt.y, use16bit); | |
167 | } | |
168 | ||
169 | virtual bool CanGetTextExtent(void) const = 0; | |
170 | virtual void GetTextExtent( const wxString &string, long *width, long *height, | |
171 | long *descent = NULL, long *externalLeading = NULL, | |
172 | wxFont *theFont = NULL, bool use16 = FALSE ) = 0; | |
173 | virtual long GetCharWidth(void) = 0; | |
174 | virtual long GetCharHeight(void) = 0; | |
175 | ||
176 | virtual void Clear(void) = 0; | |
177 | ||
178 | virtual void SetFont( const wxFont &font ) = 0; | |
179 | virtual wxFont *GetFont(void) const { return (wxFont*) &m_font; }; | |
180 | ||
181 | virtual void SetPen( const wxPen &pen ) = 0; | |
182 | virtual wxPen *GetPen(void) const { return (wxPen*) &m_pen; }; | |
183 | ||
184 | virtual void SetBrush( const wxBrush &brush ) = 0; | |
185 | virtual wxBrush *GetBrush(void) const { return (wxBrush*) &m_brush; }; | |
186 | ||
187 | virtual void SetBackground( const wxBrush &brush ) = 0; | |
188 | virtual wxBrush *GetBackground(void) const { return (wxBrush*) &m_backgroundBrush; }; | |
189 | ||
190 | virtual void SetLogicalFunction( int function ) = 0; | |
191 | virtual int GetLogicalFunction(void) const { return m_logicalFunction; }; | |
192 | ||
193 | virtual void SetTextForeground( const wxColour &col ); | |
194 | virtual void SetTextBackground( const wxColour &col ); | |
195 | virtual wxColour& GetTextBackground(void) const { return (wxColour&)m_textBackgroundColour; }; | |
196 | virtual wxColour& GetTextForeground(void) const { return (wxColour&)m_textForegroundColour; }; | |
197 | ||
198 | virtual void SetBackgroundMode( int mode ) = 0; | |
199 | virtual int GetBackgroundMode(void) const { return m_backgroundMode; }; | |
200 | ||
201 | virtual void SetPalette( const wxPalette& palette ) = 0; | |
202 | void SetColourMap( const wxPalette& palette ) { SetPalette(palette); }; | |
203 | ||
204 | // the first two must be overridden and called | |
205 | virtual void SetClippingRegion( long x, long y, long width, long height ); | |
206 | virtual void DestroyClippingRegion(void); | |
207 | virtual void GetClippingBox( long *x, long *y, long *width, long *height ) const; | |
208 | ||
209 | virtual inline long MinX(void) const { return m_minX; } | |
210 | virtual inline long MaxX(void) const { return m_maxX; } | |
211 | virtual inline long MinY(void) const { return m_minY; } | |
212 | virtual inline long MaxY(void) const { return m_maxY; } | |
213 | ||
214 | virtual void GetSize( int* width, int* height ) const; | |
215 | inline wxSize GetSize(void) const { int w, h; GetSize(&w, &h); return wxSize(w, h); } | |
216 | virtual void GetSizeMM( long* width, long* height ) const; | |
217 | ||
218 | virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return TRUE; }; | |
219 | virtual void EndDoc(void) {}; | |
220 | virtual void StartPage(void) {}; | |
221 | virtual void EndPage(void) {}; | |
222 | ||
223 | virtual void SetMapMode( int mode ); | |
224 | virtual int GetMapMode(void) const { return m_mappingMode; }; | |
225 | ||
226 | virtual void SetUserScale( double x, double y ); | |
227 | virtual void GetUserScale( double *x, double *y ); | |
228 | virtual void SetLogicalScale( double x, double y ); | |
229 | virtual void GetLogicalScale( double *x, double *y ); | |
230 | ||
231 | virtual void SetLogicalOrigin( long x, long y ); | |
232 | virtual void GetLogicalOrigin( long *x, long *y ); | |
233 | virtual void SetDeviceOrigin( long x, long y ); | |
234 | virtual void GetDeviceOrigin( long *x, long *y ); | |
235 | virtual void SetInternalDeviceOrigin( long x, long y ); | |
236 | virtual void GetInternalDeviceOrigin( long *x, long *y ); | |
237 | ||
238 | virtual void SetAxisOrientation( bool xLeftRight, bool yBottomUp ); | |
239 | ||
16c1f7f3 | 240 | virtual void SetOptimization( bool optimize ) { m_optimize = optimize; }; |
9b6dbb09 JS |
241 | virtual bool GetOptimization(void) { return m_optimize; }; |
242 | ||
243 | virtual long DeviceToLogicalX(long x) const; | |
244 | virtual long DeviceToLogicalY(long y) const; | |
245 | virtual long DeviceToLogicalXRel(long x) const; | |
246 | virtual long DeviceToLogicalYRel(long y) const; | |
247 | virtual long LogicalToDeviceX(long x) const; | |
248 | virtual long LogicalToDeviceY(long y) const; | |
249 | virtual long LogicalToDeviceXRel(long x) const; | |
250 | virtual long LogicalToDeviceYRel(long y) const; | |
251 | ||
252 | public: | |
253 | ||
254 | void CalcBoundingBox( long x, long y ); | |
255 | void ComputeScaleAndOrigin(void); | |
256 | ||
257 | long XDEV2LOG(long x) const | |
258 | { | |
259 | long new_x = x - m_deviceOriginX; | |
260 | if (new_x > 0) | |
261 | return (long)((double)(new_x) / m_scaleX + 0.5) * m_signX + m_logicalOriginX; | |
262 | else | |
263 | return (long)((double)(new_x) / m_scaleX - 0.5) * m_signX + m_logicalOriginX; | |
264 | } | |
265 | long XDEV2LOGREL(long x) const | |
266 | { | |
267 | if (x > 0) | |
268 | return (long)((double)(x) / m_scaleX + 0.5); | |
269 | else | |
270 | return (long)((double)(x) / m_scaleX - 0.5); | |
271 | } | |
272 | long YDEV2LOG(long y) const | |
273 | { | |
274 | long new_y = y - m_deviceOriginY; | |
275 | if (new_y > 0) | |
276 | return (long)((double)(new_y) / m_scaleY + 0.5) * m_signY + m_logicalOriginY; | |
277 | else | |
278 | return (long)((double)(new_y) / m_scaleY - 0.5) * m_signY + m_logicalOriginY; | |
279 | } | |
280 | long YDEV2LOGREL(long y) const | |
281 | { | |
282 | if (y > 0) | |
283 | return (long)((double)(y) / m_scaleY + 0.5); | |
284 | else | |
285 | return (long)((double)(y) / m_scaleY - 0.5); | |
286 | } | |
287 | long XLOG2DEV(long x) const | |
288 | { | |
289 | long new_x = x - m_logicalOriginX; | |
290 | if (new_x > 0) | |
291 | return (long)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX; | |
292 | else | |
293 | return (long)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX; | |
294 | } | |
16c1f7f3 JS |
295 | // Without device translation, for backing pixmap purposes |
296 | long XLOG2DEV_2(long x) const | |
297 | { | |
298 | long new_x = x - m_logicalOriginX; | |
299 | if (new_x > 0) | |
300 | return (long)((double)(new_x) * m_scaleX + 0.5) * m_signX; | |
301 | else | |
302 | return (long)((double)(new_x) * m_scaleX - 0.5) * m_signX; | |
303 | } | |
9b6dbb09 JS |
304 | long XLOG2DEVREL(long x) const |
305 | { | |
306 | if (x > 0) | |
307 | return (long)((double)(x) * m_scaleX + 0.5); | |
308 | else | |
309 | return (long)((double)(x) * m_scaleX - 0.5); | |
310 | } | |
311 | long YLOG2DEV(long y) const | |
312 | { | |
313 | long new_y = y - m_logicalOriginY; | |
314 | if (new_y > 0) | |
315 | return (long)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY; | |
316 | else | |
317 | return (long)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY; | |
318 | } | |
16c1f7f3 JS |
319 | // Without device translation, for backing pixmap purposes |
320 | long YLOG2DEV_2(long y) const | |
321 | { | |
322 | long new_y = y - m_logicalOriginY; | |
323 | if (new_y > 0) | |
324 | return (long)((double)(new_y) * m_scaleY + 0.5) * m_signY; | |
325 | else | |
326 | return (long)((double)(new_y) * m_scaleY - 0.5) * m_signY; | |
327 | } | |
9b6dbb09 JS |
328 | long YLOG2DEVREL(long y) const |
329 | { | |
330 | if (y > 0) | |
331 | return (long)((double)(y) * m_scaleY + 0.5); | |
332 | else | |
333 | return (long)((double)(y) * m_scaleY - 0.5); | |
334 | } | |
335 | ||
9b6dbb09 JS |
336 | public: |
337 | ||
338 | bool m_ok; | |
339 | bool m_colour; | |
340 | ||
341 | // not sure, what these mean | |
342 | bool m_clipping; // Is clipping on right now ? | |
9b6dbb09 | 343 | bool m_optimize; // wxMSW only ? |
16c1f7f3 JS |
344 | bool m_isInteractive; // For wxPostScriptDC |
345 | wxString m_filename; // Ditto | |
9b6dbb09 JS |
346 | |
347 | wxPen m_pen; | |
348 | wxBrush m_brush; | |
349 | wxBrush m_backgroundBrush; | |
350 | wxColour m_textForegroundColour; | |
351 | wxColour m_textBackgroundColour; | |
352 | wxFont m_font; | |
353 | ||
354 | int m_logicalFunction; | |
355 | int m_backgroundMode; | |
356 | int m_textAlignment; // gone in wxWin 2.0 ? | |
357 | ||
358 | int m_mappingMode; | |
359 | ||
360 | // not sure what for, but what is a mm on a screen you don't know the size of? | |
361 | double m_mm_to_pix_x,m_mm_to_pix_y; | |
362 | ||
363 | long m_internalDeviceOriginX,m_internalDeviceOriginY; // If un-scrolled is non-zero or | |
364 | // d.o. changes with scrolling. | |
365 | // Set using SetInternalDeviceOrigin(). | |
366 | ||
367 | long m_externalDeviceOriginX,m_externalDeviceOriginY; // To be set by external classes | |
368 | // such as wxScrolledWindow | |
369 | // using SetDeviceOrigin() | |
370 | ||
371 | long m_deviceOriginX,m_deviceOriginY; // Sum of the two above. | |
372 | ||
373 | long m_logicalOriginX,m_logicalOriginY; // User defined. | |
374 | ||
375 | double m_scaleX,m_scaleY; | |
376 | double m_logicalScaleX,m_logicalScaleY; | |
377 | double m_userScaleX,m_userScaleY; | |
378 | long m_signX,m_signY; | |
379 | ||
380 | bool m_needComputeScaleX,m_needComputeScaleY; // not yet used | |
381 | ||
382 | float m_scaleFactor; // wxPSDC wants to have this. Will disappear. | |
383 | ||
384 | long m_clipX1,m_clipY1,m_clipX2,m_clipY2; | |
385 | long m_minX,m_maxX,m_minY,m_maxY; | |
386 | }; | |
387 | ||
388 | #endif | |
389 | // _WX_DC_H_ |