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 // ---------------------------------------------------------------------------
  97 // wxDC is the device context - object on which any drawing is done
  98 // ---------------------------------------------------------------------------
  99
 100 class WXDLLEXPORT wxDCBase : public wxObject
 101 {
 102 public:
 103     wxDCBase()
 104         : m_colour(wxColourDisplay())
 105         , m_ok(true)
 106         , m_clipping(false)
 107         , m_isInteractive(0)
 108         , m_isBBoxValid(false)
 109         , m_logicalOriginX(0), m_logicalOriginY(0)
 110         , m_deviceOriginX(0), m_deviceOriginY(0)
 111         , m_logicalScaleX(1.0), m_logicalScaleY(1.0)
 112         , m_userScaleX(1.0), m_userScaleY(1.0)
 113         , m_scaleX(1.0), m_scaleY(1.0)
 114         , m_signX(1), m_signY(1)
 115         , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
 116         , m_clipX1(0), m_clipY1(0), m_clipX2(0), m_clipY2(0)
 117         , m_logicalFunction(wxCOPY)
 118         , m_backgroundMode(wxTRANSPARENT)
 119         , m_mappingMode(wxMM_TEXT)
 120         , m_pen()
 121         , m_brush()
 122         , m_backgroundBrush(*wxTRANSPARENT_BRUSH)
 123         , m_textForegroundColour(*wxBLACK)
 124         , m_textBackgroundColour(*wxWHITE)
 125         , m_font()
 126 #if wxUSE_PALETTE
 127         , m_palette()
 128         , m_hasCustomPalette(false)
 129 #endif // wxUSE_PALETTE
 130     {
 131         ResetBoundingBox();
 132         ResetClipping();
 133     }
 134
 135     virtual ~wxDCBase() { }
 136
 137     // graphic primitives
 138     // ------------------
 139
 140     virtual void DrawObject(wxDrawObject* drawobject)
 141     {
 142         drawobject->Draw(*this);
 143         CalcBoundingBox(drawobject->MinX(),drawobject->MinY());
 144         CalcBoundingBox(drawobject->MaxX(),drawobject->MaxY());
 145     }
 146
 147     bool FloodFill(wxCoord x, wxCoord y, const wxColour& col,
 148                    int style = wxFLOOD_SURFACE)
 149         { return DoFloodFill(x, y, col, style); }
 150     bool FloodFill(const wxPoint& pt, const wxColour& col,
 151                    int style = wxFLOOD_SURFACE)
 152         { return DoFloodFill(pt.x, pt.y, col, style); }
 153
 154     // fill the area specified by rect with a radial gradient, starting from
 155     // initialColour in the centre of the cercle and fading to destColour.
 156     void GradientFillConcentric(const wxRect& rect,
 157                                 const wxColour& initialColour,
 158                                 const wxColour& destColour)
 159         { GradientFillConcentric(rect, initialColour, destColour,
 160                                  wxPoint(rect.GetWidth() / 2,
 161                                          rect.GetHeight() / 2)); }
 162
 163     void GradientFillConcentric(const wxRect& rect,
 164                                 const wxColour& initialColour,
 165                                 const wxColour& destColour,
 166                                 const wxPoint& circleCenter)
 167         { DoGradientFillConcentric(rect, initialColour, destColour, circleCenter); }
 168
 169     // fill the area specified by rect with a linear gradient
 170     void GradientFillLinear(const wxRect& rect,
 171                             const wxColour& initialColour,
 172                             const wxColour& destColour,
 173                             wxDirection nDirection = wxEAST)
 174         { DoGradientFillLinear(rect, initialColour, destColour, nDirection); }
 175
 176     bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const
 177         { return DoGetPixel(x, y, col); }
 178     bool GetPixel(const wxPoint& pt, wxColour *col) const
 179         { return DoGetPixel(pt.x, pt.y, col); }
 180
 181     void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2)
 182         { DoDrawLine(x1, y1, x2, y2); }
 183     void DrawLine(const wxPoint& pt1, const wxPoint& pt2)
 184         { DoDrawLine(pt1.x, pt1.y, pt2.x, pt2.y); }
 185
 186     void CrossHair(wxCoord x, wxCoord y)
 187         { DoCrossHair(x, y); }
 188     void CrossHair(const wxPoint& pt)
 189         { DoCrossHair(pt.x, pt.y); }
 190
 191     void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
 192                  wxCoord xc, wxCoord yc)
 193         { DoDrawArc(x1, y1, x2, y2, xc, yc); }
 194     void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre)
 195         { DoDrawArc(pt1.x, pt1.y, pt2.x, pt2.y, centre.x, centre.y); }
 196
 197     void DrawCheckMark(wxCoord x, wxCoord y,
 198                        wxCoord width, wxCoord height)
 199         { DoDrawCheckMark(x, y, width, height); }
 200     void DrawCheckMark(const wxRect& rect)
 201         { DoDrawCheckMark(rect.x, rect.y, rect.width, rect.height); }
 202
 203     void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 204                          double sa, double ea)
 205         { DoDrawEllipticArc(x, y, w, h, sa, ea); }
 206     void DrawEllipticArc(const wxPoint& pt, const wxSize& sz,
 207                          double sa, double ea)
 208         { DoDrawEllipticArc(pt.x, pt.y, sz.x, sz.y, sa, ea); }
 209
 210     void DrawPoint(wxCoord x, wxCoord y)
 211         { DoDrawPoint(x, y); }
 212     void DrawPoint(const wxPoint& pt)
 213         { DoDrawPoint(pt.x, pt.y); }
 214
 215     void DrawLines(int n, wxPoint points[],
 216                    wxCoord xoffset = 0, wxCoord yoffset = 0)
 217         { DoDrawLines(n, points, xoffset, yoffset); }
 218     void DrawLines(const wxList *list,
 219                    wxCoord xoffset = 0, wxCoord yoffset = 0);
 220
 221     void DrawPolygon(int n, wxPoint points[],
 222                      wxCoord xoffset = 0, wxCoord yoffset = 0,
 223                      int fillStyle = wxODDEVEN_RULE)
 224         { DoDrawPolygon(n, points, xoffset, yoffset, fillStyle); }
 225
 226     void DrawPolygon(const wxList *list,
 227                      wxCoord xoffset = 0, wxCoord yoffset = 0,
 228                      int fillStyle = wxODDEVEN_RULE);
 229
 230     void DrawPolyPolygon(int n, int count[], wxPoint points[],
 231                          wxCoord xoffset = 0, wxCoord yoffset = 0,
 232                          int fillStyle = wxODDEVEN_RULE)
 233         { DoDrawPolyPolygon(n, count, points, xoffset, yoffset, fillStyle); }
 234
 235     void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 236         { DoDrawRectangle(x, y, width, height); }
 237     void DrawRectangle(const wxPoint& pt, const wxSize& sz)
 238         { DoDrawRectangle(pt.x, pt.y, sz.x, sz.y); }
 239     void DrawRectangle(const wxRect& rect)
 240         { DoDrawRectangle(rect.x, rect.y, rect.width, rect.height); }
 241
 242     void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height,
 243                               double radius)
 244         { DoDrawRoundedRectangle(x, y, width, height, radius); }
 245     void DrawRoundedRectangle(const wxPoint& pt, const wxSize& sz,
 246                              double radius)
 247         { DoDrawRoundedRectangle(pt.x, pt.y, sz.x, sz.y, radius); }
 248     void DrawRoundedRectangle(const wxRect& r, double radius)
 249         { DoDrawRoundedRectangle(r.x, r.y, r.width, r.height, radius); }
 250
 251     void DrawCircle(wxCoord x, wxCoord y, wxCoord radius)
 252         { DoDrawEllipse(x - radius, y - radius, 2*radius, 2*radius); }
 253     void DrawCircle(const wxPoint& pt, wxCoord radius)
 254         { DrawCircle(pt.x, pt.y, radius); }
 255
 256     void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 257         { DoDrawEllipse(x, y, width, height); }
 258     void DrawEllipse(const wxPoint& pt, const wxSize& sz)
 259         { DoDrawEllipse(pt.x, pt.y, sz.x, sz.y); }
 260     void DrawEllipse(const wxRect& rect)
 261         { DoDrawEllipse(rect.x, rect.y, rect.width, rect.height); }
 262
 263     void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y)
 264         { DoDrawIcon(icon, x, y); }
 265     void DrawIcon(const wxIcon& icon, const wxPoint& pt)
 266         { DoDrawIcon(icon, pt.x, pt.y); }
 267
 268     void DrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 269                     bool useMask = false)
 270         { DoDrawBitmap(bmp, x, y, useMask); }
 271     void DrawBitmap(const wxBitmap &bmp, const wxPoint& pt,
 272                     bool useMask = false)
 273         { DoDrawBitmap(bmp, pt.x, pt.y, useMask); }
 274
 275     void DrawText(const wxString& text, wxCoord x, wxCoord y)
 276         { DoDrawText(text, x, y); }
 277     void DrawText(const wxString& text, const wxPoint& pt)
 278         { DoDrawText(text, pt.x, pt.y); }
 279
 280     void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle)
 281         { DoDrawRotatedText(text, x, y, angle); }
 282     void DrawRotatedText(const wxString& text, const wxPoint& pt, double angle)
 283         { DoDrawRotatedText(text, pt.x, pt.y, angle); }
 284
 285     // this version puts both optional bitmap and the text into the given
 286     // rectangle and aligns is as specified by alignment parameter; it also
 287     // will emphasize the character with the given index if it is != -1 and
 288     // return the bounding rectangle if required
 289     virtual void DrawLabel(const wxString& text,
 290                            const wxBitmap& image,
 291                            const wxRect& rect,
 292                            int alignment = wxALIGN_LEFT | wxALIGN_TOP,
 293                            int indexAccel = -1,
 294                            wxRect *rectBounding = NULL);
 295
 296     void DrawLabel(const wxString& text, const wxRect& rect,
 297                    int alignment = wxALIGN_LEFT | wxALIGN_TOP,
 298                    int indexAccel = -1)
 299         { DrawLabel(text, wxNullBitmap, rect, alignment, indexAccel); }
 300
 301     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 302               wxDC *source, wxCoord xsrc, wxCoord ysrc,
 303               int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord)
 304     {
 305         return DoBlit(xdest, ydest, width, height,
 306                       source, xsrc, ysrc, rop, useMask, xsrcMask, ysrcMask);
 307     }
 308     bool Blit(const wxPoint& destPt, const wxSize& sz,
 309               wxDC *source, const wxPoint& srcPt,
 310               int rop = wxCOPY, bool useMask = false, const wxPoint& srcPtMask = wxDefaultPosition)
 311     {
 312         return DoBlit(destPt.x, destPt.y, sz.x, sz.y,
 313                       source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y);
 314     }
 315
 316 #if wxUSE_SPLINES
 317     // TODO: this API needs fixing (wxPointList, why (!const) "wxList *"?)
 318     void DrawSpline(wxCoord x1, wxCoord y1,
 319                     wxCoord x2, wxCoord y2,
 320                     wxCoord x3, wxCoord y3);
 321     void DrawSpline(int n, wxPoint points[]);
 322
 323     void DrawSpline(wxList *points) { DoDrawSpline(points); }
 324 #endif // wxUSE_SPLINES
 325
 326     // Eventually we will have wxUSE_GENERIC_DRAWELLIPSE
 327 #ifdef __WXWINCE__
 328     //! Generic method to draw ellipses, circles and arcs with current pen and brush.
 329     /*! \param x Upper left corner of bounding box.
 330      *  \param y Upper left corner of bounding box.
 331      *  \param w Width of bounding box.
 332      *  \param h Height of bounding box.
 333      *  \param sa Starting angle of arc
 334      *            (counterclockwise, start at 3 o'clock, 360 is full circle).
 335      *  \param ea Ending angle of arc.
 336      *  \param angle Rotation angle, the Arc will be rotated after
 337      *               calculating begin and end.
 338      */
 339     void DrawEllipticArcRot( wxCoord x, wxCoord y,
 340                              wxCoord width, wxCoord height,
 341                              double sa = 0, double ea = 0, double angle = 0 )
 342     { DoDrawEllipticArcRot( x, y, width, height, sa, ea, angle ); }
 343
 344     void DrawEllipticArcRot( const wxPoint& pt,
 345                              const wxSize& sz,
 346                              double sa = 0, double ea = 0, double angle = 0 )
 347     { DoDrawEllipticArcRot( pt.x, pt.y, sz.x, sz.y, sa, ea, angle ); }
 348
 349     void DrawEllipticArcRot( const wxRect& rect,
 350                              double sa = 0, double ea = 0, double angle = 0 )
 351     { DoDrawEllipticArcRot( rect.x, rect.y, rect.width, rect.height, sa, ea, angle ); }
 352
 353     virtual void DoDrawEllipticArcRot( wxCoord x, wxCoord y,
 354                                        wxCoord w, wxCoord h,
 355                                        double sa = 0, double ea = 0, double angle = 0 );
 356
 357     //! Rotates points around center.
 358     /*! This is a quite straight method, it calculates in pixels
 359      *  and so it produces rounding errors.
 360      *  \param points The points inside will be rotated.
 361      *  \param angle Rotating angle (counterclockwise, start at 3 o'clock, 360 is full circle).
 362      *  \param center Center of rotation.
 363      */
 364     void Rotate( wxList* points, double angle, wxPoint center = wxPoint(0,0) );
 365
 366     // used by DrawEllipticArcRot
 367     // Careful: wxList gets filled with points you have to delete later.
 368     void CalculateEllipticPoints( wxList* points,
 369                                   wxCoord xStart, wxCoord yStart,
 370                                   wxCoord w, wxCoord h,
 371                                   double sa, double ea );
 372 #endif
 373
 374     // global DC operations
 375     // --------------------
 376
 377     virtual void Clear() = 0;
 378
 379     virtual bool StartDoc(const wxString& WXUNUSED(message)) { return true; }
 380     virtual void EndDoc() { }
 381
 382     virtual void StartPage() { }
 383     virtual void EndPage() { }
 384
 385 #if WXWIN_COMPATIBILITY_2_6
 386     wxDEPRECATED( void BeginDrawing() );
 387     wxDEPRECATED( void EndDrawing() );
 388 #endif // WXWIN_COMPATIBILITY_2_6
 389
 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 IsOk(); }
 502     virtual bool IsOk() const { return m_ok; }
 503
 504     // accessors and setters
 505     // ---------------------
 506
 507     virtual int GetBackgroundMode() const { return m_backgroundMode; }
 508     virtual const wxBrush&  GetBackground() const { return m_backgroundBrush; }
 509     virtual const wxBrush&  GetBrush() const { return m_brush; }
 510     virtual const wxFont&   GetFont() const { return m_font; }
 511     virtual const wxPen&    GetPen() const { return m_pen; }
 512
 513     virtual const wxColour& GetTextForeground() const { return m_textForegroundColour; }
 514     virtual const wxColour& GetTextBackground() const { return m_textBackgroundColour; }
 515     virtual void SetTextForeground(const wxColour& colour)
 516         { m_textForegroundColour = colour; }
 517     virtual void SetTextBackground(const wxColour& colour)
 518         { m_textBackgroundColour = colour; }
 519
 520     virtual int GetMapMode() const { return m_mappingMode; }
 521     virtual void SetMapMode(int mode) = 0;
 522
 523     virtual void GetUserScale(double *x, double *y) const
 524     {
 525         if ( x ) *x = m_userScaleX;
 526         if ( y ) *y = m_userScaleY;
 527     }
 528     virtual void SetUserScale(double x, double y) = 0;
 529
 530     virtual void GetLogicalScale(double *x, double *y)
 531     {
 532         if ( x ) *x = m_logicalScaleX;
 533         if ( y ) *y = m_logicalScaleY;
 534     }
 535     virtual void SetLogicalScale(double x, double y)
 536     {
 537         m_logicalScaleX = x;
 538         m_logicalScaleY = y;
 539     }
 540
 541     void GetLogicalOrigin(wxCoord *x, wxCoord *y) const
 542         { DoGetLogicalOrigin(x, y); }
 543     wxPoint GetLogicalOrigin() const
 544         { wxCoord x, y; DoGetLogicalOrigin(&x, &y); return wxPoint(x, y); }
 545     virtual void SetLogicalOrigin(wxCoord x, wxCoord y) = 0;
 546
 547     void GetDeviceOrigin(wxCoord *x, wxCoord *y) const
 548         { DoGetDeviceOrigin(x, y); }
 549     wxPoint GetDeviceOrigin() const
 550         { wxCoord x, y; DoGetDeviceOrigin(&x, &y); return wxPoint(x, y); }
 551     virtual void SetDeviceOrigin(wxCoord x, wxCoord y) = 0;
 552
 553     virtual void ComputeScaleAndOrigin() {}
 554
 555     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0;
 556
 557     virtual int GetLogicalFunction() const { return m_logicalFunction; }
 558     virtual void SetLogicalFunction(int function) = 0;
 559
 560 #if WXWIN_COMPATIBILITY_2_4
 561     virtual void SetOptimization(bool WXUNUSED(opt)) { }
 562     virtual bool GetOptimization() { return false; }
 563 #endif
 564
 565     // bounding box
 566     // ------------
 567
 568     virtual void CalcBoundingBox(wxCoord x, wxCoord y)
 569     {
 570       if ( m_isBBoxValid )
 571       {
 572          if ( x < m_minX ) m_minX = x;
 573          if ( y < m_minY ) m_minY = y;
 574          if ( x > m_maxX ) m_maxX = x;
 575          if ( y > m_maxY ) m_maxY = y;
 576       }
 577       else
 578       {
 579          m_isBBoxValid = true;
 580
 581          m_minX = x;
 582          m_minY = y;
 583          m_maxX = x;
 584          m_maxY = y;
 585       }
 586     }
 587
 588     void ResetBoundingBox()
 589     {
 590         m_isBBoxValid = false;
 591
 592         m_minX = m_maxX = m_minY = m_maxY = 0;
 593     }
 594
 595     // Get the final bounding box of the PostScript or Metafile picture.
 596     wxCoord MinX() const { return m_minX; }
 597     wxCoord MaxX() const { return m_maxX; }
 598     wxCoord MinY() const { return m_minY; }
 599     wxCoord MaxY() const { return m_maxY; }
 600
 601     // misc old functions
 602     // ------------------
 603
 604     // for compatibility with the old code when wxCoord was long everywhere
 605     void GetTextExtent(const wxString& string,
 606                        long *x, long *y,
 607                        long *descent = NULL,
 608                        long *externalLeading = NULL,
 609                        wxFont *theFont = NULL) const
 610     {
 611         wxCoord x2, y2, descent2, externalLeading2;
 612         DoGetTextExtent(string, &x2, &y2,
 613                         &descent2, &externalLeading2,
 614                         theFont);
 615         if ( x )
 616             *x = x2;
 617         if ( y )
 618             *y = y2;
 619         if ( descent )
 620             *descent = descent2;
 621         if ( externalLeading )
 622             *externalLeading = externalLeading2;
 623     }
 624
 625     void GetLogicalOrigin(long *x, long *y) const
 626     {
 627         wxCoord x2, y2;
 628         DoGetLogicalOrigin(&x2, &y2);
 629         if ( x )
 630             *x = x2;
 631         if ( y )
 632             *y = y2;
 633     }
 634
 635     void GetDeviceOrigin(long *x, long *y) const
 636     {
 637         wxCoord x2, y2;
 638         DoGetDeviceOrigin(&x2, &y2);
 639         if ( x )
 640             *x = x2;
 641         if ( y )
 642             *y = y2;
 643     }
 644     void GetClippingBox(long *x, long *y, long *w, long *h) const
 645     {
 646         wxCoord xx,yy,ww,hh;
 647         DoGetClippingBox(&xx, &yy, &ww, &hh);
 648         if (x) *x = xx;
 649         if (y) *y = yy;
 650         if (w) *w = ww;
 651         if (h) *h = hh;
 652     }
 653
 654     // RTL related functions
 655     // ---------------------
 656
 657     // get or change the layout direction (LTR or RTL) for this dc,
 658     // wxLayout_Default is returned if layout direction is not supported
 659     virtual wxLayoutDirection GetLayoutDirection() const
 660         { return wxLayout_Default; }
 661     virtual void SetLayoutDirection(wxLayoutDirection WXUNUSED(dir))
 662         { }
 663
 664 protected:
 665     // the pure virtual functions which should be implemented by wxDC
 666     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 667                              int style = wxFLOOD_SURFACE) = 0;
 668
 669     virtual void DoGradientFillLinear(const wxRect& rect,
 670                                       const wxColour& initialColour,
 671                                       const wxColour& destColour,
 672                                       wxDirection nDirection = wxEAST);
 673
 674     virtual void DoGradientFillConcentric(const wxRect& rect,
 675                                         const wxColour& initialColour,
 676                                         const wxColour& destColour,
 677                                         const wxPoint& circleCenter);
 678
 679     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;
 680
 681     virtual void DoDrawPoint(wxCoord x, wxCoord y) = 0;
 682     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2) = 0;
 683
 684     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 685                            wxCoord x2, wxCoord y2,
 686                            wxCoord xc, wxCoord yc) = 0;
 687     virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
 688                                  wxCoord width, wxCoord height);
 689     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 690                                    double sa, double ea) = 0;
 691
 692     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height) = 0;
 693     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 694                                         wxCoord width, wxCoord height,
 695                                         double radius) = 0;
 696     virtual void DoDrawEllipse(wxCoord x, wxCoord y,
 697                                wxCoord width, wxCoord height) = 0;
 698
 699     virtual void DoCrossHair(wxCoord x, wxCoord y) = 0;
 700
 701     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y) = 0;
 702     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 703                               bool useMask = false) = 0;
 704
 705     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0;
 706     virtual void DoDrawRotatedText(const wxString& text,
 707                                    wxCoord x, wxCoord y, double angle) = 0;
 708
 709     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
 710                         wxCoord width, wxCoord height,
 711                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 712                         int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) = 0;
 713
 714     virtual void DoGetSize(int *width, int *height) const = 0;
 715     virtual void DoGetSizeMM(int* width, int* height) const = 0;
 716
 717     virtual void DoDrawLines(int n, wxPoint points[],
 718                              wxCoord xoffset, wxCoord yoffset) = 0;
 719     virtual void DoDrawPolygon(int n, wxPoint points[],
 720                                wxCoord xoffset, wxCoord yoffset,
 721                                int fillStyle = wxODDEVEN_RULE) = 0;
 722     virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
 723                                wxCoord xoffset, wxCoord yoffset,
 724                                int fillStyle);
 725
 726     virtual void DoSetClippingRegionAsRegion(const wxRegion& region) = 0;
 727     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 728                                      wxCoord width, wxCoord height) = 0;
 729
 730 #if WXWIN_COMPATIBILITY_2_4
 731     // this was only for confusing people, use DoGetClippingBox only
 732     virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
 733                                      wxCoord *w, wxCoord *h)
 734         { DoGetClippingBox(x, y, w, h); }
 735 #endif
 736
 737     virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
 738                                   wxCoord *w, wxCoord *h) const
 739     {
 740         if ( x )
 741             *x = m_clipX1;
 742         if ( y )
 743             *y = m_clipY1;
 744         if ( w )
 745             *w = m_clipX2 - m_clipX1;
 746         if ( h )
 747             *h = m_clipY2 - m_clipY1;
 748     }
 749
 750     virtual void DoGetLogicalOrigin(wxCoord *x, wxCoord *y) const
 751     {
 752         if ( x ) *x = m_logicalOriginX;
 753         if ( y ) *y = m_logicalOriginY;
 754     }
 755
 756     virtual void DoGetDeviceOrigin(wxCoord *x, wxCoord *y) const
 757     {
 758         if ( x ) *x = m_deviceOriginX;
 759         if ( y ) *y = m_deviceOriginY;
 760     }
 761
 762     virtual void DoGetTextExtent(const wxString& string,
 763                                  wxCoord *x, wxCoord *y,
 764                                  wxCoord *descent = NULL,
 765                                  wxCoord *externalLeading = NULL,
 766                                  wxFont *theFont = NULL) const = 0;
 767
 768     virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
 769
 770 #if wxUSE_SPLINES
 771     virtual void DoDrawSpline(wxList *points);
 772 #endif
 773
 774 protected:
 775     // unset clipping variables (after clipping region was destroyed)
 776     void ResetClipping()
 777     {
 778         m_clipping = false;
 779
 780         m_clipX1 = m_clipX2 = m_clipY1 = m_clipY2 = 0;
 781     }
 782
 783     // flags
 784     bool m_colour:1;
 785     bool m_ok:1;
 786     bool m_clipping:1;
 787     bool m_isInteractive:1;
 788     bool m_isBBoxValid:1;
 789
 790     // coordinate system variables
 791
 792     // TODO short descriptions of what exactly they are would be nice...
 793
 794     wxCoord m_logicalOriginX, m_logicalOriginY;
 795     wxCoord m_deviceOriginX, m_deviceOriginY;
 796
 797     double m_logicalScaleX, m_logicalScaleY;
 798     double m_userScaleX, m_userScaleY;
 799     double m_scaleX, m_scaleY;
 800
 801     // Used by SetAxisOrientation() to invert the axes
 802     int m_signX, m_signY;
 803
 804     // bounding and clipping boxes
 805     wxCoord m_minX, m_minY, m_maxX, m_maxY;
 806     wxCoord m_clipX1, m_clipY1, m_clipX2, m_clipY2;
 807
 808     int m_logicalFunction;
 809     int m_backgroundMode;
 810     int m_mappingMode;
 811
 812     // GDI objects
 813     wxPen             m_pen;
 814     wxBrush           m_brush;
 815     wxBrush           m_backgroundBrush;
 816     wxColour          m_textForegroundColour;
 817     wxColour          m_textBackgroundColour;
 818     wxFont            m_font;
 819
 820 #if wxUSE_PALETTE
 821     wxPalette         m_palette;
 822     bool              m_hasCustomPalette;
 823 #endif // wxUSE_PALETTE
 824
 825 private:
 826     DECLARE_NO_COPY_CLASS(wxDCBase)
 827     DECLARE_ABSTRACT_CLASS(wxDCBase)
 828 };
 829
 830 // ----------------------------------------------------------------------------
 831 // now include the declaration of wxDC class
 832 // ----------------------------------------------------------------------------
 833
 834 #if defined(__WXPALMOS__)
 835     #include "wx/palmos/dc.h"
 836 #elif defined(__WXMSW__)
 837     #include "wx/msw/dc.h"
 838 #elif defined(__WXMOTIF__)
 839     #include "wx/motif/dc.h"
 840 #elif defined(__WXGTK20__)
 841     #include "wx/gtk/dc.h"
 842 #elif defined(__WXGTK__)
 843     #include "wx/gtk1/dc.h"
 844 #elif defined(__WXX11__)
 845     #include "wx/x11/dc.h"
 846 #elif defined(__WXMGL__)
 847     #include "wx/mgl/dc.h"
 848 #elif defined(__WXDFB__)
 849     #include "wx/dfb/dc.h"
 850 #elif defined(__WXMAC__)
 851     #include "wx/mac/dc.h"
 852 #elif defined(__WXCOCOA__)
 853     #include "wx/cocoa/dc.h"
 854 #elif defined(__WXPM__)
 855     #include "wx/os2/dc.h"
 856 #endif
 857
 858 // ----------------------------------------------------------------------------
 859 // helper class: you can use it to temporarily change the DC text colour and
 860 // restore it automatically when the object goes out of scope
 861 // ----------------------------------------------------------------------------
 862
 863 class WXDLLEXPORT wxDCTextColourChanger
 864 {
 865 public:
 866     wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }
 867
 868     ~wxDCTextColourChanger()
 869     {
 870         if ( m_colFgOld.Ok() )
 871             m_dc.SetTextForeground(m_colFgOld);
 872     }
 873
 874     void Set(const wxColour& col)
 875     {
 876         if ( !m_colFgOld.Ok() )
 877             m_colFgOld = m_dc.GetTextForeground();
 878         m_dc.SetTextForeground(col);
 879     }
 880
 881 private:
 882     wxDC& m_dc;
 883
 884     wxColour m_colFgOld;
 885
 886     DECLARE_NO_COPY_CLASS(wxDCTextColourChanger)
 887 };
 888
 889 // ----------------------------------------------------------------------------
 890 // helper class: you can use it to temporarily change the DC pen and
 891 // restore it automatically when the object goes out of scope
 892 // ----------------------------------------------------------------------------
 893
 894 class WXDLLEXPORT wxDCPenChanger
 895 {
 896 public:
 897     wxDCPenChanger(wxDC& dc, const wxPen& pen) : m_dc(dc), m_penOld(dc.GetPen())
 898     {
 899         m_dc.SetPen(pen);
 900     }
 901
 902     ~wxDCPenChanger()
 903     {
 904         if ( m_penOld.Ok() )
 905             m_dc.SetPen(m_penOld);
 906     }
 907
 908 private:
 909     wxDC& m_dc;
 910
 911     wxPen m_penOld;
 912
 913     DECLARE_NO_COPY_CLASS(wxDCPenChanger)
 914 };
 915
 916 // ----------------------------------------------------------------------------
 917 // helper class: you can use it to temporarily change the DC brush and
 918 // restore it automatically when the object goes out of scope
 919 // ----------------------------------------------------------------------------
 920
 921 class WXDLLEXPORT wxDCBrushChanger
 922 {
 923 public:
 924     wxDCBrushChanger(wxDC& dc, const wxBrush& brush) : m_dc(dc), m_brushOld(dc.GetBrush())
 925     {
 926         m_dc.SetBrush(brush);
 927     }
 928
 929     ~wxDCBrushChanger()
 930     {
 931         if ( m_brushOld.Ok() )
 932             m_dc.SetBrush(m_brushOld);
 933     }
 934
 935 private:
 936     wxDC& m_dc;
 937
 938     wxBrush m_brushOld;
 939
 940     DECLARE_NO_COPY_CLASS(wxDCBrushChanger)
 941 };
 942
 943 // ----------------------------------------------------------------------------
 944 // another small helper class: sets the clipping region in its ctor and
 945 // destroys it in the dtor
 946 // ----------------------------------------------------------------------------
 947
 948 class WXDLLEXPORT wxDCClipper
 949 {
 950 public:
 951     wxDCClipper(wxDC& dc, const wxRegion& r) : m_dc(dc)
 952         { dc.SetClippingRegion(r); }
 953     wxDCClipper(wxDC& dc, const wxRect& r) : m_dc(dc)
 954         { dc.SetClippingRegion(r.x, r.y, r.width, r.height); }
 955     wxDCClipper(wxDC& dc, wxCoord x, wxCoord y, wxCoord w, wxCoord h) : m_dc(dc)
 956         { dc.SetClippingRegion(x, y, w, h); }
 957
 958     ~wxDCClipper() { m_dc.DestroyClippingRegion(); }
 959
 960 private:
 961     wxDC& m_dc;
 962
 963     DECLARE_NO_COPY_CLASS(wxDCClipper)
 964 };
 965
 966 #endif
 967     // _WX_DC_H_BASE_