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