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     wxBitmap GetAsBitmap(const wxRect *subrect = (const wxRect *) NULL) const
 318     {
 319         return DoGetAsBitmap(subrect);
 320     }
 321
 322 #if wxUSE_SPLINES
 323     // TODO: this API needs fixing (wxPointList, why (!const) "wxList *"?)
 324     void DrawSpline(wxCoord x1, wxCoord y1,
 325                     wxCoord x2, wxCoord y2,
 326                     wxCoord x3, wxCoord y3);
 327     void DrawSpline(int n, wxPoint points[]);
 328
 329     void DrawSpline(wxList *points) { DoDrawSpline(points); }
 330 #endif // wxUSE_SPLINES
 331
 332     // Eventually we will have wxUSE_GENERIC_DRAWELLIPSE
 333 #ifdef __WXWINCE__
 334     //! Generic method to draw ellipses, circles and arcs with current pen and brush.
 335     /*! \param x Upper left corner of bounding box.
 336      *  \param y Upper left corner of bounding box.
 337      *  \param w Width of bounding box.
 338      *  \param h Height of bounding box.
 339      *  \param sa Starting angle of arc
 340      *            (counterclockwise, start at 3 o'clock, 360 is full circle).
 341      *  \param ea Ending angle of arc.
 342      *  \param angle Rotation angle, the Arc will be rotated after
 343      *               calculating begin and end.
 344      */
 345     void DrawEllipticArcRot( wxCoord x, wxCoord y,
 346                              wxCoord width, wxCoord height,
 347                              double sa = 0, double ea = 0, double angle = 0 )
 348     { DoDrawEllipticArcRot( x, y, width, height, sa, ea, angle ); }
 349
 350     void DrawEllipticArcRot( const wxPoint& pt,
 351                              const wxSize& sz,
 352                              double sa = 0, double ea = 0, double angle = 0 )
 353     { DoDrawEllipticArcRot( pt.x, pt.y, sz.x, sz.y, sa, ea, angle ); }
 354
 355     void DrawEllipticArcRot( const wxRect& rect,
 356                              double sa = 0, double ea = 0, double angle = 0 )
 357     { DoDrawEllipticArcRot( rect.x, rect.y, rect.width, rect.height, sa, ea, angle ); }
 358
 359     virtual void DoDrawEllipticArcRot( wxCoord x, wxCoord y,
 360                                        wxCoord w, wxCoord h,
 361                                        double sa = 0, double ea = 0, double angle = 0 );
 362
 363     //! Rotates points around center.
 364     /*! This is a quite straight method, it calculates in pixels
 365      *  and so it produces rounding errors.
 366      *  \param points The points inside will be rotated.
 367      *  \param angle Rotating angle (counterclockwise, start at 3 o'clock, 360 is full circle).
 368      *  \param center Center of rotation.
 369      */
 370     void Rotate( wxList* points, double angle, wxPoint center = wxPoint(0,0) );
 371
 372     // used by DrawEllipticArcRot
 373     // Careful: wxList gets filled with points you have to delete later.
 374     void CalculateEllipticPoints( wxList* points,
 375                                   wxCoord xStart, wxCoord yStart,
 376                                   wxCoord w, wxCoord h,
 377                                   double sa, double ea );
 378 #endif
 379
 380     // global DC operations
 381     // --------------------
 382
 383     virtual void Clear() = 0;
 384
 385     virtual bool StartDoc(const wxString& WXUNUSED(message)) { return true; }
 386     virtual void EndDoc() { }
 387
 388     virtual void StartPage() { }
 389     virtual void EndPage() { }
 390
 391 #if WXWIN_COMPATIBILITY_2_6
 392     wxDEPRECATED( void BeginDrawing() );
 393     wxDEPRECATED( void EndDrawing() );
 394 #endif // WXWIN_COMPATIBILITY_2_6
 395
 396
 397     // set objects to use for drawing
 398     // ------------------------------
 399
 400     virtual void SetFont(const wxFont& font) = 0;
 401     virtual void SetPen(const wxPen& pen) = 0;
 402     virtual void SetBrush(const wxBrush& brush) = 0;
 403     virtual void SetBackground(const wxBrush& brush) = 0;
 404     virtual void SetBackgroundMode(int mode) = 0;
 405 #if wxUSE_PALETTE
 406     virtual void SetPalette(const wxPalette& palette) = 0;
 407 #endif // wxUSE_PALETTE
 408
 409     // clipping region
 410     // ---------------
 411
 412     void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
 413         { DoSetClippingRegion(x, y, width, height); }
 414     void SetClippingRegion(const wxPoint& pt, const wxSize& sz)
 415         { DoSetClippingRegion(pt.x, pt.y, sz.x, sz.y); }
 416     void SetClippingRegion(const wxRect& rect)
 417         { DoSetClippingRegion(rect.x, rect.y, rect.width, rect.height); }
 418     void SetClippingRegion(const wxRegion& region)
 419         { DoSetClippingRegionAsRegion(region); }
 420
 421     virtual void DestroyClippingRegion() { ResetClipping(); }
 422
 423     void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *w, wxCoord *h) const
 424         { DoGetClippingBox(x, y, w, h); }
 425     void GetClippingBox(wxRect& rect) const
 426         {
 427           DoGetClippingBox(&rect.x, &rect.y, &rect.width, &rect.height);
 428         }
 429
 430     // text extent
 431     // -----------
 432
 433     virtual wxCoord GetCharHeight() const = 0;
 434     virtual wxCoord GetCharWidth() const = 0;
 435
 436     // only works for single line strings
 437     void GetTextExtent(const wxString& string,
 438                        wxCoord *x, wxCoord *y,
 439                        wxCoord *descent = NULL,
 440                        wxCoord *externalLeading = NULL,
 441                        wxFont *theFont = NULL) const
 442         { DoGetTextExtent(string, x, y, descent, externalLeading, theFont); }
 443
 444     wxSize GetTextExtent(const wxString& string) const
 445     {
 446         wxCoord w, h;
 447         DoGetTextExtent(string, &w, &h);
 448         return wxSize(w, h);
 449     }
 450
 451     // works for single as well as multi-line strings
 452     virtual void GetMultiLineTextExtent(const wxString& string,
 453                                         wxCoord *width,
 454                                         wxCoord *height,
 455                                         wxCoord *heightLine = NULL,
 456                                         wxFont *font = NULL) const;
 457
 458     wxSize GetMultiLineTextExtent(const wxString& string) const
 459     {
 460         wxCoord w, h;
 461         GetMultiLineTextExtent(string, &w, &h);
 462         return wxSize(w, h);
 463     }
 464
 465     // Measure cumulative width of text after each character
 466     bool GetPartialTextExtents(const wxString& text, wxArrayInt& widths) const
 467         { return DoGetPartialTextExtents(text, widths); }
 468
 469
 470     // size and resolution
 471     // -------------------
 472
 473     // in device units
 474     void GetSize(int *width, int *height) const
 475         { DoGetSize(width, height); }
 476     wxSize GetSize() const
 477     {
 478         int w, h;
 479         DoGetSize(&w, &h);
 480
 481         return wxSize(w, h);
 482     }
 483
 484     // in mm
 485     void GetSizeMM(int* width, int* height) const
 486         { DoGetSizeMM(width, height); }
 487     wxSize GetSizeMM() const
 488     {
 489         int w, h;
 490         DoGetSizeMM(&w, &h);
 491
 492         return wxSize(w, h);
 493     }
 494
 495     // coordinates conversions
 496     // -----------------------
 497
 498     // This group of functions does actual conversion of the input, as you'd
 499     // expect.
 500     wxCoord DeviceToLogicalX(wxCoord x) const;
 501     wxCoord DeviceToLogicalY(wxCoord y) const;
 502     wxCoord DeviceToLogicalXRel(wxCoord x) const;
 503     wxCoord DeviceToLogicalYRel(wxCoord y) const;
 504     wxCoord LogicalToDeviceX(wxCoord x) const;
 505     wxCoord LogicalToDeviceY(wxCoord y) const;
 506     wxCoord LogicalToDeviceXRel(wxCoord x) const;
 507     wxCoord LogicalToDeviceYRel(wxCoord y) const;
 508
 509     // query DC capabilities
 510     // ---------------------
 511
 512     virtual bool CanDrawBitmap() const = 0;
 513     virtual bool CanGetTextExtent() const = 0;
 514
 515     // colour depth
 516     virtual int GetDepth() const = 0;
 517
 518     // Resolution in Pixels per inch
 519     virtual wxSize GetPPI() const = 0;
 520
 521     virtual bool Ok() const { return IsOk(); }
 522     virtual bool IsOk() const { return m_ok; }
 523
 524     // accessors and setters
 525     // ---------------------
 526
 527     virtual int GetBackgroundMode() const { return m_backgroundMode; }
 528     virtual const wxBrush&  GetBackground() const { return m_backgroundBrush; }
 529     virtual const wxBrush&  GetBrush() const { return m_brush; }
 530     virtual const wxFont&   GetFont() const { return m_font; }
 531     virtual const wxPen&    GetPen() const { return m_pen; }
 532
 533     virtual const wxColour& GetTextForeground() const { return m_textForegroundColour; }
 534     virtual const wxColour& GetTextBackground() const { return m_textBackgroundColour; }
 535     virtual void SetTextForeground(const wxColour& colour)
 536         { m_textForegroundColour = colour; }
 537     virtual void SetTextBackground(const wxColour& colour)
 538         { m_textBackgroundColour = colour; }
 539
 540     virtual int GetMapMode() const { return m_mappingMode; }
 541     virtual void SetMapMode(int mode) = 0;
 542
 543     virtual void GetUserScale(double *x, double *y) const
 544     {
 545         if ( x ) *x = m_userScaleX;
 546         if ( y ) *y = m_userScaleY;
 547     }
 548     virtual void SetUserScale(double x, double y) = 0;
 549
 550     virtual void GetLogicalScale(double *x, double *y)
 551     {
 552         if ( x ) *x = m_logicalScaleX;
 553         if ( y ) *y = m_logicalScaleY;
 554     }
 555     virtual void SetLogicalScale(double x, double y)
 556     {
 557         m_logicalScaleX = x;
 558         m_logicalScaleY = y;
 559     }
 560
 561     void GetLogicalOrigin(wxCoord *x, wxCoord *y) const
 562         { DoGetLogicalOrigin(x, y); }
 563     wxPoint GetLogicalOrigin() const
 564         { wxCoord x, y; DoGetLogicalOrigin(&x, &y); return wxPoint(x, y); }
 565     virtual void SetLogicalOrigin(wxCoord x, wxCoord y) = 0;
 566
 567     void GetDeviceOrigin(wxCoord *x, wxCoord *y) const
 568         { DoGetDeviceOrigin(x, y); }
 569     wxPoint GetDeviceOrigin() const
 570         { wxCoord x, y; DoGetDeviceOrigin(&x, &y); return wxPoint(x, y); }
 571     virtual void SetDeviceOrigin(wxCoord x, wxCoord y) = 0;
 572
 573     virtual void ComputeScaleAndOrigin() {}
 574
 575     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0;
 576
 577     virtual int GetLogicalFunction() const { return m_logicalFunction; }
 578     virtual void SetLogicalFunction(int function) = 0;
 579
 580 #if WXWIN_COMPATIBILITY_2_4
 581     virtual void SetOptimization(bool WXUNUSED(opt)) { }
 582     virtual bool GetOptimization() { return false; }
 583 #endif
 584
 585     // bounding box
 586     // ------------
 587
 588     virtual void CalcBoundingBox(wxCoord x, wxCoord y)
 589     {
 590       if ( m_isBBoxValid )
 591       {
 592          if ( x < m_minX ) m_minX = x;
 593          if ( y < m_minY ) m_minY = y;
 594          if ( x > m_maxX ) m_maxX = x;
 595          if ( y > m_maxY ) m_maxY = y;
 596       }
 597       else
 598       {
 599          m_isBBoxValid = true;
 600
 601          m_minX = x;
 602          m_minY = y;
 603          m_maxX = x;
 604          m_maxY = y;
 605       }
 606     }
 607
 608     void ResetBoundingBox()
 609     {
 610         m_isBBoxValid = false;
 611
 612         m_minX = m_maxX = m_minY = m_maxY = 0;
 613     }
 614
 615     // Get the final bounding box of the PostScript or Metafile picture.
 616     wxCoord MinX() const { return m_minX; }
 617     wxCoord MaxX() const { return m_maxX; }
 618     wxCoord MinY() const { return m_minY; }
 619     wxCoord MaxY() const { return m_maxY; }
 620
 621     // misc old functions
 622     // ------------------
 623
 624     // for compatibility with the old code when wxCoord was long everywhere
 625     void GetTextExtent(const wxString& string,
 626                        long *x, long *y,
 627                        long *descent = NULL,
 628                        long *externalLeading = NULL,
 629                        wxFont *theFont = NULL) const
 630     {
 631         wxCoord x2, y2, descent2, externalLeading2;
 632         DoGetTextExtent(string, &x2, &y2,
 633                         &descent2, &externalLeading2,
 634                         theFont);
 635         if ( x )
 636             *x = x2;
 637         if ( y )
 638             *y = y2;
 639         if ( descent )
 640             *descent = descent2;
 641         if ( externalLeading )
 642             *externalLeading = externalLeading2;
 643     }
 644
 645     void GetLogicalOrigin(long *x, long *y) const
 646     {
 647         wxCoord x2, y2;
 648         DoGetLogicalOrigin(&x2, &y2);
 649         if ( x )
 650             *x = x2;
 651         if ( y )
 652             *y = y2;
 653     }
 654
 655     void GetDeviceOrigin(long *x, long *y) const
 656     {
 657         wxCoord x2, y2;
 658         DoGetDeviceOrigin(&x2, &y2);
 659         if ( x )
 660             *x = x2;
 661         if ( y )
 662             *y = y2;
 663     }
 664     void GetClippingBox(long *x, long *y, long *w, long *h) const
 665     {
 666         wxCoord xx,yy,ww,hh;
 667         DoGetClippingBox(&xx, &yy, &ww, &hh);
 668         if (x) *x = xx;
 669         if (y) *y = yy;
 670         if (w) *w = ww;
 671         if (h) *h = hh;
 672     }
 673
 674     // RTL related functions
 675     // ---------------------
 676
 677     // get or change the layout direction (LTR or RTL) for this dc,
 678     // wxLayout_Default is returned if layout direction is not supported
 679     virtual wxLayoutDirection GetLayoutDirection() const
 680         { return wxLayout_Default; }
 681     virtual void SetLayoutDirection(wxLayoutDirection WXUNUSED(dir))
 682         { }
 683
 684 protected:
 685     // the pure virtual functions which should be implemented by wxDC
 686     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
 687                              int style = wxFLOOD_SURFACE) = 0;
 688
 689     virtual void DoGradientFillLinear(const wxRect& rect,
 690                                       const wxColour& initialColour,
 691                                       const wxColour& destColour,
 692                                       wxDirection nDirection = wxEAST);
 693
 694     virtual void DoGradientFillConcentric(const wxRect& rect,
 695                                         const wxColour& initialColour,
 696                                         const wxColour& destColour,
 697                                         const wxPoint& circleCenter);
 698
 699     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;
 700
 701     virtual void DoDrawPoint(wxCoord x, wxCoord y) = 0;
 702     virtual void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2) = 0;
 703
 704     virtual void DoDrawArc(wxCoord x1, wxCoord y1,
 705                            wxCoord x2, wxCoord y2,
 706                            wxCoord xc, wxCoord yc) = 0;
 707     virtual void DoDrawCheckMark(wxCoord x, wxCoord y,
 708                                  wxCoord width, wxCoord height);
 709     virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
 710                                    double sa, double ea) = 0;
 711
 712     virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height) = 0;
 713     virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
 714                                         wxCoord width, wxCoord height,
 715                                         double radius) = 0;
 716     virtual void DoDrawEllipse(wxCoord x, wxCoord y,
 717                                wxCoord width, wxCoord height) = 0;
 718
 719     virtual void DoCrossHair(wxCoord x, wxCoord y) = 0;
 720
 721     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y) = 0;
 722     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 723                               bool useMask = false) = 0;
 724
 725     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0;
 726     virtual void DoDrawRotatedText(const wxString& text,
 727                                    wxCoord x, wxCoord y, double angle) = 0;
 728
 729     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
 730                         wxCoord width, wxCoord height,
 731                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
 732                         int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) = 0;
 733
 734     virtual wxBitmap DoGetAsBitmap(const wxRect *WXUNUSED(subrect)) const { return wxNullBitmap; }
 735
 736     virtual void DoGetSize(int *width, int *height) const = 0;
 737     virtual void DoGetSizeMM(int* width, int* height) const = 0;
 738
 739     virtual void DoDrawLines(int n, wxPoint points[],
 740                              wxCoord xoffset, wxCoord yoffset) = 0;
 741     virtual void DoDrawPolygon(int n, wxPoint points[],
 742                                wxCoord xoffset, wxCoord yoffset,
 743                                int fillStyle = wxODDEVEN_RULE) = 0;
 744     virtual void DoDrawPolyPolygon(int n, int count[], wxPoint points[],
 745                                wxCoord xoffset, wxCoord yoffset,
 746                                int fillStyle);
 747
 748     virtual void DoSetClippingRegionAsRegion(const wxRegion& region) = 0;
 749     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
 750                                      wxCoord width, wxCoord height) = 0;
 751
 752 #if WXWIN_COMPATIBILITY_2_4
 753     // this was only for confusing people, use DoGetClippingBox only
 754     virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
 755                                      wxCoord *w, wxCoord *h)
 756         { DoGetClippingBox(x, y, w, h); }
 757 #endif
 758
 759     virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
 760                                   wxCoord *w, wxCoord *h) const
 761     {
 762         if ( x )
 763             *x = m_clipX1;
 764         if ( y )
 765             *y = m_clipY1;
 766         if ( w )
 767             *w = m_clipX2 - m_clipX1;
 768         if ( h )
 769             *h = m_clipY2 - m_clipY1;
 770     }
 771
 772     virtual void DoGetLogicalOrigin(wxCoord *x, wxCoord *y) const
 773     {
 774         if ( x ) *x = m_logicalOriginX;
 775         if ( y ) *y = m_logicalOriginY;
 776     }
 777
 778     virtual void DoGetDeviceOrigin(wxCoord *x, wxCoord *y) const
 779     {
 780         if ( x ) *x = m_deviceOriginX;
 781         if ( y ) *y = m_deviceOriginY;
 782     }
 783
 784     virtual void DoGetTextExtent(const wxString& string,
 785                                  wxCoord *x, wxCoord *y,
 786                                  wxCoord *descent = NULL,
 787                                  wxCoord *externalLeading = NULL,
 788                                  wxFont *theFont = NULL) const = 0;
 789
 790     virtual bool DoGetPartialTextExtents(const wxString& text, wxArrayInt& widths) const;
 791
 792 #if wxUSE_SPLINES
 793     virtual void DoDrawSpline(wxList *points);
 794 #endif
 795
 796 protected:
 797     // unset clipping variables (after clipping region was destroyed)
 798     void ResetClipping()
 799     {
 800         m_clipping = false;
 801
 802         m_clipX1 = m_clipX2 = m_clipY1 = m_clipY2 = 0;
 803     }
 804
 805     // flags
 806     bool m_colour:1;
 807     bool m_ok:1;
 808     bool m_clipping:1;
 809     bool m_isInteractive:1;
 810     bool m_isBBoxValid:1;
 811
 812     // coordinate system variables
 813
 814     // TODO short descriptions of what exactly they are would be nice...
 815
 816     wxCoord m_logicalOriginX, m_logicalOriginY;
 817     wxCoord m_deviceOriginX, m_deviceOriginY;
 818
 819     double m_logicalScaleX, m_logicalScaleY;
 820     double m_userScaleX, m_userScaleY;
 821     double m_scaleX, m_scaleY;
 822
 823     // Used by SetAxisOrientation() to invert the axes
 824     int m_signX, m_signY;
 825
 826     // bounding and clipping boxes
 827     wxCoord m_minX, m_minY, m_maxX, m_maxY;
 828     wxCoord m_clipX1, m_clipY1, m_clipX2, m_clipY2;
 829
 830     int m_logicalFunction;
 831     int m_backgroundMode;
 832     int m_mappingMode;
 833
 834     // GDI objects
 835     wxPen             m_pen;
 836     wxBrush           m_brush;
 837     wxBrush           m_backgroundBrush;
 838     wxColour          m_textForegroundColour;
 839     wxColour          m_textBackgroundColour;
 840     wxFont            m_font;
 841
 842 #if wxUSE_PALETTE
 843     wxPalette         m_palette;
 844     bool              m_hasCustomPalette;
 845 #endif // wxUSE_PALETTE
 846
 847 private:
 848     DECLARE_NO_COPY_CLASS(wxDCBase)
 849     DECLARE_ABSTRACT_CLASS(wxDCBase)
 850 };
 851
 852 // ----------------------------------------------------------------------------
 853 // now include the declaration of wxDC class
 854 // ----------------------------------------------------------------------------
 855
 856 #if defined(__WXPALMOS__)
 857     #include "wx/palmos/dc.h"
 858 #elif defined(__WXMSW__)
 859     #include "wx/msw/dc.h"
 860 #elif defined(__WXMOTIF__)
 861     #include "wx/motif/dc.h"
 862 #elif defined(__WXGTK20__)
 863     #include "wx/gtk/dc.h"
 864 #elif defined(__WXGTK__)
 865     #include "wx/gtk1/dc.h"
 866 #elif defined(__WXX11__)
 867     #include "wx/x11/dc.h"
 868 #elif defined(__WXMGL__)
 869     #include "wx/mgl/dc.h"
 870 #elif defined(__WXDFB__)
 871     #include "wx/dfb/dc.h"
 872 #elif defined(__WXMAC__)
 873     #include "wx/mac/dc.h"
 874 #elif defined(__WXCOCOA__)
 875     #include "wx/cocoa/dc.h"
 876 #elif defined(__WXPM__)
 877     #include "wx/os2/dc.h"
 878 #endif
 879
 880 #if wxUSE_GRAPHICS_CONTEXT
 881     #include "wx/dcgraph.h"
 882 #endif
 883
 884 // ----------------------------------------------------------------------------
 885 // helper class: you can use it to temporarily change the DC text colour and
 886 // restore it automatically when the object goes out of scope
 887 // ----------------------------------------------------------------------------
 888
 889 class WXDLLEXPORT wxDCTextColourChanger
 890 {
 891 public:
 892     wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }
 893
 894     wxDCTextColourChanger(wxDC& dc, const wxColour& col) : m_dc(dc)
 895     {
 896         Set(col);
 897     }
 898
 899     ~wxDCTextColourChanger()
 900     {
 901         if ( m_colFgOld.Ok() )
 902             m_dc.SetTextForeground(m_colFgOld);
 903     }
 904
 905     void Set(const wxColour& col)
 906     {
 907         if ( !m_colFgOld.Ok() )
 908             m_colFgOld = m_dc.GetTextForeground();
 909         m_dc.SetTextForeground(col);
 910     }
 911
 912 private:
 913     wxDC& m_dc;
 914
 915     wxColour m_colFgOld;
 916
 917     DECLARE_NO_COPY_CLASS(wxDCTextColourChanger)
 918 };
 919
 920 // ----------------------------------------------------------------------------
 921 // helper class: you can use it to temporarily change the DC pen and
 922 // restore it automatically when the object goes out of scope
 923 // ----------------------------------------------------------------------------
 924
 925 class WXDLLEXPORT wxDCPenChanger
 926 {
 927 public:
 928     wxDCPenChanger(wxDC& dc, const wxPen& pen) : m_dc(dc), m_penOld(dc.GetPen())
 929     {
 930         m_dc.SetPen(pen);
 931     }
 932
 933     ~wxDCPenChanger()
 934     {
 935         if ( m_penOld.Ok() )
 936             m_dc.SetPen(m_penOld);
 937     }
 938
 939 private:
 940     wxDC& m_dc;
 941
 942     wxPen m_penOld;
 943
 944     DECLARE_NO_COPY_CLASS(wxDCPenChanger)
 945 };
 946
 947 // ----------------------------------------------------------------------------
 948 // helper class: you can use it to temporarily change the DC brush and
 949 // restore it automatically when the object goes out of scope
 950 // ----------------------------------------------------------------------------
 951
 952 class WXDLLEXPORT wxDCBrushChanger
 953 {
 954 public:
 955     wxDCBrushChanger(wxDC& dc, const wxBrush& brush) : m_dc(dc), m_brushOld(dc.GetBrush())
 956     {
 957         m_dc.SetBrush(brush);
 958     }
 959
 960     ~wxDCBrushChanger()
 961     {
 962         if ( m_brushOld.Ok() )
 963             m_dc.SetBrush(m_brushOld);
 964     }
 965
 966 private:
 967     wxDC& m_dc;
 968
 969     wxBrush m_brushOld;
 970
 971     DECLARE_NO_COPY_CLASS(wxDCBrushChanger)
 972 };
 973
 974 // ----------------------------------------------------------------------------
 975 // another small helper class: sets the clipping region in its ctor and
 976 // destroys it in the dtor
 977 // ----------------------------------------------------------------------------
 978
 979 class WXDLLEXPORT wxDCClipper
 980 {
 981 public:
 982     wxDCClipper(wxDC& dc, const wxRegion& r) : m_dc(dc)
 983         { dc.SetClippingRegion(r); }
 984     wxDCClipper(wxDC& dc, const wxRect& r) : m_dc(dc)
 985         { dc.SetClippingRegion(r.x, r.y, r.width, r.height); }
 986     wxDCClipper(wxDC& dc, wxCoord x, wxCoord y, wxCoord w, wxCoord h) : m_dc(dc)
 987         { dc.SetClippingRegion(x, y, w, h); }
 988
 989     ~wxDCClipper() { m_dc.DestroyClippingRegion(); }
 990
 991 private:
 992     wxDC& m_dc;
 993
 994     DECLARE_NO_COPY_CLASS(wxDCClipper)
 995 };
 996
 997 #endif // _WX_DC_H_BASE_