allow to optionally use vendor name component in standard paths (slightly modified...

[wxWidgets.git] / docs / latex / wx / dc.tex

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index f2f55be06f1a7ae6659bb261031e31c4a824f931..fdc1c815be7b4e3ccf46d3e80025dfc361f9cb0c 100644 (file)
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -6,8 +6,10 @@ so a window can have a device context associated with it, and a printer also has
 In this way, the same piece of code may write to a number of different devices,
 if the device context is used as a parameter.
 
 In this way, the same piece of code may write to a number of different devices,
 if the device context is used as a parameter.
 

-Derived types of wxDC have documentation for specific features
-only, so refer to this section for most device context information.
+Notice that wxDC is an abstract base class and can't be created directly,
+please use \helpref{wxPaintDC}{wxpaintdc}, \helpref{wxClientDC}{wxclientdc}, 
+\helpref{wxWindowDC}{wxwindowdc}, \helpref{wxScreenDC}{wxscreendc}, 
+\helpref{wxMemoryDC}{wxmemorydc} or \helpref{wxPrinterDC}{wxprinterdc}.

 
 % VZ: we should really document them instead of this lame excuse, but I don't
 %     have time for it now, when it is done please remove this
 
 % VZ: we should really document them instead of this lame excuse, but I don't
 %     have time for it now, when it is done please remove this


@@ -16,6 +18,12 @@ there are also versions which accept single {\tt wxPoint} parameter instead of
 two {\tt wxCoord} ones or {\tt wxPoint} and {\tt wxSize} instead of four of
 them.
 
 two {\tt wxCoord} ones or {\tt wxPoint} and {\tt wxSize} instead of four of
 them.
 

+\wxheading{Support for Transparency / Alpha Channel}
+
+On Mac OS X when using Core Graphics (wx\_MAC\_USE\_CORE\_GRAPHICS set to 1) 
+colors with alpha are supported, so instances  {\tt wxPen} or  {\tt wxBrush} that are built from  {\tt wxColour} use
+the color's alpha values when stroking or filling.
+

 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}


@@ -24,44 +32,22 @@ them.
 
 <wx/dc.h>
 
 
 <wx/dc.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{Overview}{dcoverview}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \wxheading{See also}
 
 \helpref{Overview}{dcoverview}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxDC::wxDC}
-
-\func{}{wxDC}{\void}
-
-Constructor.
-
-\membersection{wxDC::\destruct{wxDC}}
-
-\func{}{\destruct{wxDC}}{\void}
-
-Destructor.
-
-\membersection{wxDC::BeginDrawing}\label{wxdcbegindrawing}
-
-\func{void}{BeginDrawing}{\void}
-
-Allows optimization of drawing code under MS Windows. Enclose
-drawing primitives between {\bf BeginDrawing} and {\bf EndDrawing}\rtfsp
-calls.
-
-Drawing to a wxDialog panel device context outside of a
-system-generated OnPaint event {\it requires} this pair of calls to
-enclose drawing code. This is because a Windows dialog box does not have
-a retained device context associated with it, and selections such as pen
-and brush settings would be lost if the device context were obtained and
-released for each drawing operation.

 
 \membersection{wxDC::Blit}\label{wxdcblit}
 
 \func{bool}{Blit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
   \param{wxDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{int}{ logicalFunc = wxCOPY},
 
 \membersection{wxDC::Blit}\label{wxdcblit}
 
 \func{bool}{Blit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
   \param{wxDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{int}{ logicalFunc = wxCOPY},

-  \param{bool }{useMask = FALSE}, \param{wxCoord}{ xsrcMask = -1}, \param{wxCoord}{ ysrcMask = -1}}
+  \param{bool }{useMask = false}, \param{wxCoord}{ xsrcMask = -1}, \param{wxCoord}{ ysrcMask = -1}}

 
 Copy from a source DC to this DC, specifying the destination
 coordinates, size of area to copy, source DC, source coordinates,
 
 Copy from a source DC to this DC, specifying the destination
 coordinates, size of area to copy, source DC, source coordinates,


@@ -85,7 +71,7 @@ logical function, whether to use a bitmap mask, and mask source position.
 
 \docparam{logicalFunc}{Logical function to use: see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}.}
 
 
 \docparam{logicalFunc}{Logical function to use: see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}.}
 

-\docparam{useMask}{If TRUE, Blit does a transparent blit using the mask that is associated with the bitmap
+\docparam{useMask}{If true, Blit does a transparent blit using the mask that is associated with the bitmap

 selected into the source device context. The Windows implementation does the following if MaskBlt cannot be used:
 
 \begin{enumerate}
 selected into the source device context. The Windows implementation does the following if MaskBlt cannot be used:
 
 \begin{enumerate}


@@ -105,7 +91,7 @@ This sequence of operations ensures that the source's transparent area need not
 and logical functions are supported.
 
 {\bf Note:} on Windows, blitting with masks can be speeded up considerably by compiling
 and logical functions are supported.
 
 {\bf Note:} on Windows, blitting with masks can be speeded up considerably by compiling

-wxWindows with the wxUSE\_DC\_CACHE option enabled. You can also influence whether MaskBlt
+wxWidgets with the wxUSE\_DC\_CACHE option enabled. You can also influence whether MaskBlt

 or the explicit mask blitting code above is used, by using \helpref{wxSystemOptions}{wxsystemoptions} and
 setting the {\bf no-maskblt} option to 1.
 
 or the explicit mask blitting code above is used, by using \helpref{wxSystemOptions}{wxsystemoptions} and
 setting the {\bf no-maskblt} option to 1.
 


@@ -126,14 +112,15 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}
+\helpref{wxDC::StretchBlit}{wxdcstretchblit}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}

 
 \begin{comment}
 
 \begin{comment}

+

 \membersection{wxDC::CacheEnabled}\label{wxdccacheenabled}
 
 \func{static bool}{CacheEnabled}{\void}
 
 \membersection{wxDC::CacheEnabled}\label{wxdccacheenabled}
 
 \func{static bool}{CacheEnabled}{\void}
 

-On supported platforms (currently only Windows), returns TRUE
+On supported platforms (currently only Windows), returns true

 if the DC cache is enabled. The DC cache
 can speed up the \helpref{Blit}{wxdcblit} operation when
 drawing a large number of masked bitmaps.
 if the DC cache is enabled. The DC cache
 can speed up the \helpref{Blit}{wxdcblit} operation when
 drawing a large number of masked bitmaps.


@@ -146,6 +133,7 @@ wxUSE\_DC\_CACHEING preprocessor symbol for portability.
 \helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::ClearCache}
 \end{comment}
 
 \helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::ClearCache}
 \end{comment}
 

+

 \membersection{wxDC::CalcBoundingBox}\label{wxdccalcboundingbox}
 
 \func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}}
 \membersection{wxDC::CalcBoundingBox}\label{wxdccalcboundingbox}
 
 \func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}}


@@ -158,6 +146,7 @@ Adds the specified point to the bounding box which can be retrieved with
 
 \helpref{ResetBoundingBox}{wxdcresetboundingbox}
 
 
 \helpref{ResetBoundingBox}{wxdcresetboundingbox}
 

+

 \membersection{wxDC::Clear}\label{wxdcclear}
 
 \func{void}{Clear}{\void}
 \membersection{wxDC::Clear}\label{wxdcclear}
 
 \func{void}{Clear}{\void}


@@ -165,6 +154,7 @@ Adds the specified point to the bounding box which can be retrieved with
 Clears the device context using the current background brush.
 
 \begin{comment}
 Clears the device context using the current background brush.
 
 \begin{comment}

