fixed typoe

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

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index 09c3f4e560ab7b63b0978e1646510c913b2ef45c..b42932d2ffa8fda84d0b914812db4f0afd49a621 100644 (file)
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -30,18 +30,21 @@ them.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxDC::wxDC}
 
 \func{}{wxDC}{\void}
 
 Constructor.
 
 \membersection{wxDC::wxDC}
 
 \func{}{wxDC}{\void}
 
 Constructor.
 

+

 \membersection{wxDC::\destruct{wxDC}}
 
 \func{}{\destruct{wxDC}}{\void}
 
 Destructor.
 
 \membersection{wxDC::\destruct{wxDC}}
 
 \func{}{\destruct{wxDC}}{\void}
 
 Destructor.
 

+

 \membersection{wxDC::BeginDrawing}\label{wxdcbegindrawing}
 
 \func{void}{BeginDrawing}{\void}
 \membersection{wxDC::BeginDrawing}\label{wxdcbegindrawing}
 
 \func{void}{BeginDrawing}{\void}


@@ -57,11 +60,12 @@ 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.
 
 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 +89,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}


@@ -129,11 +133,12 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
 \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}
 
 \begin{comment}
 \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}
 
 \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 +151,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 +164,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 +172,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 +192,7 @@ 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::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 +201,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,6 +209,7 @@ 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}
 
 \func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}
 \membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx}
 
 \func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}


@@ -206,12 +217,15 @@ See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}.
 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}
 
 \func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}
 
 Convert device X coordinate to relative logical coordinate, using the current
 \membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel}
 
 \func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}
 
 Convert device X coordinate to relative logical coordinate, using the current

-mapping mode. Use this function for converting a width, for example.
+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}
 


@@ -220,16 +234,19 @@ mapping mode. Use this function for converting a width, for example.
 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}
 
 \func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}
 
 Convert device Y coordinate to relative logical coordinate, using the current
 \membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel}
 
 \func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}
 
 Convert device Y coordinate to relative logical coordinate, using the current

-mapping mode. Use this function for converting a height, for example.
+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


@@ -237,11 +254,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


@@ -249,6 +267,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}}


@@ -257,13 +276,36 @@ 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}}
+
+\func{void}{DrawCircle}{\param{const wxPoint\&}{ pt}, \param{wxCoord}{ radius}}
+
+Draws a circle with the given centre and radius.
+
+\wxheading{See also}
+
+\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}}
 

-Draws an ellipse contained in the 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.
+\func{void}{DrawEllipse}{\param{const wxPoint\&}{ pt}, \param{const wxSize\&}{ size}}
+
+\func{void}{DrawEllipse}{\param{const wxRect\&}{ rect}}
+
+Draws an ellipse contained in the rectangle specified either with the given top
+left corner and the given size or directly. The current pen is used for the
+outline and the current brush for filling the shape.
+
+\wxheading{See also}
+
+\helpref{DrawCircle}{wxdcdrawcircle}
+

 
 \membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc}
 
 
 \membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc}
 


@@ -285,6 +327,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}}


@@ -292,12 +335,16 @@ 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::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}
 
 
 \membersection{wxDC::DrawLines}\label{wxdcdrawlines}
 


@@ -317,6 +364,7 @@ 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},\\
 \membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
 
 \func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\


@@ -344,12 +392,23 @@ 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 }{start[]}, \param{wxPoint }{points[]}, \param{wxCoord }{xoffset}, \param{wxCoord }{yoffset}, \param{int }{fillStyle = \texttt{wxODDEVEN\_RULE}}}
+
+Draw many polygons at once. For the platforms providing a native implementation
+of this function (Windows and PostScript-based wxDC), this is more efficient
+than using \helpref{DrawPolygon}{wxdcdrawpolygon} in a loop.
+
+

 \membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
 
 \func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
 
 Draws a point using the current pen.
 
 \membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
 
 \func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
 
 Draws a point using the current pen.
 

+

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


@@ -358,6 +417,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}}


@@ -373,6 +433,7 @@ which is.
 
 \helpref{DrawText}{wxdcdrawtext}
 
 
 \helpref{DrawText}{wxdcdrawtext}
 

+

 \membersection{wxDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle}
 
 \func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius = 20}}
 \membersection{wxDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle}
 
 \func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius = 20}}


