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