X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f35398824b11747a5930f729409b9fa59da3fad9..cd72551c2b6cbf67a4a5caf0ba00ba64e41183b2:/docs/latex/wx/dc.tex?ds=sidebyside diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index a090adaae7..b2d9573af9 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -61,11 +61,11 @@ 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{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, and -logical function. +coordinates, size of area to copy, source DC, source coordinates, +logical function, whether to use a bitmap mask, and mask source position. \wxheading{Parameters} @@ -86,7 +86,7 @@ logical function. \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 -selected into the source device context. The Windows implementation does the following: +selected into the source device context. The Windows implementation does the following if MaskBlt cannot be used: \begin{enumerate} \item Creates a temporary bitmap and copies the destination area into it. @@ -103,8 +103,21 @@ and the background colour set to WHITE. This sequence of operations ensures that the source's transparent area need not be black, 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 +or the explicit mask blitting code above is used, by using \helpref{wxSystemOptions}{wxsystemoptions} and +setting the {\bf no-maskblt} option to 1. + } +\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. @@ -115,6 +128,24 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage. \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask} +\begin{comment} +\membersection{wxDC::CacheEnabled}\label{wxdccacheenabled} + +\func{static bool}{CacheEnabled}{\void} + +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 using the cache functions in your code, please test for the +wxUSE\_DC\_CACHEING preprocessor symbol for portability. + +\wxheading{See also} + +\helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::ClearCache} +\end{comment} + \membersection{wxDC::CalcBoundingBox}\label{wxdccalcboundingbox} \func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}} @@ -133,6 +164,26 @@ Adds the specified point to the bounding box which can be retrieved with Clears the device context using the current background brush. +\begin{comment} +\membersection{wxDC::ClearCache}\label{wxdcclearcache} + +\func{static void}{ClearCache}{\void} + +On supported platforms (currently only Windows), clears +the contents of the DC cache (one bitmap and two Windows device contexts). The DC cache +can speed up the \helpref{Blit}{wxdcblit} operation when +drawing a large number of masked bitmaps. You should +call ClearCache at the end of length DC operations if you wish to only use +the cache transiently; you should also call it as your application exits. + +If using the cache functions in your code, please test for the +wxUSE\_DC\_CACHEING preprocessor symbol for portability. + +\wxheading{See also} + +\helpref{wxDC::EnableCache}{wxdcenablecache}, \helpref{wxDC::CacheEnabled} +\end{comment} + \membersection{wxDC::CrossHair}\label{wxdccrosshair} \func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} @@ -160,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} @@ -174,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} @@ -206,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} @@ -313,6 +386,11 @@ for filling the shape. Draws the text rotated by {\it angle} degrees. +{\bf NB:} Under Win9x only TrueType fonts can be drawn by this function. In +particular, a font different from {\tt wxNORMAL\_FONT} should be used as the +latter is not a TrueType font. {\tt wxSWISS\_FONT} is an example of a font +which is. + \wxheading{See also} \helpref{DrawText}{wxdcdrawtext} @@ -370,6 +448,23 @@ text more precisely. but it is ignored by wxMSW. Thus, you should avoid using logical functions with this function in portable programs. +\begin{comment} +\membersection{wxDC::EnableCache}\label{wxdcenablecache} + +\func{static void}{EnableCache}{\param{bool}{ enableCache}} + +On supported platforms (currently only Windows), enables the DC cache +which can speed up the \helpref{Blit}{wxdcblit} operation when +drawing a large number of masked bitmaps. + +If using the cache functions in your code, please test for the +wxUSE\_DC\_CACHEING preprocessor symbol for portability. + +\wxheading{See also} + +\helpref{wxDC::CacheEnabled}{wxdccacheenabled}, \helpref{wxDC::ClearCache} +\end{comment} + \membersection{wxDC::EndDoc}\label{wxdcenddoc} \func{void}{EndDoc}{\void} @@ -452,7 +547,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} @@ -536,7 +631,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} }} @@ -577,7 +672,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} @@ -596,7 +691,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 - array {\tt ( \$x, \$y )}} + array {\tt ( x, y )}} \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex} @@ -610,7 +705,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} @@ -624,7 +720,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} @@ -667,6 +764,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}} @@ -694,11 +808,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} @@ -734,11 +858,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}. @@ -870,3 +991,38 @@ Message is a message to show whilst printing. 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 +it ensures that unwanted clipping region is not left set on the DC. + +\wxheading{Derived from} + +No base class + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxDC}{wxdc} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxDCClipper::wxDCClipper} + +\func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{wxCoord }{x},\param{wxCoord }{y},\param{wxCoord }{w},\param{wxCoord }{h},} + +\func{}{wxDCClipper}{\param{wxDC\& }{dc}, \param{const wxRect\&}{ rect}} + +Constructor: sets the the clipping region for the given device context to the +specified rectangle. + +\membersection{wxDCClipper::\destruct{wxDCClipper}} + +\func{}{\destruct{wxDCClipper}}{\void} + +Destructor: destroyes the clipping region set in the constructor. +