@@ -390,6 +451,7 @@ 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}
 
 \func{void}{DrawSpline}{\param{wxList *}{points}}
 \membersection{wxDC::DrawSpline}\label{wxdcdrawspline}
 
 \func{void}{DrawSpline}{\param{wxList *}{points}}


@@ -409,6 +471,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}}


@@ -427,6 +490,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}}


@@ -443,12 +507,14 @@ 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}
 \membersection{wxDC::EndDrawing}\label{wxdcenddrawing}
 
 \func{void}{EndDrawing}{\void}


@@ -457,15 +523,17 @@ Allows optimization of drawing code under MS Windows. Enclose
 drawing primitives between {\bf BeginDrawing} and {\bf EndDrawing}\rtfsp
 calls.
 
 drawing primitives between {\bf BeginDrawing} and {\bf EndDrawing}\rtfsp
 calls.
 

+

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

+

 \membersection{wxDC::FloodFill}\label{wxdcfloodfill}
 
 \membersection{wxDC::FloodFill}\label{wxdcfloodfill}
 

-\func{void}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}}
+\func{bool}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}}

 
 Flood fills the device context starting from the given point, using
 the {\it current brush colour}, and using a style:
 
 Flood fills the device context starting from the given point, using
 the {\it current brush colour}, and using a style:


@@ -475,7 +543,12 @@ 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}
 

-{\it Note:} this function is available in MS Windows only.
+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
+function will still return true.
+

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


@@ -485,6 +558,7 @@ the {\it current brush colour}, and using a style:
 
 Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}).
 
 
 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}


@@ -495,6 +569,7 @@ 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}
 
 \func{wxBrush\&}{GetBrush}{\void}


@@ -503,18 +578,21 @@ Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}.
 
 Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
 
 
 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}}


@@ -527,6 +605,7 @@ 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::GetFont}\label{wxdcgetfont}
 
 \func{wxFont\&}{GetFont}{\void}


@@ -535,25 +614,45 @@ rectangle are returned as a tuple.}
 
 Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 
 
 Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 

+

 \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction}
 
 \func{int}{GetLogicalFunction}{\void}
 
 Gets the current logical function (see \helpref{wxDC::SetLogicalFunction}{wxdcsetlogicalfunction}).
 
 \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction}
 
 \func{int}{GetLogicalFunction}{\void}
 
 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::GetOptimization}\label{wxdcgetoptimization}
 
 \func{bool}{GetOptimization}{\void}
 

-Returns TRUE if device context optimization is on.
+Returns true if device context optimization is on.

 See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details.
 
 See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details.
 

+
+\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 begining of 
+{\it text} to the coresponding 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 implementaiton then it should be used
+instead. 
+
+\pythonnote{This method only takes the {\it text} parameter and
+  returns a Python list of integers.}
+

 \membersection{wxDC::GetPen}\label{wxdcgetpen}
 
 \func{wxPen\&}{GetPen}{\void}
 \membersection{wxDC::GetPen}\label{wxdcgetpen}
 
 \func{wxPen\&}{GetPen}{\void}


@@ -562,6 +661,7 @@ See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details.
 
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 
 
 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}}


@@ -575,6 +675,7 @@ 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::GetSize}\label{wxdcgetsize}
 
 \func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
 \membersection{wxDC::GetSize}\label{wxdcgetsize}
 
 \func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}


@@ -613,6 +714,7 @@ implements the following methods:\par
 \end{twocollist}
 }}
 
 \end{twocollist}
 }}
 

+

 \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
 
 \func{wxColour\&}{GetTextBackground}{\void}
 \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
 
 \func{wxColour\&}{GetTextBackground}{\void}


@@ -621,6 +723,7 @@ implements the following methods:\par
 
 Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
 
 
 Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
 

+

 \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}
 
 \func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\
 \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}
 
 \func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\


@@ -653,6 +756,7 @@ 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}
 
 \func{wxColour\&}{GetTextForeground}{\void}


@@ -662,15 +766,17 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
 Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}).
 
 
 Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}).
 
 

+

 \membersection{wxDC::GetUserScale}\label{wxdcgetuserscale}
 
 \func{void}{GetUserScale}{\param{double}{ *x}, \param{double}{ *y}}
 
 Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}).
 
 \membersection{wxDC::GetUserScale}\label{wxdcgetuserscale}
 
 \func{void}{GetUserScale}{\param{double}{ *x}, \param{double}{ *y}}
 
 Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}).
 

-\perlnote{In wxPerl this method takes no arguments and returna a two element
+\perlnote{In wxPerl this method takes no arguments and return a two element

  array {\tt ( x, y )}}
 
  array {\tt ( x, y )}}
 

