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