X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4770df95a0ace5e4e8f67e8ea85392e464fbaad2..ff7047fde523c91a0065a6f1028ee87a7cba5a88:/docs/latex/wx/dc.tex diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index 95d44545be..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. @@ -211,7 +211,8 @@ mapping mode. \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} @@ -225,7 +226,8 @@ mapping mode. \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} @@ -241,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 @@ -257,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} @@ -297,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} @@ -465,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: @@ -475,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} @@ -525,7 +553,7 @@ Gets the rectangle surrounding the current clipping region. rectangle are returned as a tuple.} \perlnote{This method takes no arguments and returns a four element list -{\tt ( \$x, \$y, \$width, \$height )}} +{\tt ( x, y, width, height )}} \membersection{wxDC::GetFont}\label{wxdcgetfont} @@ -551,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} @@ -609,7 +637,7 @@ implements the following methods:\par \indented{2cm}{\begin{twocollist} \twocolitem{{\bf GetSize()}}{Returns a Wx::Size} \twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list - {\tt ( \$width, \$height )}} + {\tt ( width, height )}} \end{twocollist} }} @@ -650,7 +678,7 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}. \perlnote{In wxPerl this method is implemented as {\bf GetTextExtent( string, font = undef )} returning a four element - array {\tt ( \$width, \$height, \$descent, \$externalLeading )} + array {\tt ( width, height, descent, externalLeading )} } \membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground} @@ -668,8 +696,8 @@ 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 - array {\tt ( \$x, \$y )}} +\perlnote{In wxPerl this method takes no arguments and return a two element + array {\tt ( x, y )}} \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex} @@ -683,7 +711,8 @@ mapping mode. \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} @@ -697,7 +726,8 @@ mapping mode. \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} @@ -727,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} @@ -740,6 +770,23 @@ doesn't contain anything. \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}} @@ -767,11 +814,21 @@ whether text will be drawn with a background colour or not. \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}} -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} @@ -807,11 +864,8 @@ when drawing into a monochrome bitmap. \func{void}{SetFont}{\param{const wxFont\& }{font}} -Sets the current font for the DC. - -If the argument is wxNullFont, the current font is selected out of the device -context, and the original font restored, allowing the current font to -be destroyed safely. +Sets the current font for the DC. It must be a valid font, in particular you +should not pass {\tt wxNullFont} to this method. See also \helpref{wxFont}{wxfont}. @@ -861,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 @@ -886,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 @@ -946,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} @@ -976,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.