+

 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 
 \func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}
 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 
 \func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}


@@ -678,12 +784,15 @@ Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetusersca
 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}
 
 \func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}
 
 Converts logical X coordinate to relative device coordinate, using the current
 \membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel}
 
 \func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}
 
 Converts logical X coordinate to relative device coordinate, using the current

-mapping mode. Use this for converting a width, for example.
+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}
 


@@ -692,12 +801,15 @@ mapping mode. Use this for converting a width, for example.
 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}
 
 \func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}
 
 Converts logical Y coordinate to relative device coordinate, using the current
 \membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel}
 
 \func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}
 
 Converts logical Y coordinate to relative device coordinate, using the current

-mapping mode. Use this for converting a height, for example.
+mapping mode but ignoring the y axis orientation.
+Use this for converting a height, for example.
+

 
 \membersection{wxDC::MaxX}\label{wxdcmaxx}
 
 
 \membersection{wxDC::MaxX}\label{wxdcmaxx}
 


@@ -705,29 +817,34 @@ mapping mode. Use this for converting a height, for example.
 
 Gets the maximum horizontal extent used in drawing commands so far.
 
 
 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}
 
 \func{bool}{Ok}{\void}
 
 \membersection{wxDC::Ok}\label{wxdcok}
 
 \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}
 


@@ -740,6 +857,25 @@ 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
+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.
+
+\wxheading{Parameters}
+
+\docparam{xLeftRight}{True to set the x axis orientation to the natural
+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.}
+
+

 \membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}
 
 \func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
 \membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}
 
 \func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}


@@ -750,12 +886,14 @@ applied).
 This function may be useful in Windows printing
 operations for placing a graphic on a page.
 
 This function may be useful in Windows printing
 operations for placing a graphic on a page.
 

+

 \membersection{wxDC::SetBackground}\label{wxdcsetbackground}
 
 \func{void}{SetBackground}{\param{const wxBrush\& }{brush}}
 
 Sets the current background brush for the DC.
 
 \membersection{wxDC::SetBackground}\label{wxdcsetbackground}
 
 \func{void}{SetBackground}{\param{const wxBrush\& }{brush}}
 
 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}}


@@ -763,20 +901,32 @@ 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::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}}
 

+\func{void}{SetClippingRegion}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}
+
+\func{void}{SetClippingRegion}{\param{const wxRect\&}{ rect}}
+

 \func{void}{SetClippingRegion}{\param{const wxRegion\&}{ region}}
 
 \func{void}{SetClippingRegion}{\param{const wxRegion\&}{ region}}
 

-Sets the clipping region for the DC. The clipping region is an area
-to which drawing is restricted. Possible uses for the clipping region are for clipping text
-or for speeding up window redraws when only a known area of the screen is damaged.
+Sets the clipping region for this device context to the intersection of the
+given region described by the parameters of this method and the previously set
+clipping region. You should call 
+\helpref{DestroyClippingRegion}{wxdcdestroyclippingregion} if you want to set
+the clipping region exactly to the region specified.
+
+The clipping region is an area to which drawing is restricted. Possible uses
+for the clipping region are for clipping text or for speeding up window redraws
+when only a known area of the screen is damaged.

 
 \wxheading{See also}
 
 \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion}
 
 
 \wxheading{See also}
 
 \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion}
 

+

 \membersection{wxDC::SetPalette}\label{wxdcsetpalette}
 
 \func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
 \membersection{wxDC::SetPalette}\label{wxdcsetpalette}
 
 \func{void}{SetPalette}{\param{const wxPalette\& }{palette}}


@@ -788,6 +938,7 @@ restored.
 
 See \helpref{wxPalette}{wxpalette} for further details.
 
 
 See \helpref{wxPalette}{wxpalette} for further details.
 

+

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


@@ -803,6 +954,7 @@ See also \helpref{wxBrush}{wxbrush}.
 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::SetFont}\label{wxdcsetfont}
 
 \func{void}{SetFont}{\param{const wxFont\& }{font}}
 \membersection{wxDC::SetFont}\label{wxdcsetfont}
 
 \func{void}{SetFont}{\param{const wxFont\& }{font}}


@@ -812,6 +964,7 @@ should not pass {\tt wxNullFont} to this method.
 
 See also \helpref{wxFont}{wxfont}.
 
 
 See also \helpref{wxFont}{wxfont}.
 