+

 \membersection{wxDC::ClearCache}\label{wxdcclearcache}
 
 \func{static void}{ClearCache}{\void}
 \membersection{wxDC::ClearCache}\label{wxdcclearcache}
 
 \func{static void}{ClearCache}{\void}


@@ -184,6 +174,16 @@ wxUSE\_DC\_CACHEING preprocessor symbol for portability.
 \helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::CacheEnabled}
 \end{comment}
 
 \helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::CacheEnabled}
 \end{comment}
 

+
+\membersection{wxDC::ComputeScaleAndOrigin}\label{wxdccomputescaleandorigin}
+
+\func{virtual void}{ComputeScaleAndOrigin}{\void}
+
+Performs all necessary computations for given platform and context type
+after each change of scale and origin parameters. Usually called automatically 
+internally after such changes.
+
+

 \membersection{wxDC::CrossHair}\label{wxdccrosshair}
 
 \func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
 \membersection{wxDC::CrossHair}\label{wxdccrosshair}
 
 \func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}


@@ -192,6 +192,7 @@ Displays a cross hair using the current pen. This is a vertical
 and horizontal line the height and width of the window, centred
 on the given point.
 
 and horizontal line the height and width of the window, centred
 on the given point.
 

+

 \membersection{wxDC::DestroyClippingRegion}\label{wxdcdestroyclippingregion}
 
 \func{void}{DestroyClippingRegion}{\void}
 \membersection{wxDC::DestroyClippingRegion}\label{wxdcdestroyclippingregion}
 
 \func{void}{DestroyClippingRegion}{\void}


@@ -199,39 +200,44 @@ on the given point.
 Destroys the current clipping region so that none of the DC is clipped.
 See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}.
 
 Destroys the current clipping region so that none of the DC is clipped.
 See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}.
 

+

 \membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx}
 
 \membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx}
 

-\func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}
+\func{virtual wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}

 
 Convert device X coordinate to logical coordinate, using the current
 mapping mode.
 
 
 Convert device X coordinate to logical coordinate, using the current
 mapping mode.
 

+

 \membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel}
 
 \membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel}
 

-\func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}
+\func{virtual wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}

 
 Convert device X coordinate to relative logical coordinate, using the current
 mapping mode but ignoring the x axis orientation.
 Use this function for converting a width, for example.
 
 
 Convert device X coordinate to relative logical coordinate, using the current
 mapping mode but ignoring the x axis orientation.
 Use this function for converting a width, for example.
 

+

 \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly}
 
 \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly}
 

-\func{wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}}
+\func{virtual wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}}

 
 Converts device Y coordinate to logical coordinate, using the current
 mapping mode.
 
 
 Converts device Y coordinate to logical coordinate, using the current
 mapping mode.
 

+

 \membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel}
 
 \membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel}
 

-\func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}
+\func{virtual wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}

 
 Convert device Y coordinate to relative logical coordinate, using the current
 mapping mode but ignoring the y axis orientation.
 Use this function for converting a height, for example.
 
 
 Convert device Y coordinate to relative logical coordinate, using the current
 mapping mode but ignoring the y axis orientation.
 Use this function for converting a height, for example.
 

+

 \membersection{wxDC::DrawArc}\label{wxdcdrawarc}
 
 \membersection{wxDC::DrawArc}\label{wxdcdrawarc}
 

-\func{void}{DrawArc}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{double}{ xc}, \param{double}{ yc}}
+\func{void}{DrawArc}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ xc}, \param{wxCoord}{ yc}}

 
 Draws an arc of a circle, centred on ({\it xc, yc}), with starting point ({\it x1, y1})
 and ending at ({\it x2, y2}).   The current pen is used for the outline
 
 Draws an arc of a circle, centred on ({\it xc, yc}), with starting point ({\it x1, y1})
 and ending at ({\it x2, y2}).   The current pen is used for the outline


@@ -239,11 +245,12 @@ and the current brush for filling the shape.
 
 The arc is drawn in an anticlockwise direction from the start point to the end point.
 
 
 The arc is drawn in an anticlockwise direction from the start point to the end point.
 

+

 \membersection{wxDC::DrawBitmap}\label{wxdcdrawbitmap}
 
 \func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{bool}{ transparent}}
 
 \membersection{wxDC::DrawBitmap}\label{wxdcdrawbitmap}
 
 \func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{bool}{ transparent}}
 

-Draw a bitmap on the device context at the specified point. If {\it transparent} is TRUE and the bitmap has
+Draw a bitmap on the device context at the specified point. If {\it transparent} is true and the bitmap has

 a transparency mask, the bitmap will be drawn transparently.
 
 When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground
 a transparency mask, the bitmap will be drawn transparently.
 
 When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground


@@ -251,6 +258,7 @@ of the bitmap (all bits set to 1), and the current text background colour to dra
 (all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground}, 
 \helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}.
 
 (all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground}, 
 \helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}.
 

+

 \membersection{wxDC::DrawCheckMark}\label{wxdcdrawcheckmark}
 
 \func{void}{DrawCheckMark}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 \membersection{wxDC::DrawCheckMark}\label{wxdcdrawcheckmark}
 
 \func{void}{DrawCheckMark}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}


@@ -259,6 +267,7 @@ of the bitmap (all bits set to 1), and the current text background colour to dra
 
 Draws a check mark inside the given rectangle.
 
 
 Draws a check mark inside the given rectangle.
 

+

 \membersection{wxDC::DrawCircle}\label{wxdcdrawcircle}
 
 \func{void}{DrawCircle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ radius}}
 \membersection{wxDC::DrawCircle}\label{wxdcdrawcircle}
 
 \func{void}{DrawCircle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ radius}}


@@ -271,6 +280,7 @@ Draws a circle with the given centre and radius.
 
 \helpref{DrawEllipse}{wxdcdrawellipse}
 
 
 \helpref{DrawEllipse}{wxdcdrawellipse}
 

+

 \membersection{wxDC::DrawEllipse}\label{wxdcdrawellipse}
 
 \func{void}{DrawEllipse}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 \membersection{wxDC::DrawEllipse}\label{wxdcdrawellipse}
 
 \func{void}{DrawEllipse}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}


@@ -287,6 +297,7 @@ outline and the current brush for filling the shape.
 
 \helpref{DrawCircle}{wxdcdrawcircle}
 
 
 \helpref{DrawCircle}{wxdcdrawcircle}
 

+

 \membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc}
 
 \func{void}{DrawEllipticArc}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
 \membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc}
 
 \func{void}{DrawEllipticArc}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height},


@@ -307,6 +318,7 @@ in degrees (360 is a complete circle). Positive values mean
 counter-clockwise motion. If {\it start} is equal to {\it end}, a
 complete ellipse will be drawn.
 
 counter-clockwise motion. If {\it start} is equal to {\it end}, a
 complete ellipse will be drawn.
 

