include/wx/dc.h

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