]> git.saurik.com Git - wxWidgets.git/blame - include/wx/mac/dc.h
Committing in .
[wxWidgets.git] / include / wx / mac / dc.h
CommitLineData
0dbd6262
SC
1/////////////////////////////////////////////////////////////////////////////
2// Name: dc.h
3// Purpose: wxDC class
4// Author: AUTHOR
5// Modified by:
6// Created: ??/??/98
7// RCS-ID: $Id$
8// Copyright: (c) AUTHOR
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
44extern int wxPageNumber;
45
46//-----------------------------------------------------------------------------
47// wxDC
48//-----------------------------------------------------------------------------
49
50class 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
519cb848 64 virtual void FloodFill( long x1, long y1, const wxColour& col, int style=wxFLOOD_SURFACE );
0dbd6262
SC
65 inline void FloodFill(const wxPoint& pt, const wxColour& col, int style=wxFLOOD_SURFACE)
66 {
67 FloodFill(pt.x, pt.y, col, style);
68 }
69
519cb848 70 virtual bool GetPixel( long x1, long y1, wxColour *col ) const ;
0dbd6262
SC
71 inline bool GetPixel(const wxPoint& pt, wxColour *col) const
72 {
73 return GetPixel(pt.x, pt.y, col);
74 }
75
519cb848 76 virtual void DrawLine( long x1, long y1, long x2, long y2 );
0dbd6262
SC
77 inline void DrawLine(const wxPoint& pt1, const wxPoint& pt2)
78 {
79 DrawLine(pt1.x, pt1.y, pt2.x, pt2.y);
80 }
81
519cb848 82 virtual void CrossHair( long x, long y );
0dbd6262
SC
83 inline void CrossHair(const wxPoint& pt)
84 {
85 CrossHair(pt.x, pt.y);
86 }
87
519cb848 88 virtual void DrawArc( long x1, long y1, long x2, long y2, long xc, long yc );
0dbd6262
SC
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
519cb848 94 virtual void DrawEllipticArc( long x, long y, long width, long height, double sa, double ea );
0dbd6262
SC
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
519cb848 100 virtual void DrawPoint( long x, long y );
0dbd6262
SC
101 virtual void DrawPoint( wxPoint& point );
102
519cb848 103 virtual void DrawLines( int n, wxPoint points[], long xoffset = 0, long yoffset = 0 );
0dbd6262
SC
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,
519cb848 106 int fillStyle=wxODDEVEN_RULE );
0dbd6262
SC
107 virtual void DrawPolygon( wxList *lines, long xoffset = 0, long yoffset = 0,
108 int fillStyle=wxODDEVEN_RULE );
109
519cb848 110 virtual void DrawRectangle( long x, long y, long width, long height );
0dbd6262
SC
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 }
519cb848 119 virtual void DrawRoundedRectangle( long x, long y, long width, long height, double radius = 20.0 );
0dbd6262
SC
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
519cb848 129 virtual void DrawEllipse( long x, long y, long width, long height );
0dbd6262
SC
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 );
519cb848 140 virtual void DrawSpline( wxList *points );
0dbd6262
SC
141 virtual void DrawSpline( int n, wxPoint points[] );
142
519cb848 143 virtual bool CanDrawBitmap(void) const ;
0dbd6262
SC
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
519cb848 151 void DrawBitmap( const wxBitmap &bmp, long x, long y, bool useMask=FALSE ) ;
0dbd6262
SC
152
153 virtual bool Blit( long xdest, long ydest, long width, long height,
519cb848 154 wxDC *source, long xsrc, long ysrc, int logical_func = wxCOPY, bool useMask=FALSE );
0dbd6262
SC
155 inline bool Blit(const wxPoint& destPt, const wxSize& sz,
156 wxDC *source, const wxPoint& srcPt, int rop = wxCOPY, bool useMask = FALSE)
157 {
158 return Blit(destPt.x, destPt.y, sz.x, sz.y, source, srcPt.x, srcPt.y, rop, useMask);
159 }
160
519cb848 161 virtual void DrawText( const wxString &text, long x, long y, bool use16 = FALSE );
0dbd6262
SC
162 inline void DrawText(const wxString& text, const wxPoint& pt, bool use16bit = FALSE)
163 {
164 DrawText(text, pt.x, pt.y, use16bit);
165 }
166
519cb848 167 virtual bool CanGetTextExtent(void) const ;
0dbd6262
SC
168 virtual void GetTextExtent( const wxString &string, long *width, long *height,
169 long *descent = NULL, long *externalLeading = NULL,
519cb848
SC
170 wxFont *theFont = NULL, bool use16 = FALSE ) const ;
171 virtual long GetCharWidth(void);
172 virtual long GetCharHeight(void);
0dbd6262 173
519cb848 174 virtual void Clear(void);
0dbd6262 175
519cb848 176 virtual void SetFont( const wxFont &font );
0dbd6262
SC
177 virtual wxFont& GetFont(void) const { return (wxFont&) m_font; };
178
519cb848 179 virtual void SetPen( const wxPen &pen );
0dbd6262
SC
180 virtual wxPen& GetPen(void) const { return (wxPen&) m_pen; };
181
519cb848 182 virtual void SetBrush( const wxBrush &brush );
0dbd6262
SC
183 virtual wxBrush& GetBrush(void) const { return (wxBrush&) m_brush; };
184
519cb848 185 virtual void SetBackground( const wxBrush &brush );
0dbd6262
SC
186 virtual wxBrush& GetBackground(void) const { return (wxBrush&) m_backgroundBrush; };
187
519cb848 188 virtual void SetLogicalFunction( int function );
0dbd6262
SC
189 virtual int GetLogicalFunction(void) const { return m_logicalFunction; };
190
191 virtual void SetTextForeground( const wxColour &col );
192 virtual void SetTextBackground( const wxColour &col );
193 virtual wxColour& GetTextBackground(void) const { return (wxColour&)m_textBackgroundColour; };
194 virtual wxColour& GetTextForeground(void) const { return (wxColour&)m_textForegroundColour; };
195
519cb848 196 virtual void SetBackgroundMode( int mode );
0dbd6262
SC
197 virtual int GetBackgroundMode(void) const { return m_backgroundMode; };
198
519cb848 199 virtual void SetPalette( const wxPalette& palette );
0dbd6262
SC
200 void SetColourMap( const wxPalette& palette ) { SetPalette(palette); };
201
202 // the first two must be overridden and called
203 virtual void SetClippingRegion( long x, long y, long width, long height );
204 virtual void DestroyClippingRegion(void);
205 virtual void GetClippingBox( long *x, long *y, long *width, long *height ) const;
206
207 virtual inline long MinX(void) const { return m_minX; }
208 virtual inline long MaxX(void) const { return m_maxX; }
209 virtual inline long MinY(void) const { return m_minY; }
210 virtual inline long MaxY(void) const { return m_maxY; }
211
212 virtual void GetSize( int* width, int* height ) const;
213 inline wxSize GetSize(void) const { int w, h; GetSize(&w, &h); return wxSize(w, h); }
214 virtual void GetSizeMM( long* width, long* height ) const;
215
216 virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return TRUE; };
217 virtual void EndDoc(void) {};
218 virtual void StartPage(void) {};
219 virtual void EndPage(void) {};
220
221 virtual void SetMapMode( int mode );
222 virtual int GetMapMode(void) const { return m_mappingMode; };
223
224 virtual void SetUserScale( double x, double y );
225 virtual void GetUserScale( double *x, double *y );
226 virtual void SetLogicalScale( double x, double y );
227 virtual void GetLogicalScale( double *x, double *y );
228
229 virtual void SetLogicalOrigin( long x, long y );
230 virtual void GetLogicalOrigin( long *x, long *y );
231 virtual void SetDeviceOrigin( long x, long y );
232 virtual void GetDeviceOrigin( long *x, long *y );
233 virtual void SetInternalDeviceOrigin( long x, long y );
234 virtual void GetInternalDeviceOrigin( long *x, long *y );
235
236 virtual void SetAxisOrientation( bool xLeftRight, bool yBottomUp );
237
238 virtual void SetOptimization( bool WXUNUSED(optimize) ) {};
239 virtual bool GetOptimization(void) { return m_optimize; };
240
241 virtual long DeviceToLogicalX(long x) const;
242 virtual long DeviceToLogicalY(long y) const;
243 virtual long DeviceToLogicalXRel(long x) const;
244 virtual long DeviceToLogicalYRel(long y) const;
245 virtual long LogicalToDeviceX(long x) const;
246 virtual long LogicalToDeviceY(long y) const;
247 virtual long LogicalToDeviceXRel(long x) const;
248 virtual long LogicalToDeviceYRel(long y) const;
249
250 public:
251
252 void CalcBoundingBox( long x, long y );
253 void ComputeScaleAndOrigin(void);
254
255 long XDEV2LOG(long x) const
256 {
257 long new_x = x - m_deviceOriginX;
258 if (new_x > 0)
259 return (long)((double)(new_x) / m_scaleX + 0.5) * m_signX + m_logicalOriginX;
260 else
261 return (long)((double)(new_x) / m_scaleX - 0.5) * m_signX + m_logicalOriginX;
262 }
263 long XDEV2LOGREL(long x) const
264 {
265 if (x > 0)
266 return (long)((double)(x) / m_scaleX + 0.5);
267 else
268 return (long)((double)(x) / m_scaleX - 0.5);
269 }
270 long YDEV2LOG(long y) const
271 {
272 long new_y = y - m_deviceOriginY;
273 if (new_y > 0)
274 return (long)((double)(new_y) / m_scaleY + 0.5) * m_signY + m_logicalOriginY;
275 else
276 return (long)((double)(new_y) / m_scaleY - 0.5) * m_signY + m_logicalOriginY;
277 }
278 long YDEV2LOGREL(long y) const
279 {
280 if (y > 0)
281 return (long)((double)(y) / m_scaleY + 0.5);
282 else
283 return (long)((double)(y) / m_scaleY - 0.5);
284 }
285 long XLOG2DEV(long x) const
286 {
287 long new_x = x - m_logicalOriginX;
288 if (new_x > 0)
289 return (long)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX;
290 else
291 return (long)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX;
292 }
293 long XLOG2DEVREL(long x) const
294 {
295 if (x > 0)
296 return (long)((double)(x) * m_scaleX + 0.5);
297 else
298 return (long)((double)(x) * m_scaleX - 0.5);
299 }
300 long YLOG2DEV(long y) const
301 {
302 long new_y = y - m_logicalOriginY;
303 if (new_y > 0)
304 return (long)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY;
305 else
306 return (long)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY;
307 }
308 long YLOG2DEVREL(long y) const
309 {
310 if (y > 0)
311 return (long)((double)(y) * m_scaleY + 0.5);
312 else
313 return (long)((double)(y) * m_scaleY - 0.5);
314 }
315
316 public:
317
318 bool m_ok;
319 bool m_colour;
320
321 // not sure, what these mean
322 bool m_clipping; // Is clipping on right now ?
323 bool m_isInteractive; // Is GetPixel possible ?
324 bool m_autoSetting; // wxMSW only ?
325 bool m_dontDelete; // wxMSW only ?
326 bool m_optimize; // wxMSW only ?
327 wxString m_filename; // Not sure where this belongs.
328
329 wxPen m_pen;
330 wxBrush m_brush;
331 wxBrush m_backgroundBrush;
332 wxColour m_textForegroundColour;
333 wxColour m_textBackgroundColour;
334 wxFont m_font;
335
336 int m_logicalFunction;
337 int m_backgroundMode;
338 int m_textAlignment; // gone in wxWin 2.0 ?
339
340 int m_mappingMode;
341
342 // not sure what for, but what is a mm on a screen you don't know the size of?
343 double m_mm_to_pix_x,m_mm_to_pix_y;
344
345 long m_internalDeviceOriginX,m_internalDeviceOriginY; // If un-scrolled is non-zero or
346 // d.o. changes with scrolling.
347 // Set using SetInternalDeviceOrigin().
348
349 long m_externalDeviceOriginX,m_externalDeviceOriginY; // To be set by external classes
350 // such as wxScrolledWindow
351 // using SetDeviceOrigin()
352
353 long m_deviceOriginX,m_deviceOriginY; // Sum of the two above.
354
355 long m_logicalOriginX,m_logicalOriginY; // User defined.
356
357 double m_scaleX,m_scaleY;
358 double m_logicalScaleX,m_logicalScaleY;
359 double m_userScaleX,m_userScaleY;
360 long m_signX,m_signY;
361
362 bool m_needComputeScaleX,m_needComputeScaleY; // not yet used
363
364 float m_scaleFactor; // wxPSDC wants to have this. Will disappear.
365
366 long m_clipX1,m_clipY1,m_clipX2,m_clipY2;
367 long m_minX,m_maxX,m_minY,m_maxY;
519cb848
SC
368
369//begin wxmac
370 GrafPtr m_macPort ;
371
372 // in order to preserve the const inheritance of the virtual functions, we have to
373 // use mutable variables starting from CWPro 5
374
375 void MacInstallFont() const ;
376 void MacInstallPen() const ;
377 void MacInstallBrush() const ;
378
379 mutable bool m_macFontInstalled ;
380 mutable bool m_macPenInstalled ;
381 mutable bool m_macBrushInstalled ;
382
383 mutable long m_macPortId ;
384 GrafPtr m_macOrigPort ;
385 Rect m_macClipRect ;
386 Point m_macLocalOrigin ;
387
388 void MacSetupPort() const ;
389 void MacVerifySetup() const { if ( m_macPortId != m_macCurrentPortId ) MacSetupPort() ; }
390
391 static long m_macCurrentPortId ;
0dbd6262
SC
392};
393
394#endif
395 // _WX_DC_H_