+

 \membersection{wxDC::DrawIcon}\label{wxdcdrawicon}
 
 \func{void}{DrawIcon}{\param{const wxIcon\&}{ icon}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
 \membersection{wxDC::DrawIcon}\label{wxdcdrawicon}
 
 \func{void}{DrawIcon}{\param{const wxIcon\&}{ icon}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}


@@ -314,23 +326,48 @@ complete ellipse will be drawn.
 Draw an icon on the display (does nothing if the device context is PostScript).
 This can be the simplest way of drawing bitmaps on a window.
 
 Draw an icon on the display (does nothing if the device context is PostScript).
 This can be the simplest way of drawing bitmaps on a window.
 

+
+\membersection{wxDC::DrawLabel}\label{wxdcdrawlabel}
+
+\func{virtual void}{DrawLabel}{\param{const wxString\&}{ text},
+                               \param{const wxBitmap\&}{ image},
+                               \param{const wxRect\&}{ rect},
+                               \param{int}{ alignment = wxALIGN\_LEFT | wxALIGN\_TOP},
+                               \param{int}{ indexAccel = -1},
+                               \param{wxRect *}{rectBounding = NULL}}
+
+\func{void}{DrawLabel}{\param{const wxString\&}{ text}, \param{const wxRect\&}{ rect},
+                       \param{int}{ alignment = wxALIGN\_LEFT | wxALIGN\_TOP},
+                       \param{int}{ indexAccel = -1}}
+
+Draw optional bitmap and the text into the given rectangle and aligns it as specified
+by alignment parameter; it also will emphasize the character with the given index if
+it is != -1 and return the bounding rectangle if required.
+
+

 \membersection{wxDC::DrawLine}\label{wxdcdrawline}
 
 \func{void}{DrawLine}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}}
 
 Draws a line from the first point to the second. The current pen is used
 \membersection{wxDC::DrawLine}\label{wxdcdrawline}
 
 \func{void}{DrawLine}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}}
 
 Draws a line from the first point to the second. The current pen is used

-for drawing the line.
+for drawing the line. Note that the point $(x2, y2)$ is {\emph not} part of the
+line and is not drawn by this function (this is consistent with the behaviour
+of many other toolkits).
+

 
 \membersection{wxDC::DrawLines}\label{wxdcdrawlines}
 
 \func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
 
 
 \membersection{wxDC::DrawLines}\label{wxdcdrawlines}
 
 \func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
 

-\func{void}{DrawLines}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
+Draws lines using an array of {\it points} of size {\it n}
+adding the optional offset coordinate. The current pen is
+used for drawing the lines.

 
 

-Draws lines using an array of {\it points} of size {\it n}, or list of
-pointers to points, adding the optional offset coordinate. The current
-pen is used for drawing the lines.  The programmer is responsible for
-deleting the list of points.
+\func{void}{DrawLines}{\param{const wxPointList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
+
+This method uses a list of wxPoints, adding the optional offset
+coordinate. The programmer is responsible for deleting the list
+of points.

 
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}
 
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}


@@ -339,16 +376,20 @@ of wxPoint objects.}
   as its first parameter a reference to an array
   of wxPoint objects.}
 
   as its first parameter a reference to an array
   of wxPoint objects.}
 

+

 \membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
 
 \func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 
 \membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
 
 \func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 

-\func{void}{DrawPolygon}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
+Draws a filled polygon using an array of {\it points} of size {\it n},
+adding the optional offset coordinate.
+
+\func{void}{DrawPolygon}{\param{const wxPointList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\

   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 
   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 

-Draws a filled polygon using an array of {\it points} of size {\it n},
-or list of pointers to points, adding the optional offset coordinate.
+This method draws a filled polygon using a list of wxPoints,
+adding the optional offset coordinate.

 
 The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the
 default) or {\bf wxWINDING\_RULE}.
 
 The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the
 default) or {\bf wxWINDING\_RULE}.


@@ -357,7 +398,7 @@ The current pen is used for drawing the outline, and the current brush
 for filling the shape.  Using a transparent brush suppresses filling.
 The programmer is responsible for deleting the list of points.
 
 for filling the shape.  Using a transparent brush suppresses filling.
 The programmer is responsible for deleting the list of points.
 

-Note that wxWindows automatically closes the first and last points.
+Note that wxWidgets automatically closes the first and last points.

 
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}
 
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}


@@ -366,11 +407,45 @@ of wxPoint objects.}
   as its first parameter a reference to an array
   of wxPoint objects.}
 
   as its first parameter a reference to an array
   of wxPoint objects.}
 

+
+\membersection{wxDC::DrawPolyPolygon}\label{wxdcdrawpolypolygon}
+
+\func{void}{DrawPolyPolygon}{\param{int}{ n}, \param{int}{ count[]}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
+  \param{int }{fill\_style = wxODDEVEN\_RULE}}
+
+Draws two or more filled polygons using an array of {\it points}, adding the
+optional offset coordinates.
+
+Notice that for the platforms providing a native implementation
+of this function (Windows and PostScript-based wxDC currently), this is more
+efficient than using \helpref{DrawPolygon}{wxdcdrawpolygon} in a loop.
+
+{\it n} specifies the number of polygons to draw, the array {\it count} of size 
+{\it n} specifies the number of points in each of the polygons in the 
+{\it points} array.
+
+The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the default)
+or {\bf wxWINDING\_RULE}.
+
+The current pen is used for drawing the outline, and the current brush for
+filling the shape.  Using a transparent brush suppresses filling.
+
+The polygons maybe disjoint or overlapping. Each polygon specified in a call to
+{\bf DrawPolyPolygon} must be closed. Unlike polygons created by the
+\helpref{DrawPolygon}{wxdcdrawpolygon} member function, the polygons created by
+{\bf DrawPolyPolygon} are not closed automatically.
+
+\pythonnote{Not implemented yet}
+
+\perlnote{Not implemented yet}
+
+

 \membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
 
 \func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
 
 \membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
 
 \func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
 

-Draws a point using the current pen.
+Draws a point using the color of the current pen. Note that the other properties of the pen are not used, such as width etc..
+

 
 \membersection{wxDC::DrawRectangle}\label{wxdcdrawrectangle}
 
 
 \membersection{wxDC::DrawRectangle}\label{wxdcdrawrectangle}
 


@@ -380,6 +455,7 @@ Draws a rectangle with the given top left corner, and with the given
 size.  The current pen is used for the outline and the current brush
 for filling the shape.
 
 size.  The current pen is used for the outline and the current brush
 for filling the shape.
 

+

 \membersection{wxDC::DrawRotatedText}\label{wxdcdrawrotatedtext}
 
 \func{void}{DrawRotatedText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{double}{ angle}}
 \membersection{wxDC::DrawRotatedText}\label{wxdcdrawrotatedtext}
 
 \func{void}{DrawRotatedText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{double}{ angle}}


@@ -395,9 +471,10 @@ which is.
 
 \helpref{DrawText}{wxdcdrawtext}
 
 
 \helpref{DrawText}{wxdcdrawtext}
 

+

 \membersection{wxDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle}
 
 \membersection{wxDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle}
 

-\func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius = 20}}
+\func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius}}

 
 Draws a rectangle with the given top left corner, and with the given
 size.  The corners are quarter-circles using the given radius. The
 
 Draws a rectangle with the given top left corner, and with the given
 size.  The corners are quarter-circles using the given radius. The


@@ -412,14 +489,17 @@ a sensible size relative to the size of the rectangle, and also avoids
 the strange effects X produces when the corners are too big for
 the rectangle.
 
 the strange effects X produces when the corners are too big for
 the rectangle.
 

+

 \membersection{wxDC::DrawSpline}\label{wxdcdrawspline}
 
 \membersection{wxDC::DrawSpline}\label{wxdcdrawspline}
 

-\func{void}{DrawSpline}{\param{wxList *}{points}}
+\func{void}{DrawSpline}{\param{int }{n}, \param{wxPoint }{points[]}}

 
 Draws a spline between all given control points, using the current
 
 Draws a spline between all given control points, using the current

