]> git.saurik.com Git - wxWidgets.git/blame - include/wx/mac/dc.h
added wxLog::Suspend/Resume and wxYield() uses them now so that it won't flush
[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 170 wxFont *theFont = NULL, bool use16 = FALSE ) const ;
4765d335
SC
171 virtual void GetTextExtent( const wxString &string, int *width, int *height,
172 int *descent = NULL, int *externalLeading = NULL,
173 wxFont *theFont = NULL, bool use16 = FALSE ) const
174 {
175 long lwidth,lheight,ldescent,lexternal ;
176 GetTextExtent( string, &lwidth,&lheight,&ldescent,&lexternal,theFont,use16 ) ;
177 *width = lwidth ;
178 *height = lheight ;
179 if (descent) *descent = ldescent ;
180 if (externalLeading) *externalLeading = lexternal ;
181 }
2fc70a88
UJ
182 virtual wxCoord GetCharWidth(void) const;
183 virtual wxCoord GetCharHeight(void) const;
0dbd6262 184
519cb848 185 virtual void Clear(void);
0dbd6262 186
519cb848 187 virtual void SetFont( const wxFont &font );
0dbd6262
SC
188 virtual wxFont& GetFont(void) const { return (wxFont&) m_font; };
189
519cb848 190 virtual void SetPen( const wxPen &pen );
0dbd6262
SC
191 virtual wxPen& GetPen(void) const { return (wxPen&) m_pen; };
192
519cb848 193 virtual void SetBrush( const wxBrush &brush );
0dbd6262
SC
194 virtual wxBrush& GetBrush(void) const { return (wxBrush&) m_brush; };
195
519cb848 196 virtual void SetBackground( const wxBrush &brush );
0dbd6262
SC
197 virtual wxBrush& GetBackground(void) const { return (wxBrush&) m_backgroundBrush; };
198
519cb848 199 virtual void SetLogicalFunction( int function );
0dbd6262
SC
200 virtual int GetLogicalFunction(void) const { return m_logicalFunction; };
201
202 virtual void SetTextForeground( const wxColour &col );
203 virtual void SetTextBackground( const wxColour &col );
204 virtual wxColour& GetTextBackground(void) const { return (wxColour&)m_textBackgroundColour; };
205 virtual wxColour& GetTextForeground(void) const { return (wxColour&)m_textForegroundColour; };
206
519cb848 207 virtual void SetBackgroundMode( int mode );
0dbd6262
SC
208 virtual int GetBackgroundMode(void) const { return m_backgroundMode; };
209
519cb848 210 virtual void SetPalette( const wxPalette& palette );
0dbd6262
SC
211 void SetColourMap( const wxPalette& palette ) { SetPalette(palette); };
212
213 // the first two must be overridden and called
2fc70a88
UJ
214 virtual void SetClippingRegion( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
215 virtual void SetClippingRegion( const wxRect& rect );
0dbd6262 216 virtual void DestroyClippingRegion(void);
2fc70a88 217 virtual void GetClippingBox( wxCoord *x, wxCoord *y, wxCoord *width, wxCoord *height ) const;
0dbd6262 218 virtual void GetClippingBox( long *x, long *y, long *width, long *height ) const;
2fc70a88 219 virtual void GetClippingBox(wxRect& rect) const;
0dbd6262
SC
220
221 virtual inline long MinX(void) const { return m_minX; }
222 virtual inline long MaxX(void) const { return m_maxX; }
223 virtual inline long MinY(void) const { return m_minY; }
224 virtual inline long MaxY(void) const { return m_maxY; }
225
226 virtual void GetSize( int* width, int* height ) const;
227 inline wxSize GetSize(void) const { int w, h; GetSize(&w, &h); return wxSize(w, h); }
228 virtual void GetSizeMM( long* width, long* height ) const;
229
230 virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return TRUE; };
231 virtual void EndDoc(void) {};
232 virtual void StartPage(void) {};
233 virtual void EndPage(void) {};
234
235 virtual void SetMapMode( int mode );
236 virtual int GetMapMode(void) const { return m_mappingMode; };
237
238 virtual void SetUserScale( double x, double y );
239 virtual void GetUserScale( double *x, double *y );
240 virtual void SetLogicalScale( double x, double y );
241 virtual void GetLogicalScale( double *x, double *y );
242
243 virtual void SetLogicalOrigin( long x, long y );
244 virtual void GetLogicalOrigin( long *x, long *y );
245 virtual void SetDeviceOrigin( long x, long y );
246 virtual void GetDeviceOrigin( long *x, long *y );
247 virtual void SetInternalDeviceOrigin( long x, long y );
248 virtual void GetInternalDeviceOrigin( long *x, long *y );
249
250 virtual void SetAxisOrientation( bool xLeftRight, bool yBottomUp );
251
252 virtual void SetOptimization( bool WXUNUSED(optimize) ) {};
253 virtual bool GetOptimization(void) { return m_optimize; };
254
255 virtual long DeviceToLogicalX(long x) const;
256 virtual long DeviceToLogicalY(long y) const;
257 virtual long DeviceToLogicalXRel(long x) const;
258 virtual long DeviceToLogicalYRel(long y) const;
259 virtual long LogicalToDeviceX(long x) const;
260 virtual long LogicalToDeviceY(long y) const;
261 virtual long LogicalToDeviceXRel(long x) const;
262 virtual long LogicalToDeviceYRel(long y) const;
263
264 public:
265
266 void CalcBoundingBox( long x, long y );
267 void ComputeScaleAndOrigin(void);
268
269 long XDEV2LOG(long x) const
270 {
271 long new_x = x - m_deviceOriginX;
272 if (new_x > 0)
273 return (long)((double)(new_x) / m_scaleX + 0.5) * m_signX + m_logicalOriginX;
274 else
275 return (long)((double)(new_x) / m_scaleX - 0.5) * m_signX + m_logicalOriginX;
276 }
277 long XDEV2LOGREL(long x) const
278 {
279 if (x > 0)
280 return (long)((double)(x) / m_scaleX + 0.5);
281 else
282 return (long)((double)(x) / m_scaleX - 0.5);
283 }
284 long YDEV2LOG(long y) const
285 {
286 long new_y = y - m_deviceOriginY;
287 if (new_y > 0)
288 return (long)((double)(new_y) / m_scaleY + 0.5) * m_signY + m_logicalOriginY;
289 else
290 return (long)((double)(new_y) / m_scaleY - 0.5) * m_signY + m_logicalOriginY;
291 }
292 long YDEV2LOGREL(long y) const
293 {
294 if (y > 0)
295 return (long)((double)(y) / m_scaleY + 0.5);
296 else
297 return (long)((double)(y) / m_scaleY - 0.5);
298 }
299 long XLOG2DEV(long x) const
300 {
301 long new_x = x - m_logicalOriginX;
302 if (new_x > 0)
303 return (long)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX;
304 else
305 return (long)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX;
306 }
307 long XLOG2DEVREL(long x) const
308 {
309 if (x > 0)
310 return (long)((double)(x) * m_scaleX + 0.5);
311 else
312 return (long)((double)(x) * m_scaleX - 0.5);
313 }
314 long YLOG2DEV(long y) const
315 {
316 long new_y = y - m_logicalOriginY;
317 if (new_y > 0)
318 return (long)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY;
319 else
320 return (long)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY;
321 }
322 long YLOG2DEVREL(long y) const
323 {
324 if (y > 0)
325 return (long)((double)(y) * m_scaleY + 0.5);
326 else
327 return (long)((double)(y) * m_scaleY - 0.5);
328 }
329
330 public:
331
332 bool m_ok;
333 bool m_colour;
334
335 // not sure, what these mean
336 bool m_clipping; // Is clipping on right now ?
337 bool m_isInteractive; // Is GetPixel possible ?
338 bool m_autoSetting; // wxMSW only ?
339 bool m_dontDelete; // wxMSW only ?
340 bool m_optimize; // wxMSW only ?
341 wxString m_filename; // Not sure where this belongs.
342
343 wxPen m_pen;
344 wxBrush m_brush;
345 wxBrush m_backgroundBrush;
346 wxColour m_textForegroundColour;
347 wxColour m_textBackgroundColour;
348 wxFont m_font;
349
350 int m_logicalFunction;
351 int m_backgroundMode;
352 int m_textAlignment; // gone in wxWin 2.0 ?
353
354 int m_mappingMode;
355
356 // not sure what for, but what is a mm on a screen you don't know the size of?
357 double m_mm_to_pix_x,m_mm_to_pix_y;
358
359 long m_internalDeviceOriginX,m_internalDeviceOriginY; // If un-scrolled is non-zero or
360 // d.o. changes with scrolling.
361 // Set using SetInternalDeviceOrigin().
362
363 long m_externalDeviceOriginX,m_externalDeviceOriginY; // To be set by external classes
364 // such as wxScrolledWindow
365 // using SetDeviceOrigin()
366
367 long m_deviceOriginX,m_deviceOriginY; // Sum of the two above.
368
369 long m_logicalOriginX,m_logicalOriginY; // User defined.
370
371 double m_scaleX,m_scaleY;
372 double m_logicalScaleX,m_logicalScaleY;
373 double m_userScaleX,m_userScaleY;
374 long m_signX,m_signY;
375
376 bool m_needComputeScaleX,m_needComputeScaleY; // not yet used
377
378 float m_scaleFactor; // wxPSDC wants to have this. Will disappear.
379
380 long m_clipX1,m_clipY1,m_clipX2,m_clipY2;
381 long m_minX,m_maxX,m_minY,m_maxY;
519cb848
SC
382
383//begin wxmac
384 GrafPtr m_macPort ;
8208e181 385 GWorldPtr m_macMask ;
519cb848
SC
386
387 // in order to preserve the const inheritance of the virtual functions, we have to
388 // use mutable variables starting from CWPro 5
389
390 void MacInstallFont() const ;
391 void MacInstallPen() const ;
392 void MacInstallBrush() const ;
393
394 mutable bool m_macFontInstalled ;
395 mutable bool m_macPenInstalled ;
396 mutable bool m_macBrushInstalled ;
397
398 mutable long m_macPortId ;
399 GrafPtr m_macOrigPort ;
400 Rect m_macClipRect ;
401 Point m_macLocalOrigin ;
402
403 void MacSetupPort() const ;
404 void MacVerifySetup() const { if ( m_macPortId != m_macCurrentPortId ) MacSetupPort() ; }
405
406 static long m_macCurrentPortId ;
0dbd6262
SC
407};
408
409#endif
410 // _WX_DC_H_