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