include/wx/msw/dc.h

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