+

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


@@ -849,6 +1002,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}}


@@ -858,7 +1012,7 @@ measurement used to convert logical units to device units. Note that
 in X, text drawing isn't handled consistently with the mapping mode; a
 font is always specified in point size. However, setting the {\it
 user scale} (see \helpref{wxDC::SetUserScale}{wxdcsetuserscale}) scales the text appropriately. In
 in X, text drawing isn't handled consistently with the mapping mode; a
 font is always specified in point size. However, setting the {\it
 user scale} (see \helpref{wxDC::SetUserScale}{wxdcsetuserscale}) scales the text appropriately. In

-Windows, scaleable TrueType fonts are always used; in X, results depend
+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
 on availability of fonts, but usually a reasonable match is found.
 
 Note that the coordinate origin should ideally be selectable, but for


@@ -879,11 +1033,12 @@ The mapping mode can be one of the following:
 \twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.}
 \end{twocollist}
 
 \twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.}
 \end{twocollist}
 

+

 \membersection{wxDC::SetOptimization}\label{wxsetoptimization}
 
 \func{void}{SetOptimization}{\param{bool }{optimize}}
 
 \membersection{wxDC::SetOptimization}\label{wxsetoptimization}
 
 \func{void}{SetOptimization}{\param{bool }{optimize}}
 

-If {\it optimize} is TRUE (the default), this function sets optimization mode on.
+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
 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


@@ -893,6 +1048,7 @@ The wxWindows device context 'memory' will now be out of step with reality.
 Setting optimization off, drawing, then setting it back on again, is a trick
 that must occasionally be employed.
 
 Setting optimization off, drawing, then setting it back on again, is a trick
 that must occasionally be employed.
 

+

 \membersection{wxDC::SetPen}\label{wxdcsetpen}
 
 \func{void}{SetPen}{\param{const wxPen\& }{pen}}
 \membersection{wxDC::SetPen}\label{wxdcsetpen}
 
 \func{void}{SetPen}{\param{const wxPen\& }{pen}}


@@ -905,12 +1061,14 @@ context, and the original pen restored.
 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}}


@@ -920,6 +1078,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}}


@@ -927,6 +1086,7 @@ 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}}
 \membersection{wxDC::StartDoc}\label{wxdcstartdoc}
 
 \func{bool}{StartDoc}{\param{const wxString\& }{message}}


@@ -934,6 +1094,7 @@ Sets the user scaling factor, useful for applications which require
 Starts a document (only relevant when outputting to a printer).
 Message is a message to show whilst printing.
 
 Starts a document (only relevant when outputting to a printer).
 Message is a message to show whilst printing.
 

+

 \membersection{wxDC::StartPage}\label{wxdcstartpage}
 
 \func{bool}{StartPage}{\void}
 \membersection{wxDC::StartPage}\label{wxdcstartpage}
 
 \func{bool}{StartPage}{\void}


@@ -943,7 +1104,7 @@ 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
 \section{\class{wxDCClipper}}\label{wxdcclipper}
 
 This is a small helper class which sets the specified to its constructor

-clipping region and then automatically destroyes it in its destructor. Using
+clipping region and then automatically destroys it in its destructor. Using

 it ensures that unwanted clipping region is not left set on the DC.
 
 \wxheading{Derived from}
 it ensures that unwanted clipping region is not left set on the DC.
 
 \wxheading{Derived from}


@@ -960,6 +1121,7 @@ No base class
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxDCClipper::wxDCClipper}
 
 \func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{wxCoord }{x},\param{wxCoord }{y},\param{wxCoord }{w},\param{wxCoord }{h},}
 \membersection{wxDCClipper::wxDCClipper}
 
 \func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{wxCoord }{x},\param{wxCoord }{y},\param{wxCoord }{w},\param{wxCoord }{h},}


@@ -969,9 +1131,10 @@ No base class
 Constructor: sets the the clipping region for the given device context to the
 specified rectangle.
 
 Constructor: sets the the clipping region for the given device context to the
 specified rectangle.
 

+

 \membersection{wxDCClipper::\destruct{wxDCClipper}}
 
 \func{}{\destruct{wxDCClipper}}{\void}
 
 \membersection{wxDCClipper::\destruct{wxDCClipper}}
 
 \func{}{\destruct{wxDCClipper}}{\void}
 

-Destructor: destroyes the clipping region set in the constructor.
+Destructor: destroys the clipping region set in the constructor.