interface/wx/dc.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dc.h
   3 // Purpose:     interface of wxDC
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11     Logical raster operations which can be used with wxDC::SetLogicalFunction
  12     and some other wxDC functions (e.g. wxDC::Blit and wxDC::StretchBlit).
  13
  14     The description of the values below refer to how a generic @e src source pixel
  15     and the corresponding @e dst destination pixel gets combined together to produce
  16     the final pixel. E.g. @c wxCLEAR and @c wxSET completely ignore the source
  17     and the destination pixel and always put zeroes or ones in the final surface.
  18 */
  19 enum wxRasterOperationMode
  20 {
  21     wxCLEAR,       //!< 0
  22     wxXOR,         //!< @e src XOR @e dst
  23     wxINVERT,      //!< NOT @e dst
  24     wxOR_REVERSE,  //!< @e src OR (NOT @e dst)
  25     wxAND_REVERSE, //!< @e src AND (NOT @e dst)
  26     wxCOPY,        //!< @e src
  27     wxAND,         //!< @e src AND @e dst
  28     wxAND_INVERT,  //!< (NOT @e src) AND @e dst
  29     wxNO_OP,       //!< @e dst
  30     wxNOR,         //!< (NOT @e src) AND (NOT @e dst)
  31     wxEQUIV,       //!< (NOT @e src) XOR @e dst
  32     wxSRC_INVERT,  //!< (NOT @e src)
  33     wxOR_INVERT,   //!< (NOT @e src) OR @e dst
  34     wxNAND,        //!< (NOT @e src) OR (NOT @e dst)
  35     wxOR,          //!< @e src OR @e dst
  36     wxSET          //!< 1
  37 };
  38
  39 /**
  40     Flood styles used by wxDC::FloodFill.
  41 */
  42 enum wxFloodFillStyle
  43 {
  44     /** The flooding occurs until a colour other than the given colour is encountered. */
  45     wxFLOOD_SURFACE = 1,
  46
  47     /** The area to be flooded is bounded by the given colour. */
  48     wxFLOOD_BORDER
  49 };
  50
  51 /**
  52     The mapping used to transform @e logical units to @e device units.
  53     See wxDC::SetMapMode.
  54 */
  55 enum wxMappingMode
  56 {
  57     /**
  58         Each logical unit is 1 device pixel.
  59         This is the default mapping mode for all wxDC-derived classes.
  60     */
  61     wxMM_TEXT = 1,
  62
  63     /** Each logical unit is 1 millimeter. */
  64     wxMM_METRIC,
  65
  66     /** Each logical unit is 1/10 of a millimeter. */
  67     wxMM_LOMETRIC,
  68
  69     /**
  70         Each logical unit is 1/20 of a @e "printer point", or 1/1440 of an inch
  71         (also known as "twip"). Equivalent to about 17.64 micrometers.
  72     */
  73     wxMM_TWIPS,
  74
  75     /**
  76         Each logical unit is a @e "printer point" i.e. 1/72 of an inch.
  77         Equivalent to about 353 micrometers.
  78     */
  79     wxMM_POINTS
  80 };
  81
  82
  83
  84 /**
  85     @class wxDC
  86
  87     A wxDC is a @e "device context" onto which graphics and text can be drawn.
  88     It is intended to represent different output devices and offers a common
  89     abstract API for drawing on any of them.
  90
  91     wxWidgets offers an alternative drawing API based on the modern drawing
  92     backends GDI+, CoreGraphics and Cairo. See wxGraphicsContext, wxGraphicsRenderer
  93     and related classes. There is also a wxGCDC linking the APIs by offering
  94     the wxDC API ontop of a wxGraphicsContext.
  95
  96     wxDC is an abstract base class and cannot be created directly.
  97     Use wxPaintDC, wxClientDC, wxWindowDC, wxScreenDC, wxMemoryDC or
  98     wxPrinterDC. Notice that device contexts which are associated with windows
  99     (i.e. wxClientDC, wxWindowDC and wxPaintDC) use the window font and colours
 100     by default (starting with wxWidgets 2.9.0) but the other device context
 101     classes use system-default values so you always must set the appropriate
 102     fonts and colours before using them.
 103
 104     In addition to the versions of the methods documented below, there
 105     are also versions which accept single wxPoint parameter instead
 106     of the two wxCoord ones or wxPoint and wxSize instead of the four
 107     wxCoord parameters.
 108
 109     Beginning with wxWidgets 2.9.0 the entire wxDC code has been
 110     reorganized. All platform dependent code (actually all drawing code)
 111     has been moved into backend classes which derive from a common
 112     wxDCImpl class. The user-visible classes such as wxClientDC and
 113     wxPaintDC merely forward all calls to the backend implementation.
 114
 115
 116     @section dc_units Device and logical units
 117
 118     In the wxDC context there is a distinction between @e logical units and @e device units.
 119
 120     @b Device units are the units native to the particular device; e.g. for a screen,
 121     a device unit is a @e pixel. For a printer, the device unit is defined by the
 122     resolution of the printer (usually given in @c DPI: dot-per-inch).
 123
 124     All wxDC functions use instead @b logical units, unless where explicitely
 125     stated. Logical units are arbitrary units mapped to device units using
 126     the current mapping mode (see wxDC::SetMapMode).
 127
 128     This mechanism allows to reuse the same code which prints on e.g. a window
 129     on the screen to print on e.g. a paper.
 130
 131
 132     @section dc_alpha_support Support for Transparency / Alpha Channel
 133
 134     On Mac OS X colours with alpha channel are supported. Instances of wxPen
 135     or wxBrush that are built from wxColour use the colour's alpha values
 136     when stroking or filling.
 137
 138
 139     @library{wxcore}
 140     @category{dc,gdi}
 141
 142     @see @ref overview_dc, wxGraphicsContext, wxDCFontChanger, wxDCTextColourChanger,
 143          wxDCPenChanger, wxDCBrushChanger, wxDCClipper
 144
 145     @todo Precise definition of default/initial state.
 146     @todo Pixelwise definition of operations (e.g. last point of a line not
 147           drawn).
 148 */
 149 class wxDC : public wxObject
 150 {
 151 public:
 152     /**
 153         @name Coordinate conversion functions
 154     */
 155     //@{
 156
 157     /**
 158         Convert @e device X coordinate to logical coordinate, using the current
 159         mapping mode, user scale factor, device origin and axis orientation.
 160     */
 161     wxCoord DeviceToLogicalX(wxCoord x) const;
 162
 163     /**
 164         Convert @e device X coordinate to relative logical coordinate, using the
 165         current mapping mode and user scale factor but ignoring the
 166         axis orientation. Use this for converting a width, for example.
 167     */
 168     wxCoord DeviceToLogicalXRel(wxCoord x) const;
 169
 170     /**
 171         Converts @e device Y coordinate to logical coordinate, using the current
 172         mapping mode, user scale factor, device origin and axis orientation.
 173     */
 174     wxCoord DeviceToLogicalY(wxCoord y) const;
 175
 176     /**
 177         Convert @e device Y coordinate to relative logical coordinate, using the
 178         current mapping mode and user scale factor but ignoring the
 179         axis orientation. Use this for converting a height, for example.
 180     */
 181     wxCoord DeviceToLogicalYRel(wxCoord y) const;
 182
 183     /**
 184         Converts logical X coordinate to device coordinate, using the current
 185         mapping mode, user scale factor, device origin and axis orientation.
 186     */
 187     wxCoord LogicalToDeviceX(wxCoord x) const;
 188
 189     /**
 190         Converts logical X coordinate to relative device coordinate, using the
 191         current mapping mode and user scale factor but ignoring the
 192         axis orientation. Use this for converting a width, for example.
 193     */
 194     wxCoord LogicalToDeviceXRel(wxCoord x) const;
 195
 196     /**
 197         Converts logical Y coordinate to device coordinate, using the current
 198         mapping mode, user scale factor, device origin and axis orientation.
 199     */
 200     wxCoord LogicalToDeviceY(wxCoord y) const;
 201
 202     /**
 203         Converts logical Y coordinate to relative device coordinate, using the
 204         current mapping mode and user scale factor but ignoring the
 205         axis orientation. Use this for converting a height, for example.
 206     */
 207     wxCoord LogicalToDeviceYRel(wxCoord y) const;
 208
 209     //@}
 210
 211
 212
 213     /**
 214         @name Drawing functions
 215     */
 216     //@{
 217
 218     /**
 219         Clears the device context using the current background brush.
 220     */
 221     void Clear();
 222
 223     /**
 224         Draws an arc of a circle, centred on (@a xc, @a yc), with starting
 225         point (@a x1, @a y1) and ending at (@a x2, @a y2). The current pen is
 226         used for the outline and the current brush for filling the shape.
 227
 228         The arc is drawn in a counter-clockwise direction from the start point
 229         to the end point.
 230     */
 231     void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
 232                  wxCoord xc, wxCoord yc);
 233
 234     /**
 235         Draw a bitmap on the device context at the specified point. If
 236         @a transparent is @true and the bitmap has a transparency mask, the
 237         bitmap will be drawn transparently.
 238
 239         When drawing a mono-bitmap, the current text foreground colour will be
 240         used to draw the foreground of the bitmap (all bits set to 1), and the
 241         current text background colour to draw the background (all bits set to
 242         0).
 243
 244         @see SetTextForeground(), SetTextBackground(), wxMemoryDC
 245     */
 246     void DrawBitmap(const wxBitmap& bitmap, wxCoord x, wxCoord y,
 247                     bool useMask = false);
 248
 249     /**
 250         Draws a check mark inside the given rectangle.
 251     */
 252     void DrawCheckMark(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 253
 254     /**
 255         @overload
 256     */
 257     void DrawCheckMark(const wxRect& rect);
 258
 259     /**
 260         Draws a circle with the given centre and radius.
 261
 262         @see DrawEllipse()
 263     */
 264     void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
 265
 266     /**
 267         @overload
 268     */
 269     void DrawCircle(const wxPoint& pt, wxCoord radius);
 270
 271     /**
 272         Draws an ellipse contained in the rectangle specified either with the
 273         given top left corner and the given size or directly. The current pen
 274         is used for the outline and the current brush for filling the shape.
 275
 276         @see DrawCircle()
 277     */
 278     void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 279
 280     /**
 281         @overload
 282     */
 283     void DrawEllipse(const wxPoint& pt, const wxSize& size);
 284
 285     /**
 286         @overload
 287     */
 288     void DrawEllipse(const wxRect& rect);
 289
 290     /**
 291         Draws an arc of an ellipse. The current pen is used for drawing the arc
 292         and the current brush is used for drawing the pie.
 293
 294         @a x and @a y specify the x and y coordinates of the upper-left corner
 295         of the rectangle that contains the ellipse.
 296
 297         @a width and @a height specify the width and height of the rectangle
 298         that contains the ellipse.
 299
 300         @a start and @a end specify the start and end of the arc relative to
 301         the three-o'clock position from the center of the rectangle. Angles are
 302         specified in degrees (360 is a complete circle). Positive values mean
 303         counter-clockwise motion. If @a start is equal to @e end, a complete
 304         ellipse will be drawn.
 305     */
 306     void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord width, wxCoord height,
 307                           double start, double end);
 308
 309     /**
 310         Draw an icon on the display (does nothing if the device context is
 311         PostScript). This can be the simplest way of drawing bitmaps on a
 312         window.
 313     */
 314     void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 315
 316     /**
 317         Draw optional bitmap and the text into the given rectangle and aligns
 318         it as specified by alignment parameter; it also will emphasize the
 319         character with the given index if it is != -1 and return the bounding
 320         rectangle if required.
 321     */
 322     void DrawLabel(const wxString& text, const wxBitmap& image,
 323                    const wxRect& rect,
 324                    int alignment = wxALIGN_LEFT | wxALIGN_TOP,
 325                    int indexAccel = -1, wxRect* rectBounding = NULL);
 326
 327     /**
 328         @overload
 329     */
 330     void DrawLabel(const wxString& text, const wxRect& rect,
 331                    int alignment = wxALIGN_LEFT | wxALIGN_TOP,
 332                    int indexAccel = -1);
 333
 334     /**
 335         Draws a line from the first point to the second. The current pen is
 336         used for drawing the line. Note that the point (@a x2, @a y2) is not
 337         part of the line and is not drawn by this function (this is consistent
 338         with the behaviour of many other toolkits).
 339     */
 340     void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 341
 342     /**
 343         Draws lines using an array of points of size @a n adding the optional
 344         offset coordinate. The current pen is used for drawing the lines.
 345
 346         @beginWxPythonOnly
 347         The wxPython version of this method accepts a Python list of wxPoint
 348         objects.
 349         @endWxPythonOnly
 350     */
 351     void DrawLines(int n, wxPoint points[], wxCoord xoffset = 0,
 352                    wxCoord yoffset = 0);
 353     /**
 354         This method uses a list of wxPoints, adding the optional offset
 355         coordinate. The programmer is responsible for deleting the list of
 356         points.
 357
 358         @beginWxPythonOnly
 359         The wxPython version of this method accepts a Python list of wxPoint
 360         objects.
 361         @endWxPythonOnly
 362     */
 363     void DrawLines(const wxPointList* points,
 364                    wxCoord xoffset = 0, wxCoord yoffset = 0);
 365
 366     /**
 367         Draws a point using the color of the current pen. Note that the other
 368         properties of the pen are not used, such as width.
 369     */
 370     void DrawPoint(wxCoord x, wxCoord y);
 371
 372     /**
 373         Draws a filled polygon using an array of points of size @a n, adding
 374         the optional offset coordinate. The first and last points are
 375         automatically closed.
 376
 377         The last argument specifies the fill rule: @b wxODDEVEN_RULE (the
 378         default) or @b wxWINDING_RULE.
 379
 380         The current pen is used for drawing the outline, and the current brush
 381         for filling the shape. Using a transparent brush suppresses filling.
 382     */
 383     void DrawPolygon(int n, wxPoint points[], wxCoord xoffset = 0,
 384                      wxCoord yoffset = 0,
 385                      wxPolygonFillMode fill_style = wxODDEVEN_RULE);
 386     /**
 387         This method draws a filled polygon using a list of wxPoints, adding the
 388         optional offset coordinate. The first and last points are automatically
 389         closed.
 390
 391         The last argument specifies the fill rule: @b wxODDEVEN_RULE (the
 392         default) or @b wxWINDING_RULE.
 393
 394         The current pen is used for drawing the outline, and the current brush
 395         for filling the shape. Using a transparent brush suppresses filling.
 396
 397         The programmer is responsible for deleting the list of points.
 398
 399         @beginWxPythonOnly
 400         The wxPython version of this method accepts a Python list of wxPoint
 401         objects.
 402         @endWxPythonOnly
 403     */
 404     void DrawPolygon(const wxPointList* points,
 405                      wxCoord xoffset = 0, wxCoord yoffset = 0,
 406                      wxPolygonFillMode fill_style = wxODDEVEN_RULE);
 407
 408     /**
 409         Draws two or more filled polygons using an array of @a points, adding
 410         the optional offset coordinates.
 411
 412         Notice that for the platforms providing a native implementation of this
 413         function (Windows and PostScript-based wxDC currently), this is more
 414         efficient than using DrawPolygon() in a loop.
 415
 416         @a n specifies the number of polygons to draw, the array @e count of
 417         size @a n specifies the number of points in each of the polygons in the
 418         @a points array.
 419
 420         The last argument specifies the fill rule: @b wxODDEVEN_RULE (the
 421         default) or @b wxWINDING_RULE.
 422
 423         The current pen is used for drawing the outline, and the current brush
 424         for filling the shape. Using a transparent brush suppresses filling.
 425
 426         The polygons maybe disjoint or overlapping. Each polygon specified in a
 427         call to DrawPolyPolygon() must be closed. Unlike polygons created by
 428         the DrawPolygon() member function, the polygons created by this
 429         method are not closed automatically.
 430
 431         @beginWxPythonOnly
 432         Not implemented yet.
 433         @endWxPythonOnly
 434     */
 435     void DrawPolyPolygon(int n, int count[], wxPoint points[],
 436                          wxCoord xoffset = 0, wxCoord yoffset = 0,
 437                          wxPolygonFillMode fill_style = wxODDEVEN_RULE);
 438
 439     /**
 440         Draws a rectangle with the given top left corner, and with the given
 441         size.  The current pen is used for the outline and the current brush
 442         for filling the shape.
 443     */
 444     void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 445
 446     /**
 447         Draws the text rotated by @a angle degrees
 448         (positive angles are counterclockwise; the full angle is 360 degrees).
 449
 450         @note Under Win9x only TrueType fonts can be drawn by this function. In
 451               particular, a font different from @c wxNORMAL_FONT should be used
 452               as the latter is not a TrueType font. @c wxSWISS_FONT is an
 453               example of a font which is.
 454
 455         @see DrawText()
 456     */
 457     void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
 458                          double angle);
 459
 460     /**
 461         Draws a rectangle with the given top left corner, and with the given
 462         size. The corners are quarter-circles using the given radius. The
 463         current pen is used for the outline and the current brush for filling
 464         the shape.
 465
 466         If @a radius is positive, the value is assumed to be the radius of the
 467         rounded corner. If @a radius is negative, the absolute value is assumed
 468         to be the @e proportion of the smallest dimension of the rectangle.
 469         This means that the corner can be a sensible size relative to the size
 470         of the rectangle, and also avoids the strange effects X produces when
 471         the corners are too big for the rectangle.
 472     */
 473     void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width,
 474                               wxCoord height, double radius);
 475
 476     /**
 477         Draws a spline between all given points using the current pen.
 478
 479         @beginWxPythonOnly
 480         The wxPython version of this method accepts a Python list of wxPoint
 481         objects.
 482         @endWxPythonOnly
 483     */
 484     void DrawSpline(int n, wxPoint points[]);
 485
 486     /**
 487         @overload
 488     */
 489     void DrawSpline(const wxPointList* points);
 490
 491     /**
 492         @overload
 493     */
 494     void DrawSpline(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
 495                     wxCoord x3, wxCoord y3);
 496
 497     /**
 498         Draws a text string at the specified point, using the current text
 499         font, and the current text foreground and background colours.
 500
 501         The coordinates refer to the top-left corner of the rectangle bounding
 502         the string. See GetTextExtent() for how to get the dimensions of a text
 503         string, which can be used to position the text more precisely.
 504
 505         @note The current @ref GetLogicalFunction() "logical function" is
 506               ignored by this function.
 507     */
 508     void DrawText(const wxString& text, wxCoord x, wxCoord y);
 509
 510     /**
 511         Fill the area specified by rect with a radial gradient, starting from
 512         @a initialColour at the centre of the circle and fading to
 513         @a destColour on the circle outside.
 514
 515         The circle is placed at the centre of @a rect.
 516
 517         @note Currently this function is very slow, don't use it for real-time
 518               drawing.
 519     */
 520     void GradientFillConcentric(const wxRect& rect,
 521                                 const wxColour& initialColour,
 522                                 const wxColour& destColour);
 523
 524     /**
 525         Fill the area specified by rect with a radial gradient, starting from
 526         @a initialColour at the centre of the circle and fading to
 527         @a destColour on the circle outside.
 528
 529         @a circleCenter are the relative coordinates of centre of the circle in
 530         the specified @a rect.
 531
 532         @note Currently this function is very slow, don't use it for real-time
 533               drawing.
 534     */
 535     void GradientFillConcentric(const wxRect& rect,
 536                                 const wxColour& initialColour,
 537                                 const wxColour& destColour,
 538                                 const wxPoint& circleCenter);
 539
 540     /**
 541         Fill the area specified by @a rect with a linear gradient, starting
 542         from @a initialColour and eventually fading to @e destColour.
 543
 544         The @a nDirection specifies the direction of the colour change, default is
 545         to use @a initialColour on the left part of the rectangle and
 546         @a destColour on the right one.
 547     */
 548     void GradientFillLinear(const wxRect& rect, const wxColour& initialColour,
 549                             const wxColour& destColour,
 550                             wxDirection nDirection = wxRIGHT);
 551
 552     /**
 553         Flood fills the device context starting from the given point, using
 554         the current brush colour, and using a style:
 555
 556         - wxFLOOD_SURFACE: The flooding occurs until a colour other than the
 557           given colour is encountered.
 558         - wxFLOOD_BORDER: The area to be flooded is bounded by the given
 559           colour.
 560
 561         @return @false if the operation failed.
 562
 563         @note The present implementation for non-Windows platforms may fail to
 564               find colour borders if the pixels do not match the colour
 565               exactly. However the function will still return @true.
 566     */
 567     bool FloodFill(wxCoord x, wxCoord y, const wxColour& colour,
 568                    wxFloodFillStyle style = wxFLOOD_SURFACE);
 569
 570     /**
 571         Displays a cross hair using the current pen. This is a vertical and
 572         horizontal line the height and width of the window, centred on the
 573         given point.
 574     */
 575     void CrossHair(wxCoord x, wxCoord y);
 576
 577     //@}
 578
 579
 580     /**
 581         @name Clipping region functions
 582     */
 583     //@{
 584
 585     /**
 586         Destroys the current clipping region so that none of the DC is clipped.
 587
 588         @see SetClippingRegion()
 589     */
 590     void DestroyClippingRegion();
 591
 592     /**
 593         Gets the rectangle surrounding the current clipping region.
 594
 595         @beginWxPythonOnly
 596         No arguments are required and the four values defining the rectangle
 597         are returned as a tuple.
 598         @endWxPythonOnly
 599     */
 600     void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *width, wxCoord *height) const;
 601
 602     /**
 603         Sets the clipping region for this device context to the intersection of
 604         the given region described by the parameters of this method and the
 605         previously set clipping region. You should call DestroyClippingRegion()
 606         if you want to set the clipping region exactly to the region specified.
 607
 608         The clipping region is an area to which drawing is restricted. Possible
 609         uses for the clipping region are for clipping text or for speeding up
 610         window redraws when only a known area of the screen is damaged.
 611
 612         @see DestroyClippingRegion(), wxRegion
 613     */
 614     void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 615
 616     /**
 617         @overload
 618     */
 619     void SetClippingRegion(const wxPoint& pt, const wxSize& sz);
 620
 621     /**
 622         @overload
 623     */
 624     void SetClippingRegion(const wxRect& rect);
 625
 626     /**
 627         Sets the clipping region for this device context.
 628
 629         Unlike SetClippingRegion(), this function works with physical
 630         coordinates and not with the logical ones.
 631      */
 632     void SetDeviceClippingRegion(const wxRegion& region);
 633
 634     //@}
 635
 636
 637     /**
 638         @name Text/character extent functions
 639     */
 640     //@{
 641
 642     /**
 643         Gets the character height of the currently set font.
 644     */
 645     wxCoord GetCharHeight() const;
 646
 647     /**
 648         Gets the average character width of the currently set font.
 649     */
 650     wxCoord GetCharWidth() const;
 651
 652     /**
 653         Gets the dimensions of the string using the currently selected font.
 654         @a string is the text string to measure, @e heightLine, if non @NULL,
 655         is where to store the height of a single line.
 656
 657         The text extent is set in the given @a w and @a h pointers.
 658
 659         If the optional parameter @a font is specified and valid, then it is
 660         used for the text extent calculation, otherwise the currently selected
 661         font is used.
 662
 663         @note This function works with both single-line and multi-line strings.
 664
 665         @see wxFont, SetFont(), GetPartialTextExtents(), GetTextExtent()
 666     */
 667     void GetMultiLineTextExtent(const wxString& string, wxCoord* w,
 668                                 wxCoord* h,
 669                                 wxCoord* heightLine = NULL,
 670                                 const wxFont* font = NULL) const;
 671     /**
 672         Gets the dimensions of the string using the currently selected font.
 673         @a string is the text string to measure, @e heightLine, if non @NULL,
 674         is where to store the height of a single line.
 675
 676         @return The text extent as a wxSize object.
 677
 678         @note This function works with both single-line and multi-line strings.
 679
 680         @see wxFont, SetFont(), GetPartialTextExtents(), GetTextExtent()
 681     */
 682     wxSize GetMultiLineTextExtent(const wxString& string) const;
 683
 684     /**
 685         Fills the @a widths array with the widths from the beginning of @a text
 686         to the corresponding character of @a text. The generic version simply
 687         builds a running total of the widths of each character using
 688         GetTextExtent(), however if the various platforms have a native API
 689         function that is faster or more accurate than the generic
 690         implementation then it should be used instead.
 691
 692         @beginWxPythonOnly
 693         This method only takes the @a text parameter and returns a Python list
 694         of integers.
 695         @endWxPythonOnly
 696
 697         @see GetMultiLineTextExtent(), GetTextExtent()
 698     */
 699     bool GetPartialTextExtents(const wxString& text,
 700                                wxArrayInt& widths) const;
 701
 702     /**
 703         Gets the dimensions of the string using the currently selected font.
 704         @a string is the text string to measure, @a descent is the dimension
 705         from the baseline of the font to the bottom of the descender, and
 706         @a externalLeading is any extra vertical space added to the font by the
 707         font designer (usually is zero).
 708
 709         The text extent is returned in @a w and @a h pointers or as a wxSize
 710         object depending on which version of this function is used.
 711
 712         If the optional parameter @a font is specified and valid, then it is
 713         used for the text extent calculation. Otherwise the currently selected
 714         font is.
 715
 716         @note This function only works with single-line strings.
 717
 718         @beginWxPythonOnly
 719         The following methods are implemented in wxPython:
 720         - GetTextExtent(string) - Returns a 2-tuple, (width, height).
 721         - GetFullTextExtent(string, font=NULL) -
 722             Returns a 4-tuple, (width, height, descent, externalLeading).
 723         @endWxPythonOnly
 724
 725         @see wxFont, SetFont(), GetPartialTextExtents(),
 726              GetMultiLineTextExtent()
 727     */
 728     void GetTextExtent(const wxString& string, wxCoord* w, wxCoord* h,
 729                        wxCoord* descent = NULL,
 730                        wxCoord* externalLeading = NULL,
 731                        const wxFont* font = NULL) const;
 732
 733     /**
 734         @overload
 735     */
 736     wxSize GetTextExtent(const wxString& string) const;
 737
 738     //@}
 739
 740
 741     /**
 742         @name Text properties functions
 743     */
 744     //@{
 745
 746     /**
 747         Returns the current background mode: @c wxSOLID or @c wxTRANSPARENT.
 748
 749         @see SetBackgroundMode()
 750     */
 751     int GetBackgroundMode() const;
 752
 753     /**
 754         Gets the current font.
 755
 756         Notice that even although each device context object has some default font
 757         after creation, this method would return a ::wxNullFont initially and only
 758         after calling SetFont() a valid font is returned.
 759     */
 760     const wxFont& GetFont() const;
 761
 762     /**
 763         Gets the current layout direction of the device context. On platforms
 764         where RTL layout is supported, the return value will either be
 765         @c wxLayout_LeftToRight or @c wxLayout_RightToLeft. If RTL layout is
 766         not supported, the return value will be @c wxLayout_Default.
 767
 768         @see SetLayoutDirection()
 769     */
 770     wxLayoutDirection GetLayoutDirection() const;
 771
 772     /**
 773         Gets the current text background colour.
 774
 775         @see SetTextBackground()
 776     */
 777     const wxColour& GetTextBackground() const;
 778
 779     /**
 780         Gets the current text foreground colour.
 781
 782         @see SetTextForeground()
 783     */
 784     const wxColour& GetTextForeground() const;
 785
 786     /**
 787         @a mode may be one of @c wxSOLID and @c wxTRANSPARENT.
 788
 789         This setting determines whether text will be drawn with a background
 790         colour or not.
 791     */
 792     void SetBackgroundMode(int mode);
 793
 794     /**
 795         Sets the current font for the DC.
 796
 797         If the argument is ::wxNullFont (or another invalid font; see wxFont::IsOk),
 798         the current font is selected out of the device context (leaving wxDC without
 799         any valid font), allowing the current font to be destroyed safely.
 800
 801         @see wxFont
 802     */
 803     void SetFont(const wxFont& font);
 804
 805     /**
 806         Sets the current text background colour for the DC.
 807     */
 808     void SetTextBackground(const wxColour& colour);
 809
 810     /**
 811         Sets the current text foreground colour for the DC.
 812
 813         @see wxMemoryDC for the interpretation of colours when drawing into a
 814              monochrome bitmap.
 815     */
 816     void SetTextForeground(const wxColour& colour);
 817
 818     /**
 819         Sets the current layout direction for the device context.
 820
 821         @param dir
 822            May be either @c wxLayout_Default, @c wxLayout_LeftToRight or
 823            @c wxLayout_RightToLeft.
 824
 825         @see GetLayoutDirection()
 826     */
 827     void SetLayoutDirection(wxLayoutDirection dir);
 828
 829     //@}
 830
 831
 832     /**
 833         @name Bounding box functions
 834     */
 835     //@{
 836
 837     /**
 838         Adds the specified point to the bounding box which can be retrieved
 839         with MinX(), MaxX() and MinY(), MaxY() functions.
 840
 841         @see ResetBoundingBox()
 842     */
 843     void CalcBoundingBox(wxCoord x, wxCoord y);
 844
 845     /**
 846         Gets the maximum horizontal extent used in drawing commands so far.
 847     */
 848     wxCoord MaxX() const;
 849
 850     /**
 851         Gets the maximum vertical extent used in drawing commands so far.
 852     */
 853     wxCoord MaxY() const;
 854
 855     /**
 856         Gets the minimum horizontal extent used in drawing commands so far.
 857     */
 858     wxCoord MinX() const;
 859
 860     /**
 861         Gets the minimum vertical extent used in drawing commands so far.
 862     */
 863     wxCoord MinY() const;
 864
 865     /**
 866         Resets the bounding box: after a call to this function, the bounding
 867         box doesn't contain anything.
 868
 869         @see CalcBoundingBox()
 870     */
 871     void ResetBoundingBox();
 872
 873     //@}
 874
 875
 876     /**
 877         @name Page and document start/end functions
 878     */
 879     //@{
 880
 881     /**
 882         Starts a document (only relevant when outputting to a printer).
 883         @a message is a message to show while printing.
 884     */
 885     bool StartDoc(const wxString& message);
 886
 887     /**
 888         Starts a document page (only relevant when outputting to a printer).
 889     */
 890     void StartPage();
 891
 892     /**
 893         Ends a document (only relevant when outputting to a printer).
 894     */
 895     void EndDoc();
 896
 897     /**
 898         Ends a document page (only relevant when outputting to a printer).
 899     */
 900     void EndPage();
 901
 902     //@}
 903
 904
 905     /**
 906         @name Bit-Block Transfer operations (blit)
 907     */
 908     //@{
 909
 910     /**
 911         Copy from a source DC to this DC, specifying the destination
 912         coordinates, size of area to copy, source DC, source coordinates,
 913         logical function, whether to use a bitmap mask, and mask source
 914         position.
 915
 916         @param xdest
 917             Destination device context x position.
 918         @param ydest
 919             Destination device context y position.
 920         @param width
 921             Width of source area to be copied.
 922         @param height
 923             Height of source area to be copied.
 924         @param source
 925             Source device context.
 926         @param xsrc
 927             Source device context x position.
 928         @param ysrc
 929             Source device context y position.
 930         @param logicalFunc
 931             Logical function to use, see SetLogicalFunction().
 932         @param useMask
 933             If @true, Blit does a transparent blit using the mask that is
 934             associated with the bitmap selected into the source device context.
 935             The Windows implementation does the following if MaskBlt cannot be
 936             used:
 937             <ol>
 938             <li>Creates a temporary bitmap and copies the destination area into
 939                 it.</li>
 940             <li>Copies the source area into the temporary bitmap using the
 941                 specified logical function.</li>
 942             <li>Sets the masked area in the temporary bitmap to BLACK by ANDing
 943                 the mask bitmap with the temp bitmap with the foreground colour
 944                 set to WHITE and the bg colour set to BLACK.</li>
 945             <li>Sets the unmasked area in the destination area to BLACK by
 946                 ANDing the mask bitmap with the destination area with the
 947                 foreground colour set to BLACK and the background colour set to
 948                 WHITE.</li>
 949             <li>ORs the temporary bitmap with the destination area.</li>
 950             <li>Deletes the temporary bitmap.</li>
 951             </ol>
 952             This sequence of operations ensures that the source's transparent
 953             area need not be black, and logical functions are supported.
 954             @n @b Note: on Windows, blitting with masks can be speeded up
 955             considerably by compiling wxWidgets with the wxUSE_DC_CACHE option
 956             enabled. You can also influence whether MaskBlt or the explicit
 957             mask blitting code above is used, by using wxSystemOptions and
 958             setting the @c no-maskblt option to 1.
 959         @param xsrcMask
 960             Source x position on the mask. If both xsrcMask and ysrcMask are
 961             @c -1, xsrc and ysrc will be assumed for the mask source position.
 962             Currently only implemented on Windows.
 963         @param ysrcMask
 964             Source y position on the mask. If both xsrcMask and ysrcMask are
 965             @c -1, xsrc and ysrc will be assumed for the mask source position.
 966             Currently only implemented on Windows.
 967
 968         @remarks There is partial support for Blit() in wxPostScriptDC, under X.
 969
 970         @see StretchBlit(), wxMemoryDC, wxBitmap, wxMask
 971     */
 972     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width,
 973               wxCoord height, wxDC* source, wxCoord xsrc, wxCoord ysrc,
 974               wxRasterOperationMode logicalFunc = wxCOPY, bool useMask = false,
 975               wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
 976
 977     /**
 978         Copy from a source DC to this DC, specifying the destination
 979         coordinates, destination size, source DC, source coordinates, size of
 980         source area to copy, logical function, whether to use a bitmap mask,
 981         and mask source position.
 982
 983         @param xdest
 984             Destination device context x position.
 985         @param ydest
 986             Destination device context y position.
 987         @param dstWidth
 988             Width of destination area.
 989         @param dstHeight
 990             Height of destination area.
 991         @param source
 992             Source device context.
 993         @param xsrc
 994             Source device context x position.
 995         @param ysrc
 996             Source device context y position.
 997         @param srcWidth
 998             Width of source area to be copied.
 999         @param srcHeight
1000             Height of source area to be copied.
1001         @param logicalFunc
1002             Logical function to use, see SetLogicalFunction().
1003         @param useMask
1004             If @true, Blit does a transparent blit using the mask that is
1005             associated with the bitmap selected into the source device context.
1006             The Windows implementation does the following if MaskBlt cannot be
1007             used:
1008             <ol>
1009             <li>Creates a temporary bitmap and copies the destination area into
1010                 it.</li>
1011             <li>Copies the source area into the temporary bitmap using the
1012                 specified logical function.</li>
1013             <li>Sets the masked area in the temporary bitmap to BLACK by ANDing
1014                 the mask bitmap with the temp bitmap with the foreground colour
1015                 set to WHITE and the bg colour set to BLACK.</li>
1016             <li>Sets the unmasked area in the destination area to BLACK by
1017                 ANDing the mask bitmap with the destination area with the
1018                 foreground colour set to BLACK and the background colour set to
1019                 WHITE.</li>
1020             <li>ORs the temporary bitmap with the destination area.</li>
1021             <li>Deletes the temporary bitmap.</li>
1022             </ol>
1023             This sequence of operations ensures that the source's transparent
1024             area need not be black, and logical functions are supported.
1025             @n @b Note: on Windows, blitting with masks can be speeded up
1026             considerably by compiling wxWidgets with the wxUSE_DC_CACHE option
1027             enabled. You can also influence whether MaskBlt or the explicit
1028             mask blitting code above is used, by using wxSystemOptions and
1029             setting the @c no-maskblt option to 1.
1030         @param xsrcMask
1031             Source x position on the mask. If both xsrcMask and ysrcMask are
1032             wxDefaultCoord, @a xsrc and @a ysrc will be assumed for the mask
1033             source position. Currently only implemented on Windows.
1034         @param ysrcMask
1035             Source y position on the mask. If both xsrcMask and ysrcMask are
1036             wxDefaultCoord, @a xsrc and @a ysrc will be assumed for the mask
1037             source position. Currently only implemented on Windows.
1038
1039         There is partial support for Blit() in wxPostScriptDC, under X.
1040
1041         StretchBlit() is only implemented under wxMAC and wxMSW.
1042
1043         See wxMemoryDC for typical usage.
1044
1045         @since 2.9.0
1046
1047         @see Blit(), wxMemoryDC, wxBitmap, wxMask
1048     */
1049     bool StretchBlit(wxCoord xdest, wxCoord ydest,
1050                      wxCoord dstWidth, wxCoord dstHeight,
1051                      wxDC* source, wxCoord xsrc, wxCoord ysrc,
1052                      wxCoord srcWidth, wxCoord srcHeight,
1053                      wxRasterOperationMode logicalFunc = wxCOPY,
1054                      bool useMask = false,
1055                      wxCoord xsrcMask = wxDefaultCoord,
1056                      wxCoord ysrcMask = wxDefaultCoord);
1057     //@}
1058
1059
1060     /**
1061         @name Background/foreground brush and pen
1062     */
1063     //@{
1064
1065     /**
1066         Gets the brush used for painting the background.
1067
1068         @see wxDC::SetBackground()
1069     */
1070     const wxBrush& GetBackground() const;
1071
1072     /**
1073         Gets the current brush.
1074
1075         @see wxDC::SetBrush()
1076     */
1077     const wxBrush& GetBrush() const;
1078
1079     /**
1080         Gets the current pen.
1081
1082         @see SetPen()
1083     */
1084     const wxPen& GetPen() const;
1085
1086     /**
1087         Sets the current background brush for the DC.
1088     */
1089     void SetBackground(const wxBrush& brush);
1090
1091     /**
1092         Sets the current brush for the DC.
1093
1094         If the argument is ::wxNullBrush (or another invalid brush; see wxBrush::IsOk),
1095         the current brush is selected out of the device context (leaving wxDC without
1096         any valid brush), allowing the current brush to be destroyed safely.
1097
1098         @see wxBrush, wxMemoryDC (for the interpretation of colours when
1099              drawing into a monochrome bitmap)
1100     */
1101     void SetBrush(const wxBrush& brush);
1102
1103     /**
1104         Sets the current pen for the DC.
1105
1106         If the argument is ::wxNullPen (or another invalid pen; see wxPen::IsOk),
1107         the current pen is selected out of the device context (leaving wxDC without any
1108         valid pen), allowing the current pen to be destroyed safely.
1109
1110         @see wxMemoryDC for the interpretation of colours when drawing into a
1111              monochrome bitmap.
1112     */
1113     void SetPen(const wxPen& pen);
1114
1115     //@}
1116
1117
1118
1119     /**
1120         Returns the depth (number of bits/pixel) of this DC.
1121
1122         @see wxDisplayDepth()
1123     */
1124     int GetDepth() const;
1125
1126     /**
1127         Returns the current device origin.
1128
1129         @see SetDeviceOrigin()
1130     */
1131     wxPoint GetDeviceOrigin() const;
1132
1133     /**
1134         Gets the current logical function.
1135
1136         @see SetLogicalFunction()
1137     */
1138     wxRasterOperationMode GetLogicalFunction() const;
1139
1140     /**
1141         Gets the current mapping mode for the device context.
1142
1143         @see SetMapMode()
1144     */
1145     wxMappingMode GetMapMode() const;
1146
1147     /**
1148         Gets in @a colour the colour at the specified location. Not available
1149         for wxPostScriptDC or wxMetafileDC.
1150
1151         @note Setting a pixel can be done using DrawPoint().
1152
1153         @beginWxPythonOnly
1154         The wxColour value is returned and is not required as a parameter.
1155         @endWxPythonOnly
1156     */
1157     bool GetPixel(wxCoord x, wxCoord y, wxColour* colour) const;
1158
1159     /**
1160         Returns the resolution of the device in pixels per inch.
1161     */
1162     wxSize GetPPI() const;
1163
1164     /**
1165         Gets the horizontal and vertical extent of this device context in @e device units.
1166         It can be used to scale graphics to fit the page.
1167
1168         For example, if @e maxX and @e maxY represent the maximum horizontal
1169         and vertical 'pixel' values used in your application, the following
1170         code will scale the graphic to fit on the printer page:
1171
1172         @code
1173         wxCoord w, h;
1174         dc.GetSize(&w, &h);
1175         double scaleX = (double)(maxX / w);
1176         double scaleY = (double)(maxY / h);
1177         dc.SetUserScale(min(scaleX, scaleY),min(scaleX, scaleY));
1178         @endcode
1179
1180         @beginWxPythonOnly
1181         In place of a single overloaded method name, wxPython implements the
1182         following methods:
1183         - GetSize() - Returns a wxSize.
1184         - GetSizeWH() - Returns a 2-tuple (width, height).
1185         @endWxPythonOnly
1186     */
1187     void GetSize(wxCoord* width, wxCoord* height) const;
1188
1189     /**
1190         @overload
1191     */
1192     wxSize GetSize() const;
1193
1194     /**
1195         Returns the horizontal and vertical resolution in millimetres.
1196     */
1197     void GetSizeMM(wxCoord* width, wxCoord* height) const;
1198
1199     /**
1200         @overload
1201     */
1202     wxSize GetSizeMM() const;
1203
1204     /**
1205         Gets the current user scale factor.
1206
1207         @see SetUserScale()
1208     */
1209     void GetUserScale(double* x, double* y) const;
1210
1211     /**
1212         Returns @true if the DC is ok to use.
1213     */
1214     bool IsOk() const;
1215
1216     /**
1217         Sets the x and y axis orientation (i.e., the direction from lowest to
1218         highest values on the axis). The default orientation is x axis from
1219         left to right and y axis from top down.
1220
1221         @param xLeftRight
1222             True to set the x axis orientation to the natural left to right
1223             orientation, @false to invert it.
1224         @param yBottomUp
1225             True to set the y axis orientation to the natural bottom up
1226             orientation, @false to invert it.
1227     */
1228     void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
1229
1230     /**
1231         Sets the device origin (i.e., the origin in pixels after scaling has
1232         been applied). This function may be useful in Windows printing
1233         operations for placing a graphic on a page.
1234     */
1235     void SetDeviceOrigin(wxCoord x, wxCoord y);
1236
1237     /**
1238         Sets the current logical function for the device context.
1239         It determines how a @e source pixel (from a pen or brush colour, or source
1240         device context if using Blit()) combines with a @e destination pixel in
1241         the current device context.
1242         Text drawing is not affected by this function.
1243
1244         See ::wxRasterOperationMode enumeration values for more info.
1245
1246         The default is @c wxCOPY, which simply draws with the current colour.
1247         The others combine the current colour and the background using a logical
1248         operation. @c wxINVERT is commonly used for drawing rubber bands or moving
1249         outlines, since drawing twice reverts to the original colour.
1250     */
1251     void SetLogicalFunction(wxRasterOperationMode function);
1252
1253     /**
1254         The mapping mode of the device context defines the unit of measurement
1255         used to convert @e logical units to @e device units.
1256
1257         Note that in X, text drawing isn't handled consistently with the mapping mode;
1258         a font is always specified in point size. However, setting the user scale (see
1259         SetUserScale()) scales the text appropriately. In Windows, scalable
1260         TrueType fonts are always used; in X, results depend on availability of
1261         fonts, but usually a reasonable match is found.
1262
1263         The coordinate origin is always at the top left of the screen/printer.
1264
1265         Drawing to a Windows printer device context uses the current mapping
1266         mode, but mapping mode is currently ignored for PostScript output.
1267     */
1268     void SetMapMode(wxMappingMode mode);
1269
1270     /**
1271         If this is a window DC or memory DC, assigns the given palette to the
1272         window or bitmap associated with the DC. If the argument is
1273         ::wxNullPalette, the current palette is selected out of the device
1274         context, and the original palette restored.
1275
1276         @see wxPalette
1277     */
1278     void SetPalette(const wxPalette& palette);
1279
1280     /**
1281         Sets the user scaling factor, useful for applications which require
1282         'zooming'.
1283     */
1284     void SetUserScale(double xScale, double yScale);
1285 };
1286
1287
1288
1289 /**
1290     @class wxDCClipper
1291
1292     wxDCClipper is a small helper class for setting a clipping region on a wxDC
1293     and unsetting it automatically. An object of wxDCClipper class is typically
1294     created on the stack so that it is automatically destroyed when the object
1295     goes out of scope. A typical usage example:
1296
1297     @code
1298     void MyFunction(wxDC& dc)
1299     {
1300         wxDCClipper clip(dc, rect);
1301         // ... drawing functions here are affected by clipping rect ...
1302     }
1303
1304     void OtherFunction()
1305     {
1306         wxDC dc;
1307         MyFunction(dc);
1308         // ... drawing functions here are not affected by clipping rect ...
1309     }
1310     @endcode
1311
1312     @library{wxcore}
1313     @category{gdi}
1314
1315     @see wxDC::SetClippingRegion(), wxDCFontChanger, wxDCTextColourChanger, wxDCPenChanger,
1316          wxDCBrushChanger
1317 */
1318 class wxDCClipper
1319 {
1320 public:
1321     //@{
1322     /**
1323         Sets the clipping region to the specified region/coordinates.
1324
1325         The clipping region is automatically unset when this object is destroyed.
1326     */
1327     wxDCClipper(wxDC& dc, const wxRegion& r);
1328     wxDCClipper(wxDC& dc, const wxRect& rect);
1329     wxDCClipper(wxDC& dc, wxCoord x, wxCoord y, wxCoord w, wxCoord h);
1330     //@}
1331
1332     /**
1333         Destroys the clipping region associated with the DC passed to the ctor.
1334     */
1335     ~wxDCClipper();
1336 };
1337
1338
1339 /**
1340     @class wxDCBrushChanger
1341
1342     wxDCBrushChanger is a small helper class for setting a brush on a wxDC
1343     and unsetting it automatically in the destructor, restoring the previous one.
1344
1345     @library{wxcore}
1346     @category{gdi}
1347
1348     @see wxDC::SetBrush(), wxDCFontChanger, wxDCTextColourChanger, wxDCPenChanger,
1349          wxDCClipper
1350 */
1351 class wxDCBrushChanger
1352 {
1353 public:
1354     /**
1355         Sets @a brush on the given @a dc, storing the old one.
1356
1357         @param dc
1358             The DC where the brush must be temporary set.
1359         @param brush
1360             The brush to set.
1361     */
1362     wxDCBrushChanger(wxDC& dc, const wxBrush& brush);
1363
1364     /**
1365         Restores the brush originally selected in the DC passed to the ctor.
1366     */
1367     ~wxDCBrushChanger();
1368 };
1369
1370
1371 /**
1372     @class wxDCPenChanger
1373
1374     wxDCPenChanger is a small helper class for setting a pen on a wxDC
1375     and unsetting it automatically in the destructor, restoring the previous one.
1376
1377     @library{wxcore}
1378     @category{gdi}
1379
1380     @see wxDC::SetPen(), wxDCFontChanger, wxDCTextColourChanger, wxDCBrushChanger,
1381          wxDCClipper
1382 */
1383 class wxDCPenChanger
1384 {
1385 public:
1386     /**
1387         Sets @a pen on the given @a dc, storing the old one.
1388
1389         @param dc
1390             The DC where the pen must be temporary set.
1391         @param pen
1392             The pen to set.
1393     */
1394     wxDCPenChanger(wxDC& dc, const wxPen& pen);
1395
1396     /**
1397         Restores the pen originally selected in the DC passed to the ctor.
1398     */
1399     ~wxDCPenChanger();
1400 };
1401
1402
1403
1404 /**
1405     @class wxDCTextColourChanger
1406
1407     wxDCTextColourChanger is a small helper class for setting a foreground
1408     text colour on a wxDC and unsetting it automatically in the destructor,
1409     restoring the previous one.
1410
1411     @library{wxcore}
1412     @category{gdi}
1413
1414     @see wxDC::SetTextForeground(), wxDCFontChanger, wxDCPenChanger, wxDCBrushChanger,
1415          wxDCClipper
1416 */
1417 class wxDCTextColourChanger
1418 {
1419 public:
1420     /**
1421         Sets @a col on the given @a dc, storing the old one.
1422
1423         @param dc
1424             The DC where the colour must be temporary set.
1425         @param col
1426             The colour to set.
1427     */
1428     wxDCTextColourChanger(wxDC& dc, const wxColour& col);
1429
1430     /**
1431         Restores the colour originally selected in the DC passed to the ctor.
1432     */
1433     ~wxDCTextColourChanger();
1434 };
1435
1436
1437
1438 /**
1439     @class wxDCFontChanger
1440
1441     wxDCFontChanger is a small helper class for setting a font on a wxDC and
1442     unsetting it automatically in the destructor, restoring the previous one.
1443
1444     @since 2.9.0
1445
1446     @library{wxcore}
1447     @category{gdi}
1448
1449     @see wxDC::SetFont(), wxDCTextColourChanger, wxDCPenChanger, wxDCBrushChanger,
1450          wxDCClipper
1451 */
1452 class wxDCFontChanger
1453 {
1454 public:
1455     /**
1456         Sets @a font on the given @a dc, storing the old one.
1457
1458         @param dc
1459             The DC where the font must be temporary set.
1460         @param font
1461             The font to set.
1462     */
1463     wxDCFontChanger(wxDC& dc, const wxFont& font);
1464
1465     /**
1466         Restores the colour originally selected in the DC passed to the ctor.
1467     */
1468     ~wxDCFontChanger();
1469 };
1470