-pen.  Doesn't delete the wxList and contents. The spline is drawn
-using a series of lines, using an algorithm taken from the X drawing
-program `XFIG'.
+pen.
+
+\func{void}{DrawSpline}{\param{const wxPointList *}{points}}
+
+Draws a spline between all given control points.

 
 \func{void}{DrawSpline}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ x3}, \param{wxCoord}{ y3}}
 
 
 \func{void}{DrawSpline}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ x3}, \param{wxCoord}{ y3}}
 


@@ -431,6 +511,7 @@ of wxPoint objects.}
 \perlnote{The wxPerl version of this method accepts a reference to an array
   of wxPoint objects.}
 
 \perlnote{The wxPerl version of this method accepts a reference to an array
   of wxPoint objects.}
 

+

 \membersection{wxDC::DrawText}\label{wxdcdrawtext}
 
 \func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
 \membersection{wxDC::DrawText}\label{wxdcdrawtext}
 
 \func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}


@@ -449,6 +530,7 @@ but it is ignored by wxMSW. Thus, you should avoid using logical functions
 with this function in portable programs.
 
 \begin{comment}
 with this function in portable programs.
 
 \begin{comment}

+

 \membersection{wxDC::EnableCache}\label{wxdcenablecache}
 
 \func{static void}{EnableCache}{\param{bool}{ enableCache}}
 \membersection{wxDC::EnableCache}\label{wxdcenablecache}
 
 \func{static void}{EnableCache}{\param{bool}{ enableCache}}


@@ -465,19 +547,13 @@ wxUSE\_DC\_CACHEING preprocessor symbol for portability.
 \helpref{wxDC::CacheEnabled}{wxdccacheenabled}, \helpref{wxDC::ClearCache}
 \end{comment}
 
 \helpref{wxDC::CacheEnabled}{wxdccacheenabled}, \helpref{wxDC::ClearCache}
 \end{comment}
 

+

 \membersection{wxDC::EndDoc}\label{wxdcenddoc}
 
 \func{void}{EndDoc}{\void}
 
 Ends a document (only relevant when outputting to a printer).
 
 \membersection{wxDC::EndDoc}\label{wxdcenddoc}
 
 \func{void}{EndDoc}{\void}
 
 Ends a document (only relevant when outputting to a printer).
 

-\membersection{wxDC::EndDrawing}\label{wxdcenddrawing}
-
-\func{void}{EndDrawing}{\void}
-
-Allows optimization of drawing code under MS Windows. Enclose
-drawing primitives between {\bf BeginDrawing} and {\bf EndDrawing}\rtfsp
-calls.

 
 \membersection{wxDC::EndPage}\label{wxdcendpage}
 
 
 \membersection{wxDC::EndPage}\label{wxdcendpage}
 


@@ -485,6 +561,7 @@ calls.
 
 Ends a document page (only relevant when outputting to a printer).
 
 
 Ends a document page (only relevant when outputting to a printer).
 

+

 \membersection{wxDC::FloodFill}\label{wxdcfloodfill}
 
 \func{bool}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}}
 \membersection{wxDC::FloodFill}\label{wxdcfloodfill}
 
 \func{bool}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}}


@@ -497,20 +574,20 @@ the {\it current brush colour}, and using a style:
 \item wxFLOOD\_BORDER: the area to be flooded is bounded by the given colour.
 \end{itemize}
 
 \item wxFLOOD\_BORDER: the area to be flooded is bounded by the given colour.
 \end{itemize}
 

-Returns FALSE if the operation failed.
+Returns false if the operation failed.

 
 {\it Note:} The present implementation for non-Windows platforms may fail to find
 colour borders if the pixels do not match the colour exactly. However the
 
 {\it Note:} The present implementation for non-Windows platforms may fail to find
 colour borders if the pixels do not match the colour exactly. However the

-function will still return TRUE.
+function will still return true.

 
 

-\membersection{wxDC::GetBackground}\label{wxdcgetbackground}

 
 

-\func{wxBrush\&}{GetBackground}{\void}
+\membersection{wxDC::GetBackground}\label{wxdcgetbackground}

 
 \constfunc{const wxBrush\&}{GetBackground}{\void}
 
 Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}).
 
 
 \constfunc{const wxBrush\&}{GetBackground}{\void}
 
 Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}).
 

+

 \membersection{wxDC::GetBackgroundMode}\label{wxdcgetbackgroundmode}
 
 \constfunc{int}{GetBackgroundMode}{\void}
 \membersection{wxDC::GetBackgroundMode}\label{wxdcgetbackgroundmode}
 
 \constfunc{int}{GetBackgroundMode}{\void}


@@ -521,26 +598,28 @@ Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}.
 
 \helpref{SetBackgroundMode}{wxdcsetbackgroundmode}
 
 
 \helpref{SetBackgroundMode}{wxdcsetbackgroundmode}
 

-\membersection{wxDC::GetBrush}\label{wxdcgetbrush}

 
 

-\func{wxBrush\&}{GetBrush}{\void}
+\membersection{wxDC::GetBrush}\label{wxdcgetbrush}

 
 \constfunc{const wxBrush\&}{GetBrush}{\void}
 
 Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
 
 
 \constfunc{const wxBrush\&}{GetBrush}{\void}
 
 Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
 

+

 \membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight}
 
 \func{wxCoord}{GetCharHeight}{\void}
 
 Gets the character height of the currently set font.
 
 \membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight}
 
 \func{wxCoord}{GetCharHeight}{\void}
 
 Gets the character height of the currently set font.
 

+

 \membersection{wxDC::GetCharWidth}\label{wxdcgetcharwidth}
 
 \func{wxCoord}{GetCharWidth}{\void}
 
 Gets the average character width of the currently set font.
 
 \membersection{wxDC::GetCharWidth}\label{wxdcgetcharwidth}
 
 \func{wxCoord}{GetCharWidth}{\void}
 
 Gets the average character width of the currently set font.
 

+

 \membersection{wxDC::GetClippingBox}\label{wxdcgetclippingbox}
 
 \func{void}{GetClippingBox}{\param{wxCoord}{ *x}, \param{wxCoord}{ *y}, \param{wxCoord}{ *width}, \param{wxCoord}{ *height}}
 \membersection{wxDC::GetClippingBox}\label{wxdcgetclippingbox}
 
 \func{void}{GetClippingBox}{\param{wxCoord}{ *x}, \param{wxCoord}{ *y}, \param{wxCoord}{ *width}, \param{wxCoord}{ *height}}


@@ -553,13 +632,41 @@ rectangle are returned as a tuple.}
 \perlnote{This method takes no arguments and returns a four element list
 {\tt ( x, y, width, height )}}
 
 \perlnote{This method takes no arguments and returns a four element list
 {\tt ( x, y, width, height )}}
 

-\membersection{wxDC::GetFont}\label{wxdcgetfont}

 
 

-\func{wxFont\&}{GetFont}{\void}
+\membersection{wxDC::GetDepth}\label{wxdcgetdepth}
+
+\constfunc{int}{GetDepth}{\void}
+
+Returns the depth (number of bits/pixel) of this DC.
+
+\wxheading{See also}
+
+\helpref{wxDisplayDepth}{wxdisplaydepth}
+
+
+\membersection{wxDC::GetFont}\label{wxdcgetfont}

 
 \constfunc{const wxFont\&}{GetFont}{\void}
 
 
 \constfunc{const wxFont\&}{GetFont}{\void}
 

-Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
+Gets the current font. Notice that even although each device context object has
+some default font after creation, this method would return a \texttt{wxNullFont} 
+initially and only after calling \helpref{wxDC::SetFont}{wxdcsetfont} a valid
+font is returned.
+
+
+\membersection{wxDC::GetLayoutDirection}\label{wxdcgetlayoutdirection}
+
+\constfunc{wxLayoutDirection}{GetLayoutDirection}{\void}
+
+Gets the current layout direction of the device context. On platforms where RTL layout
+is supported, the return value will either be \texttt{wxLayout\_LeftToRight} or 
+\texttt{wxLayout\_RightToLeft}. If RTL layout is not supported, the return value will 
+be \texttt{wxLayout\_Default}.
+
+\wxheading{See also}
+
+\helpref{SetLayoutDirection}{wxdcsetlayoutdirection}
+

 
 \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction}
 
 
 \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction}
 


@@ -567,33 +674,78 @@ Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 
 Gets the current logical function (see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}).
 
 
 Gets the current logical function (see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}).
 

+

 \membersection{wxDC::GetMapMode}\label{wxdcgetmapmode}
 
 \func{int}{GetMapMode}{\void}
 
 Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMode}{wxdcsetmapmode}).
 
 \membersection{wxDC::GetMapMode}\label{wxdcgetmapmode}
 
 \func{int}{GetMapMode}{\void}
 
 Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMode}{wxdcsetmapmode}).
 

-\membersection{wxDC::GetOptimization}\label{wxdcgetoptimization}

 
 

-\func{bool}{GetOptimization}{\void}
+\membersection{wxDC::GetMultiLineTextExtent}\label{wxdcgetmultilinetextextent}

 
 

-Returns TRUE if device context optimization is on.
-See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details.
+\constfunc{void}{GetMultiLineTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w},\\
+  \param{wxCoord *}{h}, \param{wxCoord *}{heightLine = NULL}, \param{wxFont *}{font = NULL}}

 
 

-\membersection{wxDC::GetPen}\label{wxdcgetpen}
+\constfunc{wxSize}{GetMultiLineTextExtent}{\param{const wxString\& }{string}}
+
+Gets the dimensions of the string using the currently selected font.
+\rtfsp{\it string} is the text string to measure, {\it heightLine}, if non NULL,
+is where to store the height of a single line.
+
+The text extent is returned in {\it w} and {\it h} pointers (first form) or as
+a \helpref{wxSize}{wxsize} object (second form).
+
+If the optional parameter {\it font} is specified and valid, then it is used
+for the text extent calculation. Otherwise the currently selected font is.
+
+Note that this function works both with single-line and multi-line strings.
+
+\wxheading{See also}
+
+\helpref{wxFont}{wxfont},\rtfsp
+\helpref{wxDC::SetFont}{wxdcsetfont},\rtfsp
+\helpref{wxDC::GetPartialTextExtents}{wxdcgetpartialtextextents},\rtfsp
+\helpref{wxDC::GetTextExtent}{wxdcgettextextent}

 
 

-\func{wxPen\&}{GetPen}{\void}
+
+\membersection{wxDC::GetPartialTextExtents}\label{wxdcgetpartialtextextents}
+
+\constfunc{bool}{GetPartialTextExtents}{\param{const wxString\&  }{text}, 
+\param{wxArrayInt\& }{widths}}
+
+Fills the {\it widths} array with the widths from the beginning of 
+{\it text} to the corresponding character of {\it text}.  The generic
+version simply builds a running total of the widths of each character
+using \helpref{GetTextExtent}{wxdcgettextextent}, however if the
+various platforms have a native API function that is faster or more
+accurate than the generic implementation then it should be used
+instead. 
+
+\wxheading{See also}
+
+\helpref{wxDC::GetMultiLineTextExtent}{wxdcgetmultilinetextextent},\rtfsp
+\helpref{wxDC::GetTextExtent}{wxdcgettextextent}
+
+\pythonnote{This method only takes the {\it text} parameter and
+  returns a Python list of integers.}
+
+
+\membersection{wxDC::GetPen}\label{wxdcgetpen}

 
 \constfunc{const wxPen\&}{GetPen}{\void}
 
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 
 
 \constfunc{const wxPen\&}{GetPen}{\void}
 
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 

+

 \membersection{wxDC::GetPixel}\label{wxdcgetpixel}
 
 \func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}}
 
 \membersection{wxDC::GetPixel}\label{wxdcgetpixel}
 
 \func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}}
 

-Sets {\it colour} to the colour at the specified location. Windows only; an X implementation
-is being worked on. Not available for wxPostScriptDC or wxMetafileDC.
+Gets in {\it colour} the colour at the specified location.
+Not available for wxPostScriptDC or wxMetafileDC.
+
+Note that setting a pixel can be done using \helpref{DrawPoint}{wxdcdrawpoint}.

 
 \pythonnote{For wxPython the wxColour value is returned and is not
 required as a parameter.}
 
 \pythonnote{For wxPython the wxColour value is returned and is not
 required as a parameter.}


@@ -601,16 +753,20 @@ required as a parameter.}
 \perlnote{This method only takes the parameters {\tt x} and {\tt y} and returns
 a Wx::Colour value}
 
 \perlnote{This method only takes the parameters {\tt x} and {\tt y} and returns
 a Wx::Colour value}
 

+\membersection{wxDC::GetPPI}\label{wxdcgetppi}
+
+\constfunc{wxSize}{GetPPI}{\void}
+
+Returns the resolution of the device in pixels per inch.
+

 \membersection{wxDC::GetSize}\label{wxdcgetsize}
 
 \membersection{wxDC::GetSize}\label{wxdcgetsize}
 

-\func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
+\constfunc{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}

 
 

-For a PostScript device context, this gets the maximum size of graphics
-drawn so far on the device context.
+\constfunc{wxSize}{GetSize}{\void}

 
 

-For a Windows printer device context, this gets the horizontal and vertical
-resolution. It can be used to scale graphics to fit the page when using
-a Windows printer device context. For example, if {\it maxX} and {\it maxY}\rtfsp
+This gets the horizontal and vertical resolution in device units. It can be used to scale graphics to fit the page.
+For example, if {\it maxX} and {\it maxY}\rtfsp

 represent the maximum horizontal and vertical `pixel' values used in your
 application, the following code will scale the graphic to fit on the
 printer page:
 represent the maximum horizontal and vertical `pixel' values used in your
 application, the following code will scale the graphic to fit on the
 printer page:


@@ -639,32 +795,48 @@ implements the following methods:\par
 \end{twocollist}
 }}
 
 \end{twocollist}
 }}
 

-\membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
+\membersection{wxDC::GetSizeMM}\label{wxdcgetsizemm}
+
+\constfunc{void}{GetSizeMM}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
+
+\constfunc{wxSize}{GetSizeMM}{\void}

 
 

-\func{wxColour\&}{GetTextBackground}{\void}
+Returns the horizontal and vertical resolution in millimetres.
+
+\membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}

 
 \constfunc{const wxColour\&}{GetTextBackground}{\void}
 
 Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
 
 
 \constfunc{const wxColour\&}{GetTextBackground}{\void}
 
 Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
 

+

 \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}
 
 \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}
 

-\func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\
-  \param{wxCoord *}{descent = NULL}, \param{wxCoord *}{externalLeading = NULL}, \param{wxFont *}{font = NULL}}
+\constfunc{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\
+  \param{wxCoord *}{descent = NULL}, \param{wxCoord *}{externalLeading = NULL}, \param{const wxFont *}{font = NULL}}
+
+\constfunc{wxSize}{GetTextExtent}{\param{const wxString\& }{string}}

 
 Gets the dimensions of the string using the currently selected font.
 
 Gets the dimensions of the string using the currently selected font.

-\rtfsp{\it string} is the text string to measure, {\it w} and {\it h} are
-the total width and height respectively, {\it descent} is the
+\rtfsp{\it string} is the text string to measure, {\it descent} is the

 dimension from the baseline of the font to the bottom of the
 descender, and {\it externalLeading} is any extra vertical space added
 to the font by the font designer (usually is zero).
 
 dimension from the baseline of the font to the bottom of the
 descender, and {\it externalLeading} is any extra vertical space added
 to the font by the font designer (usually is zero).
 

-The optional parameter {\it font} specifies an alternative
-to the currently selected font: but note that this does not
-yet work under Windows, so you need to set a font for
-the device context first.
+The text extent is returned in {\it w} and {\it h} pointers (first form) or as
+a \helpref{wxSize}{wxsize} object (second form).
+
+If the optional parameter {\it font} is specified and valid, then it is used
+for the text extent calculation. Otherwise the currently selected font is.

 
 

-See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
+Note that this function only works with single-line strings.
+
+\wxheading{See also}
+
+\helpref{wxFont}{wxfont},\rtfsp
+\helpref{wxDC::SetFont}{wxdcsetfont},\rtfsp
+\helpref{wxDC::GetPartialTextExtents}{wxdcgetpartialtextextents},\rtfsp
+\helpref{wxDC::GetMultiLineTextExtent}{wxdcgetmultilinetextextent}

 
 \pythonnote{The following methods are implemented in wxPython:\par
 \indented{2cm}{\begin{twocollist}
 
 \pythonnote{The following methods are implemented in wxPython:\par
 \indented{2cm}{\begin{twocollist}


@@ -679,9 +851,8 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
   array {\tt ( width, height, descent, externalLeading )}
 }
 
   array {\tt ( width, height, descent, externalLeading )}
 }
 

-\membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}

 
 

-\func{wxColour\&}{GetTextForeground}{\void}
+\membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}

 
 \constfunc{const wxColour\&}{GetTextForeground}{\void}
 
 
 \constfunc{const wxColour\&}{GetTextForeground}{\void}
 


@@ -697,65 +868,104 @@ Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetusersca
 \perlnote{In wxPerl this method takes no arguments and return a two element
  array {\tt ( x, y )}}
 
 \perlnote{In wxPerl this method takes no arguments and return a two element
  array {\tt ( x, y )}}
 

+
+\membersection{wxDC::GradientFillConcentric}\label{wxdcgradientfillconcentric}
+
+\func{void}{GradientFillConcentric}{\param{const wxRect\&}{ rect}, \param{const wxColour\&}{ initialColour}, \param{const wxColour\&}{ destColour}}
+
+\func{void}{GradientFillConcentric}{\param{const wxRect\&}{ rect}, \param{const wxColour\&}{ initialColour}, \param{const wxColour\&}{ destColour}, \param{const wxPoint\& }{circleCenter}}
+
+Fill the area specified by rect with a radial gradient, starting from 
+\arg{initialColour} at the centre of the circle and fading to \arg{destColour} 
+on the circle outside.
+
+\arg{circleCenter} are the relative coordinates of centre of the circle in
+the specified \arg{rect}. If not specified, the cercle is placed at the
+centre of rect.
+
+\textbf{Note: } Currently this function is very slow, don't use it for
+real-time drawing.
+
+
+\membersection{wxDC::GradientFillLinear}\label{wxdcgradientfilllinear}
+
+\func{void}{GradientFillLinear}{\param{const wxRect\&}{ rect}, \param{const wxColour\&}{ initialColour}, \param{const wxColour\&}{ destColour}, \param{wxDirection}{ nDirection = wxEAST}}
+
+Fill the area specified by \arg{rect} with a linear gradient, starting from 
+\arg{initialColour} and eventually fading to \arg{destColour}. The 
+\arg{nDirection} specifies the direction of the colour change, default is to
+use \arg{initialColour} on the left part of the rectangle and 
+\arg{destColour} on the right one.
+
+

 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 
 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 

-\func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}
+\func{virtual wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}

 
 Converts logical X coordinate to device coordinate, using the current
 mapping mode.
 
 
 Converts logical X coordinate to device coordinate, using the current
 mapping mode.
 

+

 \membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel}
 
 \membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel}
 

-\func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}
+\func{virtual wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}

 
 Converts logical X coordinate to relative device coordinate, using the current
 mapping mode but ignoring the x axis orientation.
 Use this for converting a width, for example.
 
 
 Converts logical X coordinate to relative device coordinate, using the current
 mapping mode but ignoring the x axis orientation.
 Use this for converting a width, for example.
 

+

 \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey}
 
 \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey}
 

-\func{wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}}
+\func{virtual wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}}

 
 Converts logical Y coordinate to device coordinate, using the current
 mapping mode.
 
 
 Converts logical Y coordinate to device coordinate, using the current
 mapping mode.
 

+

 \membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel}
 
 \membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel}
 

-\func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}
+\func{virtual wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}

 
 Converts logical Y coordinate to relative device coordinate, using the current
 mapping mode but ignoring the y axis orientation.
 Use this for converting a height, for example.
 
 
 Converts logical Y coordinate to relative device coordinate, using the current
 mapping mode but ignoring the y axis orientation.
 Use this for converting a height, for example.
 

+

 \membersection{wxDC::MaxX}\label{wxdcmaxx}
 
 \func{wxCoord}{MaxX}{\void}
 
 Gets the maximum horizontal extent used in drawing commands so far.
 
 \membersection{wxDC::MaxX}\label{wxdcmaxx}
 
 \func{wxCoord}{MaxX}{\void}
 
 Gets the maximum horizontal extent used in drawing commands so far.
 

+

 \membersection{wxDC::MaxY}\label{wxdcmaxy}
 
 \func{wxCoord}{MaxY}{\void}
 
 Gets the maximum vertical extent used in drawing commands so far.
 
 \membersection{wxDC::MaxY}\label{wxdcmaxy}
 
 \func{wxCoord}{MaxY}{\void}
 
 Gets the maximum vertical extent used in drawing commands so far.
 

+

 \membersection{wxDC::MinX}\label{wxdcminx}
 
 \func{wxCoord}{MinX}{\void}
 
 Gets the minimum horizontal extent used in drawing commands so far.
 
 \membersection{wxDC::MinX}\label{wxdcminx}
 
 \func{wxCoord}{MinX}{\void}
 
 Gets the minimum horizontal extent used in drawing commands so far.
 

+

 \membersection{wxDC::MinY}\label{wxdcminy}
 
 \func{wxCoord}{MinY}{\void}
 
 Gets the minimum vertical extent used in drawing commands so far.
 
 \membersection{wxDC::MinY}\label{wxdcminy}
 
 \func{wxCoord}{MinY}{\void}
 
 Gets the minimum vertical extent used in drawing commands so far.
 

-\membersection{wxDC::Ok}\label{wxdcok}
+
+\membersection{wxDC::IsOk}\label{wxdcisok}

 
 \func{bool}{Ok}{\void}
 
 
 \func{bool}{Ok}{\void}
 

-Returns TRUE if the DC is ok to use.
+Returns true if the DC is ok to use.
+

 
 \membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox}
 
 
 \membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox}
 


@@ -768,14 +978,15 @@ doesn't contain anything.
 
 \helpref{CalcBoundingBox}{wxdccalcboundingbox}
 
 
 \helpref{CalcBoundingBox}{wxdccalcboundingbox}
 

+

 \membersection{wxDC::SetAxisOrientation}\label{wxdcsetaxisorientation}
 
 \func{void}{SetAxisOrientation}{\param{bool}{ xLeftRight},
                                 \param{bool}{ yBottomUp}}
 
 Sets the x and y axis orientation (i.e., the direction from lowest to
 \membersection{wxDC::SetAxisOrientation}\label{wxdcsetaxisorientation}
 
 \func{void}{SetAxisOrientation}{\param{bool}{ xLeftRight},
                                 \param{bool}{ yBottomUp}}
 
 Sets the x and y axis orientation (i.e., the direction from lowest to

-highest values on the axis). The default orientation is the natural
-orientation, e.g. x axis from left to right and y axis from bottom up.
+highest values on the axis). The default orientation is 
+x axis from left to right and y axis from top down.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -785,15 +996,6 @@ left to right orientation, false to invert it.}
 \docparam{yBottomUp}{True to set the y axis orientation to the natural
 bottom up orientation, false to invert it.}
 
 \docparam{yBottomUp}{True to set the y axis orientation to the natural
 bottom up orientation, false to invert it.}
 

-\membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}
-
-\func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
-
-Sets the device origin (i.e., the origin in pixels after scaling has been
-applied).
-
-This function may be useful in Windows printing
-operations for placing a graphic on a page.

 
 \membersection{wxDC::SetBackground}\label{wxdcsetbackground}
 
 
 \membersection{wxDC::SetBackground}\label{wxdcsetbackground}
 


@@ -801,6 +1003,7 @@ operations for placing a graphic on a page.
 
 Sets the current background brush for the DC.
 
 
 Sets the current background brush for the DC.
 

+

 \membersection{wxDC::SetBackgroundMode}\label{wxdcsetbackgroundmode}
 
 \func{void}{SetBackgroundMode}{\param{int}{ mode}}
 \membersection{wxDC::SetBackgroundMode}\label{wxdcsetbackgroundmode}
 
 \func{void}{SetBackgroundMode}{\param{int}{ mode}}


@@ -808,6 +1011,23 @@ Sets the current background brush for the DC.
 {\it mode} may be one of wxSOLID and wxTRANSPARENT. This setting determines
 whether text will be drawn with a background colour or not.
 
 {\it mode} may be one of wxSOLID and wxTRANSPARENT. This setting determines
 whether text will be drawn with a background colour or not.
 

+
+\membersection{wxDC::SetBrush}\label{wxdcsetbrush}
+
+\func{void}{SetBrush}{\param{const wxBrush\& }{brush}}
+
+Sets the current brush for the DC.
+
+If the argument is wxNullBrush, the current brush is selected out of the device
+context (leaving wxDC without any valid brush), allowing the current brush to
+be destroyed safely.
+
+See also \helpref{wxBrush}{wxbrush}.
+
+See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
+when drawing into a monochrome bitmap.
+
+ 

 \membersection{wxDC::SetClippingRegion}\label{wxdcsetclippingregion}
 
 \func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 \membersection{wxDC::SetClippingRegion}\label{wxdcsetclippingregion}
 
 \func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}


@@ -832,31 +1052,17 @@ when only a known area of the screen is damaged.
 
 \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion}
 
 
 \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion}
 

-\membersection{wxDC::SetPalette}\label{wxdcsetpalette}
-
-\func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
-
-If this is a window DC or memory DC, assigns the given palette to the window
-or bitmap associated with the DC. If the argument is wxNullPalette, the current
-palette is selected out of the device context, and the original palette
-restored.
-
-See \helpref{wxPalette}{wxpalette} for further details.

 
 

-\membersection{wxDC::SetBrush}\label{wxdcsetbrush}
-
-\func{void}{SetBrush}{\param{const wxBrush\& }{brush}}
+\membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}

 
 

-Sets the current brush for the DC.
+\func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}

 
 

-If the argument is wxNullBrush, the current brush is selected out of the device
-context, and the original brush restored, allowing the current brush to
-be destroyed safely.
+Sets the device origin (i.e., the origin in pixels after scaling has been
+applied).

 
 

-See also \helpref{wxBrush}{wxbrush}.
+This function may be useful in Windows printing
+operations for placing a graphic on a page.

 
 

-See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
-when drawing into a monochrome bitmap.

 
 \membersection{wxDC::SetFont}\label{wxdcsetfont}
 
 
 \membersection{wxDC::SetFont}\label{wxdcsetfont}
 


@@ -867,6 +1073,19 @@ should not pass {\tt wxNullFont} to this method.
 
 See also \helpref{wxFont}{wxfont}.
 
 
 See also \helpref{wxFont}{wxfont}.
 

+
+\membersection{wxDC::SetLayoutDirection}\label{wxdcsetlayoutdirection}
+
+\func{void}{SetLayoutDirection}{\param{wxLayoutDirection}{ dir}}
+
+Sets the current layout direction for the device context. \arg{dir} may be either
+\texttt{wxLayout\_Default}, \texttt{wxLayout\_LeftToRight} or \texttt{wxLayout\_RightToLeft}.
+
+\wxheading{See also}
+
+\helpref{GetLayoutDirection}{wxdcgetlayoutdirection}
+
+

 \membersection{wxDC::SetLogicalFunction}\label{wxdcsetlogicalfunction}
 
 \func{void}{SetLogicalFunction}{\param{int}{ function}}
 \membersection{wxDC::SetLogicalFunction}\label{wxdcsetlogicalfunction}
 
 \func{void}{SetLogicalFunction}{\param{int}{ function}}


@@ -904,6 +1123,7 @@ The others combine the current colour and the background using a
 logical operation.  wxINVERT is commonly used for drawing rubber bands or
 moving outlines, since drawing twice reverts to the original colour.
 
 logical operation.  wxINVERT is commonly used for drawing rubber bands or
 moving outlines, since drawing twice reverts to the original colour.
 

+

 \membersection{wxDC::SetMapMode}\label{wxdcsetmapmode}
 
 \func{void}{SetMapMode}{\param{int}{ int}}
 \membersection{wxDC::SetMapMode}\label{wxdcsetmapmode}
 
 \func{void}{SetMapMode}{\param{int}{ int}}


@@ -916,12 +1136,10 @@ user scale} (see \helpref{wxDC::SetUserScale}{wxdcsetuserscale}) scales the text
 Windows, scalable TrueType fonts are always used; in X, results depend
 on availability of fonts, but usually a reasonable match is found.
 
 Windows, scalable TrueType fonts are always used; in X, results depend
 on availability of fonts, but usually a reasonable match is found.
 

-Note that the coordinate origin should ideally be selectable, but for
-now is always at the top left of the screen/printer.
+The coordinate origin is always at the top left of the screen/printer.

 
 

-Drawing to a Windows printer device context under UNIX
-uses the current mapping mode, but mapping mode is currently ignored for
-PostScript output.
+Drawing to a Windows printer device context uses the current mapping mode,
+but mapping mode is currently ignored for PostScript output.

 
 The mapping mode can be one of the following:
 
 
 The mapping mode can be one of the following:
 


@@ -931,22 +1149,21 @@ The mapping mode can be one of the following:
 \twocolitem{wxMM\_POINTS}{Each logical unit is a point, or 1/72 of an inch.}
 \twocolitem{wxMM\_METRIC}{Each logical unit is 1 mm.}
 \twocolitem{wxMM\_LOMETRIC}{Each logical unit is 1/10 of a mm.}
 \twocolitem{wxMM\_POINTS}{Each logical unit is a point, or 1/72 of an inch.}
 \twocolitem{wxMM\_METRIC}{Each logical unit is 1 mm.}
 \twocolitem{wxMM\_LOMETRIC}{Each logical unit is 1/10 of a mm.}

-\twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.}
+\twocolitem{wxMM\_TEXT}{Each logical unit is 1 device pixel.}

 \end{twocollist}
 
 \end{twocollist}
 

-\membersection{wxDC::SetOptimization}\label{wxsetoptimization}

 
 

-\func{void}{SetOptimization}{\param{bool }{optimize}}
+\membersection{wxDC::SetPalette}\label{wxdcsetpalette}
+
+\func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
+
+If this is a window DC or memory DC, assigns the given palette to the window
+or bitmap associated with the DC. If the argument is wxNullPalette, the current
+palette is selected out of the device context, and the original palette
+restored.

 
 

-If {\it optimize} is TRUE (the default), this function sets optimization mode on.
-This currently means that under X, the device context will not try to set a pen or brush
-property if it is known to be set already. This approach can fall down
-if non-wxWindows code is using the same device context or window, for example
-when the window is a panel on which the windowing system draws panel items.
-The wxWindows device context 'memory' will now be out of step with reality.
+See \helpref{wxPalette}{wxpalette} for further details.

 
 

-Setting optimization off, drawing, then setting it back on again, is a trick
-that must occasionally be employed.

 
 \membersection{wxDC::SetPen}\label{wxdcsetpen}
 
 
 \membersection{wxDC::SetPen}\label{wxdcsetpen}
 


@@ -955,17 +1172,20 @@ that must occasionally be employed.
 Sets the current pen for the DC.
 
 If the argument is wxNullPen, the current pen is selected out of the device
 Sets the current pen for the DC.
 
 If the argument is wxNullPen, the current pen is selected out of the device

-context, and the original pen restored.
+context (leaving wxDC without any valid pen), allowing the current brush to
+be destroyed safely.

 
 See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
 when drawing into a monochrome bitmap.
 
 
 See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
 when drawing into a monochrome bitmap.
 

+

 \membersection{wxDC::SetTextBackground}\label{wxdcsettextbackground}
 
 \func{void}{SetTextBackground}{\param{const wxColour\& }{colour}}
 
 Sets the current text background colour for the DC.
 
 \membersection{wxDC::SetTextBackground}\label{wxdcsettextbackground}
 
 \func{void}{SetTextBackground}{\param{const wxColour\& }{colour}}
 
 Sets the current text background colour for the DC.
 

+

 \membersection{wxDC::SetTextForeground}\label{wxdcsettextforeground}
 
 \func{void}{SetTextForeground}{\param{const wxColour\& }{colour}}
 \membersection{wxDC::SetTextForeground}\label{wxdcsettextforeground}
 
 \func{void}{SetTextForeground}{\param{const wxColour\& }{colour}}


@@ -975,6 +1195,7 @@ Sets the current text foreground colour for the DC.
 See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
 when drawing into a monochrome bitmap.
 
 See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
 when drawing into a monochrome bitmap.
 

+

 \membersection{wxDC::SetUserScale}\label{wxdcsetuserscale}
 
 \func{void}{SetUserScale}{\param{double}{ xScale}, \param{double}{ yScale}}
 \membersection{wxDC::SetUserScale}\label{wxdcsetuserscale}
 
 \func{void}{SetUserScale}{\param{double}{ xScale}, \param{double}{ yScale}}


@@ -982,12 +1203,14 @@ when drawing into a monochrome bitmap.
 Sets the user scaling factor, useful for applications which require
 `zooming'.
 
 Sets the user scaling factor, useful for applications which require
 `zooming'.
 

+

 \membersection{wxDC::StartDoc}\label{wxdcstartdoc}
 
 \func{bool}{StartDoc}{\param{const wxString\& }{message}}
 
 Starts a document (only relevant when outputting to a printer).
 \membersection{wxDC::StartDoc}\label{wxdcstartdoc}
 
 \func{bool}{StartDoc}{\param{const wxString\& }{message}}
 
 Starts a document (only relevant when outputting to a printer).

-Message is a message to show whilst printing.
+Message is a message to show while printing.
+

 
 \membersection{wxDC::StartPage}\label{wxdcstartpage}
 
 
 \membersection{wxDC::StartPage}\label{wxdcstartpage}
 


@@ -995,38 +1218,84 @@ Message is a message to show whilst printing.
 
 Starts a document page (only relevant when outputting to a printer).
 
 
 Starts a document page (only relevant when outputting to a printer).
 

-\section{\class{wxDCClipper}}\label{wxdcclipper}

 
 

-This is a small helper class which sets the specified to its constructor
-clipping region and then automatically destroys it in its destructor. Using
-it ensures that unwanted clipping region is not left set on the DC.
+\membersection{wxDC::StretchBlit}\label{wxdcstretchblit}

 
 

-\wxheading{Derived from}
+\func{bool}{StretchBlit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ dstWidth}, \param{wxCoord}{ dstHeight},
+  \param{wxDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{wxCoord}{ srcWidth}, \param{wxCoord}{ srcHeight}, 
+  \param{int}{ logicalFunc = wxCOPY}, \param{bool }{useMask = false}, \param{wxCoord}{ xsrcMask = -1}, \param{wxCoord}{ ysrcMask = -1}}

 
 

-No base class
+Copy from a source DC to this DC, specifying the destination
+coordinates, destination size, source DC, source coordinates,
+size of source area to copy, logical function, whether to use a bitmap mask, 
+and mask source position.

 
 

-\wxheading{Include files}
+\wxheading{Parameters}

 
 

-<wx/dc.h>
+\docparam{xdest}{Destination device context x position.}

 
 

-\wxheading{See also}
+\docparam{ydest}{Destination device context y position.}

 
 

-\helpref{wxDC}{wxdc}
+\docparam{dstWidth}{Width of destination area.}

 
 

-\latexignore{\rtfignore{\wxheading{Members}}}
+\docparam{dstHeight}{Height of destination area.}
+
+\docparam{source}{Source device context.}
+
+\docparam{xsrc}{Source device context x position.}
+
+\docparam{ysrc}{Source device context y position.}
+
+\docparam{srcWidth}{Width of source area to be copied.}
+
+\docparam{srcHeight}{Height of source area to be copied.}

 
 

-\membersection{wxDCClipper::wxDCClipper}
+\docparam{logicalFunc}{Logical function to use: see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}.}

 
 

-\func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{wxCoord }{x},\param{wxCoord }{y},\param{wxCoord }{w},\param{wxCoord }{h},}
+\docparam{useMask}{If true, Blit does a transparent blit using the mask that is associated with the bitmap
+selected into the source device context. The Windows implementation does the following if \texttt{MaskBlt} cannot be used:

 
 

-\func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{const wxRect\&}{ rect}}
+\begin{enumerate}
+\item Creates a temporary bitmap and copies the destination area into it.
+\item Copies the source area into the temporary bitmap using the specified logical function.
+\item Sets the masked area in the temporary bitmap to BLACK by ANDing the
+mask bitmap with the temp bitmap with the foreground colour set to WHITE
+and the background colour set to BLACK.
+\item Sets the unmasked area in the destination area to BLACK by ANDing the
+mask bitmap with the destination area with the foreground colour set to BLACK
+and the background colour set to WHITE.
+\item ORs the temporary bitmap with the destination area.
+\item Deletes the temporary bitmap.
+\end{enumerate}

 
 

-Constructor: sets the the clipping region for the given device context to the
-specified rectangle.
+This sequence of operations ensures that the source's transparent area need not be black,
+and logical functions are supported.

 
 

-\membersection{wxDCClipper::\destruct{wxDCClipper}}
+{\bf Note:} on Windows, blitting with masks can be speeded up considerably by compiling
+wxWidgets with the \texttt{wxUSE\_DC\_CACHE} option enabled. You can also influence whether \texttt{MaskBlt}
+or the explicit mask blitting code above is used, by using \helpref{wxSystemOptions}{wxsystemoptions} and
+setting the {\bf no-maskblt} option to 1.

 
 

-\func{}{\destruct{wxDCClipper}}{\void}
+}
+
+\docparam{xsrcMask}{Source x position on the mask. If both xsrcMask and ysrcMask are -1, xsrc and ysrc
+will be assumed for the mask source position. Currently only implemented on Windows.}
+
+\docparam{ysrcMask}{Source y position on the mask. If both xsrcMask and ysrcMask are -1, xsrc and ysrc
+will be assumed for the mask source position. Currently only implemented on Windows.}
+
+
+\wxheading{Remarks}
+
+There is partial support for Blit in wxPostScriptDC, under X.
+
+wxDC::StretchBlit is only implemented under wxMAC and wxMSW.
+
+See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
+
+\newsince{2.9.0}
+
+\wxheading{See also}

 
 

-Destructor: destroys the clipping region set in the constructor.
+\helpref{wxDC::Blit}{wxdcblit}, \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}