include/wx/dc.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/dc.h
   3 // Purpose:     wxDC class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     05/25/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWidgets team
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DC_H_BASE_
  13 #define _WX_DC_H_BASE_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers which we must include here
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/object.h"          // the base class
  20
  21 #include "wx/cursor.h"          // we have member variables of these classes
  22 #include "wx/font.h"            // so we can't do without them
  23 #include "wx/colour.h"
  24 #include "wx/bitmap.h"          // for wxNullBitmap
  25 #include "wx/brush.h"
  26 #include "wx/pen.h"
  27 #include "wx/palette.h"
  28 #include "wx/list.h"            // we use wxList in inline functions
  29 #include "wx/dynarray.h"
  30 #include "wx/math.h"
  31
  32 class WXDLLEXPORT wxDC;
  33 class WXDLLEXPORT wxDCBase;
  34
  35 class WXDLLEXPORT wxDrawObject
  36 {
  37 public:
  38
  39     wxDrawObject()
  40         : m_isBBoxValid(false)
  41         , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
  42     { }
  43
  44     virtual ~wxDrawObject() { }
  45
  46     virtual void Draw(wxDCBase&) const { }
  47
  48     virtual void CalcBoundingBox(wxCoord x, wxCoord y)
  49     {
  50       if ( m_isBBoxValid )
  51       {
  52          if ( x < m_minX ) m_minX = x;
  53          if ( y < m_minY ) m_minY = y;
  54          if ( x > m_maxX ) m_maxX = x;
  55          if ( y > m_maxY ) m_maxY = y;
  56       }
  57       else
  58       {
  59          m_isBBoxValid = true;
  60
  61          m_minX = x;
  62          m_minY = y;
  63          m_maxX = x;
  64          m_maxY = y;
  65       }
  66     }
  67
  68     void ResetBoundingBox()
  69     {
  70         m_isBBoxValid = false;
  71
  72         m_minX = m_maxX = m_minY = m_maxY = 0;
  73     }
  74
  75     // Get the final bounding box of the PostScript or Metafile picture.
  76
  77     wxCoord MinX() const { return m_minX; }
  78     wxCoord MaxX() const { return m_maxX; }
  79     wxCoord MinY() const { return m_minY; }
  80     wxCoord MaxY() const { return m_maxY; }
  81
  82     //to define the type of object for derived objects
  83     virtual int GetType()=0;
  84
  85 protected:
  86     //for boundingbox calculation
  87     bool m_isBBoxValid:1;
  88     //for boundingbox calculation
  89     wxCoord m_minX, m_minY, m_maxX, m_maxY;
  90 };
  91
  92 // ---------------------------------------------------------------------------
  93 // global variables
  94 // ---------------------------------------------------------------------------
  95
  96 extern WXDLLEXPORT_DATA(int) wxPageNumber;
  97
  98 // ---------------------------------------------------------------------------
  99 // wxDC is the device context - object on which any drawing is done
 100 // ---------------------------------------------------------------------------
 101
 102 class WXDLLEXPORT wxDCBase : public wxObject
 103 {
 104 public:
 105     wxDCBase()
 106         : m_colour(wxColourDisplay())
 107         , m_ok(true)
 108         , m_clipping(false)
 109         , m_isInteractive(0)
 110         , m_isBBoxValid(false)
 111         , m_logicalOriginX(0), m_logicalOriginY(0)
 112         , m_deviceOriginX(0), m_deviceOriginY(0)
 113         , m_logicalScaleX(1.0), m_logicalScaleY(1.0)
 114         , m_userScaleX(1.0), m_userScaleY(1.0)
 115         , m_scaleX(1.0), m_scaleY(1.0)
 116         , m_signX(1), m_signY(1)
 117         , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
 118         , m_clipX1(0), m_clipY1(0), m_clipX2(0), m_clipY2(0)
 119         , m_logicalFunction(wxCOPY)
 120         , m_backgroundMode(wxTRANSPARENT)
 121         , m_mappingMode(wxMM_TEXT)
 122         , m_pen()
 123         , m_brush()
 124         , m_backgroundBrush(*wxTRANSPARENT_BRUSH)
 125         , m_textForegroundColour(*wxBLACK)
 126         , m_textBackgroundColour(*wxWHITE)
 127         , m_font()
 128 #if wxUSE_PALETTE
 129         , m_palette()
 130         , m_hasCustomPalette(false)
 131 #endif // wxUSE_PALETTE
 132     {
 133         ResetBoundingBox();
 134         ResetClipping();
 135     }
 136
 137     ~wxDCBase() { }
 138
 139 #if WXWIN_COMPATIBILITY_2_6
 140     wxDEPRECATED( virtual void BeginDrawing() );
 141     wxDEPRECATED( virtual void EndDrawing() );
 142 #endif // WXWIN_COMPATIBILITY_2_6
 143
 144     // graphic primitives
 145     // ------------------
 146
 147     virtual void DrawObject(wxDrawObject* drawobject)
 148     {
 149         drawobject->Draw(*this);
 150         CalcBoundingBox(drawobject->MinX(),drawobject->MinY());
 151         CalcBoundingBox(drawobject->MaxX(),drawobject->MaxY());
 152     }
 153
 154     bool FloodFill(wxCoord x, wxCoord y, const wxColour& col,
 155                    int style = wxFLOOD_SURFACE)
 156         { return DoFloodFill(x, y, col, style); }
 157     bool FloodFill(const wxPoint& pt, const wxColour& col,
 158                    int style = wxFLOOD_SURFACE)
 159         { return DoFloodFill(pt.x, pt.y, col, style); }
 160
 161     // fill the area specified by rect with a radial gradient, starting from
 162     // initialColour in the centre of the cercle and fading to destColour.
 163     void GradientFillConcentric(const wxRect& rect,
 164                                 const wxColour& initialColour,
 165                                 const wxColour& destColour)
 166         { GradientFillConcentric(rect, initialColour, destColour,
 167                                  wxPoint(rect.GetWidth() / 2,
 168                                          rect.GetHeight() / 2)); }
 169
 170     void GradientFillConcentric(const wxRect& rect,
 171                                 const wxColour& initialColour,
 172                                 const wxColour& destColour,
 173                                 const wxPoint& circleCenter);
 174
 175     // fill the area specified by rect with a linear gradient
 176     void GradientFillLinear(const wxRect& rect,
 177                             const wxColour& initialColour,
 178                             const wxColour& destColour,
 179                             wxDirection nDirection = wxEAST)
 180         { DoGradientFillLinear(rect, initialColour, destColour, nDirection); }
 181
 182     bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const
 183         { return DoGetPixel(x, y, col); }
 184     bool GetPixel(const wxPoint& pt, wxColour *col) const
 185         { return DoGetPixel(pt.x, pt.y, col); }
 186
 187     void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2)
 188         { DoDrawLine(x1, y1, x2, y2); }
 189     void DrawLine(const wxPoint& pt1, const wxPoint& pt2)
 190         { DoDrawLine(pt1.x, pt1.y, pt2.x, pt2.y); }
 191
 192     void CrossHair(wxCoord x, wxCoord y)
 193         { DoCrossHair(x, y); }
 194     void CrossHair(const wxPoint& pt)
 195         { DoCrossHair(pt.x, pt.y); }
 196
 197     void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
 198                  wxCoord xc, wxCoord yc)
 199         { DoDrawArc(x1, y1, x2, y2, xc, yc); }
 200     void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre)
 201         { DoDrawArc(pt1.x, pt1.y, pt2.x, pt2.y, centre.x, centre.y); }
 202
 203     void DrawCheckMark(wxCoord x, wxCoord y,
 204                        wxCoord width, wxCoord height)
 205         { DoDrawCheckMark(x, y, width, height); }
 206     void DrawCheckMark(const wxRect& rect)
 207         { DoDrawCheckMark(rect.x, rect.y, rect.width, rect.height); }
 208
 209     void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 210                          double sa, double ea)
 211         { DoDrawEllipticArc(x, y, w, h, sa, ea); }
 212     void DrawEllipticArc(const wxPoint& pt, const wxSize& sz,
 213                          double sa, double ea)
 214         { DoDrawEllipticArc(pt.x, pt.y, sz.x, sz.y, sa, ea); }
 215
 216     void DrawPoint(wxCoord x, wxCoord y)
 217         { DoDrawPoint(x, y); }
 218     void DrawPoint(const wxPoint& pt)
 219         { DoDrawPoint(pt.x, pt.y); }
 220
 221     void DrawLines(int n, wxPoint points[],
 222                    wxCoord xoffset = 0, wxCoord yoffset = 0)
 223         { DoDrawLines(n, points, xoffset, yoffset); }
 224     void DrawLines(const wxList *list,
 225                    wxCoord xoffset = 0, wxCoord yoffset = 0);
 226
 227     void DrawPolygon(int n, wxPoint points[],
 228                      wxCoord xoffset = 0, wxCoord yoffset = 0,
 229                      int fillStyle = wxODDEVEN_RULE)
 230         { DoDrawPolygon(n, points, xoffset, yoffset, fillStyle); }
 231
 232     void DrawPolygon(const wxList *list,
 233                      wxCoord xoffset = 0, wxCoord yoffset = 0,
 234                      int fillStyle = wxODDEVEN_RULE);
 235
 236     void DrawPolyPolygon(int n, int count[], wxPoint points[],
 237                          wxCoord xoffset = 0, wxCoord yoffset = 0,
 238                          int fillStyle = wxODDEVEN_RULE)
 239         { DoDrawPolyPolygon(n, count, points, xoffset, yoffset, fillStyle); }
 240
 241     void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 242         { DoDrawRectangle(x, y, width, height); }
 243     void DrawRectangle(const wxPoint& pt, const wxSize& sz)
 244         { DoDrawRectangle(pt.x, pt.y, sz.x, sz.y); }
 245     void DrawRectangle(const wxRect& rect)
 246         { DoDrawRectangle(rect.x, rect.y, rect.width, rect.height); }
 247
 248     void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height,
 249                               double radius)
 250         { DoDrawRoundedRectangle(x, y, width, height, radius); }
 251     void DrawRoundedRectangle(const wxPoint& pt, const wxSize& sz,
 252                              double radius)
 253         { DoDrawRoundedRectangle(pt.x, pt.y, sz.x, sz.y, radius); }
 254     void DrawRoundedRectangle(const wxRect& r, double radius)
 255         { DoDrawRoundedRectangle(r.x, r.y, r.width, r.height, radius); }
 256
 257     void DrawCircle(wxCoord x, wxCoord y, wxCoord radius)
 258         { DoDrawEllipse(x - radius, y - radius, 2*radius, 2*radius); }
 259     void DrawCircle(const wxPoint& pt, wxCoord radius)
 260         { DrawCircle(pt.x, pt.y, radius); }
 261
 262     void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 263         { DoDrawEllipse(x, y, width, height); }
 264     void DrawEllipse(const wxPoint& pt, const wxSize& sz)
 265         { DoDrawEllipse(pt.x, pt.y, sz.x, sz.y); }
 266     void DrawEllipse(const wxRect& rect)
 267         { DoDrawEllipse(rect.x, rect.y, rect.width, rect.height); }
 268
 269     void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y)
 270         { DoDrawIcon(icon, x, y); }
 271     void DrawIcon(const wxIcon& icon, const wxPoint& pt)
 272         { DoDrawIcon(icon, pt.x, pt.y); }
 273
 274     void DrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 275                     bool useMask = false)
 276         { DoDrawBitmap(bmp, x, y, useMask); }
 277     void DrawBitmap(const wxBitmap &bmp, const wxPoint& pt,
 278                     bool useMask = false)
 279         { DoDrawBitmap(bmp, pt.x, pt.y, useMask); }
 280
 281     void DrawText(const wxString& text, wxCoord x, wxCoord y)
 282         { DoDrawText(text, x, y); }
 283     void DrawText(const wxString& text, const wxPoint& pt)
 284         { DoDrawText(text, pt.x, pt.y); }
 285
 286     void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle)
 287         { DoDrawRotatedText(text, x, y, angle); }
 288     void DrawRotatedText(const wxString& text, const wxPoint& pt, double angle)
 289         { DoDrawRotatedText(text, pt.x, pt.y, angle); }
 290
 291     // this version puts both optional bitmap and the text into the given
 292     // rectangle and aligns is as specified by alignment parameter; it also
 293     // will emphasize the character with the given index if it is != -1 and
 294     // return the bounding rectangle if required
 295     virtual void DrawLabel(const wxString& text,
 296                            const wxBitmap& image,
 297                            const wxRect& rect,
 298                            int alignment = wxALIGN_LEFT | wxALIGN_TOP,
 299                            int indexAccel = -1,
 300                            wxRect *rectBounding = NULL);
 301
 302     void DrawLabel(const wxString& text, const wxRect& rect,
 303                    int alignment = wxALIGN_LEFT | wxALIGN_TOP,
 304                    int indexAccel = -1)
 305         { DrawLabel(text, wxNullBitmap, rect, alignment, indexAccel); }
 306
 307     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 308               wxDC *source, wxCoord xsrc, wxCoord ysrc,
 309               int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord)
 310     {
 311         return DoBlit(xdest, ydest, width, height,
 312                       source, xsrc, ysrc, rop, useMask, xsrcMask, ysrcMask);
 313     }
 314     bool Blit(const wxPoint& destPt, const wxSize& sz,
 315               wxDC *source, const wxPoint& srcPt,
 316               int rop = wxCOPY, bool useMask = false, const wxPoint& srcPtMask = wxDefaultPosition)
 317     {
 318         return DoBlit(destPt.x, destPt.y, sz.x, sz.y,
 319                       source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y);
 320     }
 321
 322 #if wxUSE_SPLINES
 323     // TODO: this API needs fixing (wxPointList, why (!const) "wxList *"?)
 324     void DrawSpline(wxCoord x1, wxCoord y1,
 325                     wxCoord x2, wxCoord y2,
 326                     wxCoord x3, wxCoord y3);
 327     void DrawSpline(int n, wxPoint points[]);
 328
 329     void DrawSpline(wxList *points) { DoDrawSpline(points); }
 330 #endif // wxUSE_SPLINES
 331
 332     // Eventually we will have wxUSE_GENERIC_DRAWELLIPSE
 333 #ifdef __WXWINCE__
 334     //! Generic method to draw ellipses, circles and arcs with current pen and brush.
 335     /*! \param x Upper left corner of bounding box.
 336      *  \param y Upper left corner of bounding box.
 337      *  \param w Width of bounding box.
 338      *  \param h Height of bounding box.
 339      *  \param sa Starting angle of arc
 340      *            (counterclockwise, start at 3 o'clock, 360 is full circle).
 341      *  \param ea Ending angle of arc.
 342      *  \param angle Rotation angle, the Arc will be rotated after
 343      *               calculating begin and end.
 344      */
 345     void DrawEllipticArcRot( wxCoord x, wxCoord y,
 346                              wxCoord width, wxCoord height,
 347                              double sa = 0, double ea = 0, double angle = 0 )
 348     { DoDrawEllipticArcRot( x, y, width, height, sa, ea, angle ); }
 349
 350     void DrawEllipticArcRot( const wxPoint& pt,
 351                              const wxSize& sz,
 352                              double sa = 0, double ea = 0, double angle = 0 )
 353     { DoDrawEllipticArcRot( pt.x, pt.y, sz.x, sz.y, sa, ea, angle ); }
 354
 355     void DrawEllipticArcRot( const wxRect& rect,
 356                              double sa = 0, double ea = 0, double angle = 0 )
 357     { DoDrawEllipticArcRot( rect.x, rect.y, rect.width, rect.height, sa, ea, angle ); }
 358
 359     virtual void DoDrawEllipticArcRot( wxCoord x, wxCoord y,
 360                                        wxCoord w, wxCoord h,
 361                                        double sa = 0, double ea = 0, double angle = 0 );
 362
 363     //! Rotates points around center.
 364     /*! This is a quite straight method, it calculates in pixels
 365      *  and so it produces rounding errors.
 366      *  \param points The points inside will be rotated.
 367      *  \param angle Rotating angle (counterclockwise, start at 3 o'clock, 360 is full circle).
 368      *  \param center Center of rotation.
 369      */
 370     void Rotate( wxList* points, double angle, wxPoint center = wxPoint(0,0) );
 371
 372     // used by DrawEllipticArcRot
 373     // Careful: wxList gets filled with points you have to delete later.
 374     void CalculateEllipticPoints( wxList* points,
 375                                   wxCoord xStart, wxCoord yStart,
 376                                   wxCoord w, wxCoord h,
 377                                   double sa, double ea );
 378 #endif
 379
 380     // global DC operations
 381     // --------------------
 382
 383     virtual void Clear() = 0;
 384
 385     virtual bool StartDoc(const wxString& WXUNUSED(message)) { return true; }
 386     virtual void EndDoc() { }
 387
 388     virtual void StartPage() { }
 389     virtual void EndPage() { }
 390
 391     // set objects to use for drawing
 392     // ------------------------------
 393
 394     virtual void SetFont(const wxFont& font) = 0;
 395     virtual void SetPen(const wxPen& pen) = 0;
 396     virtual void SetBrush(const wxBrush& brush) = 0;
 397     virtual void SetBackground(const wxBrush& brush) = 0;
 398     virtual void SetBackgroundMode(int mode) = 0;
 399 #if wxUSE_PALETTE
 400     virtual void SetPalette(const wxPalette& palette) = 0;
 401 #endif // wxUSE_PALETTE
 402
 403     // clipping region
 404     // ---------------
 405
 406     void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 407         { DoSetClippingRegion(x, y, width, height); }
 408     void SetClippingRegion(const wxPoint& pt, const wxSize& sz)
 409         { DoSetClippingRegion(pt.x, pt.y, sz.x, sz.y); }
 410     void SetClippingRegion(const wxRect& rect)
 411         { DoSetClippingRegion(rect.x, rect.y, rect.width, rect.height); }
 412     void SetClippingRegion(const wxRegion& region)
 413         { DoSetClippingRegionAsRegion(region); }
 414
 415     virtual void DestroyClippingRegion() { ResetClipping(); }
 416
 417     void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *w, wxCoord *h) const
 418         { DoGetClippingBox(x, y, w, h); }
 419     void GetClippingBox(wxRect& rect) const
 420         {
 421           DoGetClippingBox(&rect.x, &rect.y, &rect.width, &rect.height);
 422         }
 423
 424     // text extent
 425     // -----------
 426
 427     virtual wxCoord GetCharHeight() const = 0;
 428     virtual wxCoord GetCharWidth() const = 0;
 429
 430     // only works for single line strings
 431     void GetTextExtent(const wxString& string,
 432                        wxCoord *x, wxCoord *y,
 433                        wxCoord *descent = NULL,
 434                        wxCoord *externalLeading = NULL,
 435                        wxFont *theFont = NULL) const
 436         { DoGetTextExtent(string, x, y, descent, externalLeading, theFont); }
 437
 438     // works for single as well as multi-line strings
 439     virtual void GetMultiLineTextExtent(const wxString& text,
 440                                         wxCoord *width,
 441                                         wxCoord *height,
 442                                         wxCoord *heightLine = NULL,
 443                                         wxFont *font = NULL);
 444
 445     // Measure cumulative width of text after each character
 446     bool GetPartialTextExtents(const wxString& text, wxArrayInt& widths) const
 447         { return DoGetPartialTextExtents(text, widths); }
 448
 449
 450     // size and resolution
 451     // -------------------
 452
 453     // in device units
 454     void GetSize(int *width, int *height) const
 455         { DoGetSize(width, height); }
 456     wxSize GetSize() const
 457     {
 458         int w, h;
 459         DoGetSize(&w, &h);
 460
 461         return wxSize(w, h);
 462     }
 463
 464     // in mm
 465     void GetSizeMM(int* width, int* height) const
 466         { DoGetSizeMM(width, height); }
 467     wxSize GetSizeMM() const
 468     {
 469         int w, h;
 470         DoGetSizeMM(&w, &h);
 471
 472         return wxSize(w, h);
 473     }
 474
 475     // coordinates conversions
 476     // -----------------------
 477
 478     // This group of functions does actual conversion of the input, as you'd
 479     // expect.
 480     wxCoord DeviceToLogicalX(wxCoord x) const;
 481     wxCoord DeviceToLogicalY(wxCoord y) const;
 482     wxCoord DeviceToLogicalXRel(wxCoord x) const;
 483     wxCoord DeviceToLogicalYRel(wxCoord y) const;
 484     wxCoord LogicalToDeviceX(wxCoord x) const;
 485     wxCoord LogicalToDeviceY(wxCoord y) const;
 486     wxCoord LogicalToDeviceXRel(wxCoord x) const;
 487     wxCoord LogicalToDeviceYRel(wxCoord y) const;
 488
 489     // query DC capabilities
 490     // ---------------------
 491
 492     virtual bool CanDrawBitmap() const = 0;
 493     virtual bool CanGetTextExtent() const = 0;
 494
 495     // colour depth
 496     virtual int GetDepth() const = 0;
 497
 498     // Resolution in Pixels per inch
 499     virtual wxSize GetPPI() const = 0;
 500
 501     virtual bool Ok() const { return m_ok; }
 502
 503     // accessors and setters
 504     // ---------------------
 505
 506     int GetBackgroundMode() const { return m_backgroundMode; }
 507     const wxBrush&  GetBackground() const { return m_backgroundBrush; }
 508     const wxBrush&  GetBrush() const { return m_brush; }
 509     const wxFont&   GetFont() const { return m_font; }
 510     const wxPen&    GetPen() const { return m_pen; }
 511
 512     const wxColour& GetTextForeground() const { return m_textForegroundColour; }
 513     const wxColour& GetTextBackground() const { return m_textBackgroundColour; }
 514     virtual void SetTextForeground(const wxColour& colour)
 515         { m_textForegroundColour = colour; }
 516     virtual void SetTextBackground(const wxColour& colour)
 517         { m_textBackgroundColour = colour; }
 518
 519     int GetMapMode() const { return m_mappingMode; }
 520     virtual void SetMapMode(int mode) = 0;
 521
 522     virtual void GetUserScale(double *x, double *y) const
 523     {
 524         if ( x ) *x = m_userScaleX;
 525         if ( y ) *y = m_userScaleY;
 526     }
 527     virtual void SetUserScale(double x, double y) = 0;
 528
 529     virtual void GetLogicalScale(double *x, double *y)
 530     {
 531         if ( x ) *x = m_logicalScaleX;
 532         if ( y ) *y = m_logicalScaleY;
 533     }
 534     virtual void SetLogicalScale(double x, double y)
 535     {
 536         m_logicalScaleX = x;
 537         m_logicalScaleY = y;
 538     }
 539
 540     void GetLogicalOrigin(wxCoord *x, wxCoord *y) const
 541         { DoGetLogicalOrigin(x, y); }
 542     wxPoint GetLogicalOrigin() const
 543         { wxCoord x, y; DoGetLogicalOrigin(&x, &y); return wxPoint(x, y); }
 544     virtual void SetLogicalOrigin(wxCoord x, wxCoord y) = 0;
 545
 546     void GetDeviceOrigin(wxCoord *x, wxCoord *y) const
 547         { DoGetDeviceOrigin(x, y); }
 548     wxPoint GetDeviceOrigin() const
 549         { wxCoord x, y; DoGetDeviceOrigin(&x, &y); return wxPoint(x, y); }
 550     virtual void SetDeviceOrigin(wxCoord x, wxCoord y) = 0;
 551
 552     virtual void ComputeScaleAndOrigin() {}
 553
 554     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0;
 555
 556     int GetLogicalFunction() const { return m_logicalFunction; }
 557     virtual void SetLogicalFunction(int function) = 0;
 558
 559 #if WXWIN_COMPATIBILITY_2_4
 560     virtual void SetOptimization(bool WXUNUSED(opt)) { }
 561     virtual bool GetOptimization() { return false; }
 562 #endif
 563
 564     // bounding box
 565     // ------------
 566
 567     virtual void CalcBoundingBox(wxCoord x, wxCoord y)
 568     {
 569       if ( m_isBBoxValid )
 570       {
 571          if ( x < m_minX ) m_minX = x;
 572          if ( y < m_minY ) m_minY = y;
 573          if ( x > m_maxX ) m_maxX = x;
 574          if ( y > m_maxY ) m_maxY = y;
 575       }
 576       else
 577       {
 578          m_isBBoxValid = true;
 579
 580          m_minX = x;
 581          m_minY = y;
 582          m_maxX = x;
 583          m_maxY = y;
 584       }
 585     }
 586
 587     void ResetBoundingBox()
 588     {
 589         m_isBBoxValid = false;
 590
 591         m_minX = m_maxX = m_minY = m_maxY = 0;
 592     }
 593
 594     // Get the final bounding box of the PostScript or Metafile picture.
 595     wxCoord MinX() const { return m_minX; }
 596     wxCoord MaxX() const { return m_maxX; }
 597     wxCoord MinY() const { return m_minY; }
 598     wxCoord MaxY() const { return m_maxY; }
 599
 600     // misc old functions
 601     // ------------------
 602
 603     // for compatibility with the old code when wxCoord was long everywhere
 604     void GetTextExtent(const wxString& string,
 605                        long *x, long *y,
 606                        long *descent = NULL,
 607                        long *externalLeading = NULL,
 608                        wxFont *theFont = NULL) const
 609     {
 610         wxCoord x2, y2, descent2, externalLeading2;
 611         DoGetTextExtent(string, &x2, &y2,
 612                         &descent2, &externalLeading2,
 613                         theFont);
 614         if ( x )
 615             *x = x2;
 616         if ( y )
 617             *y = y2;
 618         if ( descent )
 619             *descent = descent2;
 620         if ( externalLeading )
 621             *externalLeading = externalLeading2;
 622     }
 623
 624     void GetLogicalOrigin(long *x, long *y) const
 625     {
 626         wxCoord x2, y2;
 627         DoGetLogicalOrigin(&x2, &y2);
 628         if ( x )
 629             *x = x2;
 630         if ( y )
 631             *y = y2;
 632     }
 633
 634     void GetDeviceOrigin(long *x, long *y) const
 635     {
 636         wxCoord x2, y2;
 637         DoGetDeviceOrigin(&x2, &y2);
 638         if ( x )
 639             *x = x2;
 640         if ( y )
 641             *y = y2;
 642     }
 643     void GetClippingBox(long *x, long *y, long *w, long *h) const
 644     {
 645         wxCoord xx,yy,ww,hh;
 646         DoGetClippingBox(&xx, &yy, &ww, &hh);
 647         if (x) *x = xx;
 648         if (y) *y = yy;
 649         if (w) *w = ww;
 650         if (h) *h = hh;
 651     }
 652
 653 protected:
 654     // the pure virtual functions which should be implemented by wxDC
 655     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 656                              int style = wxFLOOD_SURFACE) = 0;
 657
 658     virtual void DoGradientFillLinear(const wxRect& rect,
 659                                       const wxColour& initialColour,
 660                                       const wxColour& destColour,
 661                                       wxDirection nDirection = wxEAST);
 662
 663     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;
 664
 665     virtual void DoDrawPoint(wxCoord x, wxCoord y) = 0;
 666     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2) = 0;
 667
 668     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 669                            wxCoord x2, wxCoord y2,
 670                            wxCoord xc, wxCoord yc) = 0;
 671     virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
 672                                  wxCoord width, wxCoord height);
 673     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 674                                    double sa, double ea) = 0;
 675
 676     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height) = 0;
 677     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 678                                         wxCoord width, wxCoord height,
 679                                         double radius) = 0;
 680     virtual void DoDrawEllipse(wxCoord x, wxCoord y,
 681                                wxCoord width, wxCoord height) = 0;
 682
 683     virtual void DoCrossHair(wxCoord x, wxCoord y) = 0;
 684
 685     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y) = 0;
 686     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 687                               bool useMask = false) = 0;
 688
 689     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0;
 690     virtual void DoDrawRotatedText(const wxString& text,
 691                                    wxCoord x, wxCoord y, double angle) = 0;
 692
 693     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
 694                         wxCoord width, wxCoord height,
 695                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 696                         int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) = 0;
 697
 698     virtual void DoGetSize(int *width, int *height) const = 0;
 699     virtual void DoGetSizeMM(int* width, int* height) const = 0;
 700
 701     virtual void DoDrawLines(int n, wxPoint points[],
 702                              wxCoord xoffset, wxCoord yoffset) = 0;
 703     virtual void DoDrawPolygon(int n, wxPoint points[],
 704                                wxCoord xoffset, wxCoord yoffset,
 705                                int fillStyle = wxODDEVEN_RULE) = 0;
 706     virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
 707                                wxCoord xoffset, wxCoord yoffset,
 708                                int fillStyle);
 709
 710     virtual void DoSetClippingRegionAsRegion(const wxRegion& region) = 0;
 711     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 712                                      wxCoord width, wxCoord height) = 0;
 713
 714 #if WXWIN_COMPATIBILITY_2_4
 715     // this was only for confusing people, use DoGetClippingBox only
 716     virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
 717                                      wxCoord *w, wxCoord *h)
 718         { DoGetClippingBox(x, y, w, h); }
 719 #endif
 720
 721     virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
 722                                   wxCoord *w, wxCoord *h) const
 723     {
 724         if ( x )
 725             *x = m_clipX1;
 726         if ( y )
 727             *y = m_clipY1;
 728         if ( w )
 729             *w = m_clipX2 - m_clipX1;
 730         if ( h )
 731             *h = m_clipY2 - m_clipY1;
 732     }
 733
 734     virtual void DoGetLogicalOrigin(wxCoord *x, wxCoord *y) const
 735     {
 736         if ( x ) *x = m_logicalOriginX;
 737         if ( y ) *y = m_logicalOriginY;
 738     }
 739
 740     virtual void DoGetDeviceOrigin(wxCoord *x, wxCoord *y) const
 741     {
 742         if ( x ) *x = m_deviceOriginX;
 743         if ( y ) *y = m_deviceOriginY;
 744     }
 745
 746     virtual void DoGetTextExtent(const wxString& string,
 747                                  wxCoord *x, wxCoord *y,
 748                                  wxCoord *descent = NULL,
 749                                  wxCoord *externalLeading = NULL,
 750                                  wxFont *theFont = NULL) const = 0;
 751
 752     virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
 753
 754 #if wxUSE_SPLINES
 755     virtual void DoDrawSpline(wxList *points);
 756 #endif
 757
 758 protected:
 759     // unset clipping variables (after clipping region was destroyed)
 760     void ResetClipping()
 761     {
 762         m_clipping = false;
 763
 764         m_clipX1 = m_clipX2 = m_clipY1 = m_clipY2 = 0;
 765     }
 766
 767     // flags
 768     bool m_colour:1;
 769     bool m_ok:1;
 770     bool m_clipping:1;
 771     bool m_isInteractive:1;
 772     bool m_isBBoxValid:1;
 773
 774     // coordinate system variables
 775
 776     // TODO short descriptions of what exactly they are would be nice...
 777
 778     wxCoord m_logicalOriginX, m_logicalOriginY;
 779     wxCoord m_deviceOriginX, m_deviceOriginY;
 780
 781     double m_logicalScaleX, m_logicalScaleY;
 782     double m_userScaleX, m_userScaleY;
 783     double m_scaleX, m_scaleY;
 784
 785     // Used by SetAxisOrientation() to invert the axes
 786     int m_signX, m_signY;
 787
 788     // bounding and clipping boxes
 789     wxCoord m_minX, m_minY, m_maxX, m_maxY;
 790     wxCoord m_clipX1, m_clipY1, m_clipX2, m_clipY2;
 791
 792     int m_logicalFunction;
 793     int m_backgroundMode;
 794     int m_mappingMode;
 795
 796     // GDI objects
 797     wxPen             m_pen;
 798     wxBrush           m_brush;
 799     wxBrush           m_backgroundBrush;
 800     wxColour          m_textForegroundColour;
 801     wxColour          m_textBackgroundColour;
 802     wxFont            m_font;
 803
 804 #if wxUSE_PALETTE
 805     wxPalette         m_palette;
 806     bool              m_hasCustomPalette;
 807 #endif // wxUSE_PALETTE
 808
 809 private:
 810     DECLARE_NO_COPY_CLASS(wxDCBase)
 811     DECLARE_ABSTRACT_CLASS(wxDCBase)
 812 };
 813
 814 // ----------------------------------------------------------------------------
 815 // now include the declaration of wxDC class
 816 // ----------------------------------------------------------------------------
 817
 818 #if defined(__WXPALMOS__)
 819     #include "wx/palmos/dc.h"
 820 #elif defined(__WXMSW__)
 821     #include "wx/msw/dc.h"
 822 #elif defined(__WXMOTIF__)
 823     #include "wx/motif/dc.h"
 824 #elif defined(__WXGTK20__)
 825     #include "wx/gtk/dc.h"
 826 #elif defined(__WXGTK__)
 827     #include "wx/gtk1/dc.h"
 828 #elif defined(__WXX11__)
 829     #include "wx/x11/dc.h"
 830 #elif defined(__WXMGL__)
 831     #include "wx/mgl/dc.h"
 832 #elif defined(__WXMAC__)
 833     #include "wx/mac/dc.h"
 834 #elif defined(__WXCOCOA__)
 835     #include "wx/cocoa/dc.h"
 836 #elif defined(__WXPM__)
 837     #include "wx/os2/dc.h"
 838 #endif
 839
 840 // ----------------------------------------------------------------------------
 841 // helper class: you can use it to temporarily change the DC text colour and
 842 // restore it automatically when the object goes out of scope
 843 // ----------------------------------------------------------------------------
 844
 845 class WXDLLEXPORT wxDCTextColourChanger
 846 {
 847 public:
 848     wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }
 849
 850     ~wxDCTextColourChanger()
 851     {
 852         if ( m_colFgOld.Ok() )
 853             m_dc.SetTextForeground(m_colFgOld);
 854     }
 855
 856     void Set(const wxColour& col)
 857     {
 858         if ( !m_colFgOld.Ok() )
 859             m_colFgOld = m_dc.GetTextForeground();
 860         m_dc.SetTextForeground(col);
 861     }
 862
 863 private:
 864     wxDC& m_dc;
 865
 866     wxColour m_colFgOld;
 867
 868     DECLARE_NO_COPY_CLASS(wxDCTextColourChanger)
 869 };
 870
 871 // ----------------------------------------------------------------------------
 872 // helper class: you can use it to temporarily change the DC pen and
 873 // restore it automatically when the object goes out of scope
 874 // ----------------------------------------------------------------------------
 875
 876 class WXDLLEXPORT wxDCPenChanger
 877 {
 878 public:
 879     wxDCPenChanger(wxDC& dc, const wxPen& pen) : m_dc(dc), m_penOld(dc.GetPen())
 880     {
 881         m_dc.SetPen(pen);
 882     }
 883
 884     ~wxDCPenChanger()
 885     {
 886         if ( m_penOld.Ok() )
 887             m_dc.SetPen(m_penOld);
 888     }
 889
 890 private:
 891     wxDC& m_dc;
 892
 893     wxPen m_penOld;
 894
 895     DECLARE_NO_COPY_CLASS(wxDCPenChanger)
 896 };
 897
 898 // ----------------------------------------------------------------------------
 899 // helper class: you can use it to temporarily change the DC brush and
 900 // restore it automatically when the object goes out of scope
 901 // ----------------------------------------------------------------------------
 902
 903 class WXDLLEXPORT wxDCBrushChanger
 904 {
 905 public:
 906     wxDCBrushChanger(wxDC& dc, const wxBrush& brush) : m_dc(dc), m_brushOld(dc.GetBrush())
 907     {
 908         m_dc.SetBrush(brush);
 909     }
 910
 911     ~wxDCBrushChanger()
 912     {
 913         if ( m_brushOld.Ok() )
 914             m_dc.SetBrush(m_brushOld);
 915     }
 916
 917 private:
 918     wxDC& m_dc;
 919
 920     wxBrush m_brushOld;
 921
 922     DECLARE_NO_COPY_CLASS(wxDCBrushChanger)
 923 };
 924
 925 // ----------------------------------------------------------------------------
 926 // another small helper class: sets the clipping region in its ctor and
 927 // destroys it in the dtor
 928 // ----------------------------------------------------------------------------
 929
 930 class WXDLLEXPORT wxDCClipper
 931 {
 932 public:
 933     wxDCClipper(wxDC& dc, const wxRegion& r) : m_dc(dc)
 934         { dc.SetClippingRegion(r); }
 935     wxDCClipper(wxDC& dc, const wxRect& r) : m_dc(dc)
 936         { dc.SetClippingRegion(r.x, r.y, r.width, r.height); }
 937     wxDCClipper(wxDC& dc, wxCoord x, wxCoord y, wxCoord w, wxCoord h) : m_dc(dc)
 938         { dc.SetClippingRegion(x, y, w, h); }
 939
 940     ~wxDCClipper() { m_dc.DestroyClippingRegion(); }
 941
 942 private:
 943     wxDC& m_dc;
 944
 945     DECLARE_NO_COPY_CLASS(wxDCClipper)
 946 };
 947
 948 #endif
 949     // _WX_DC_H_BASE_