X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5230934a95bf9b3112ec2a7e070e8cbb4cea7f55..11ebea162a1d99032aa98ac649d61aaf08e428e8:/docs/latex/wx/dc.tex

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index f756cd292a..7a2c520f96 100644
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -61,7 +61,7 @@ released for each drawing operation.
 
 \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,
@@ -85,7 +85,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{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}
@@ -133,7 +133,7 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
 
 \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.
@@ -243,7 +243,7 @@ The arc is drawn in an anticlockwise direction from the start point to the end p
 
 \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
@@ -259,13 +259,33 @@ of the bitmap (all bits set to 1), and the current text background colour to dra
 
 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}}
 
-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}
 
@@ -299,7 +319,9 @@ This can be the simplest way of drawing bitmaps on a window.
 \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}
 
@@ -467,7 +489,7 @@ Ends a document page (only relevant when outputting to a printer).
 
 \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:
@@ -477,7 +499,11 @@ 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}
 
-{\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}
 
@@ -553,7 +579,7 @@ Gets the {\it mapping mode} for the device context (see \helpref{wxDC::SetMapMod
 
 \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.
 
 \membersection{wxDC::GetPen}\label{wxdcgetpen}
@@ -670,7 +696,7 @@ Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{w
 
 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 )}}
 
 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
@@ -731,7 +757,7 @@ Gets the minimum vertical extent used in drawing commands so far.
 
 \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}
 
@@ -889,7 +915,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
-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
@@ -914,7 +940,7 @@ The mapping mode can be one of the following:
 
 \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
@@ -974,7 +1000,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
-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}
@@ -1004,5 +1030,5 @@ specified rectangle.
 
 \func{}{\destruct{wxDCClipper}}{\void}
 
-Destructor: destroyes the clipping region set in the constructor.
+Destructor: destroys the clipping region set in the constructor.
 
