toplevel code transferred to wxTopLevelWindow

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

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index b704196331a39ef09cc181f11ee526751c0bf8a9..5bb946f363f2b0ea638dbcb09bb1d511e0a5aa6c 100644 (file)
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -9,6 +9,13 @@ 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.
 
 Derived types of wxDC have documentation for specific features
 only, so refer to this section for most device context information.
 

+% 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
+Please note that in addition to the versions of the methods documented here,
+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.
+

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


@@ -54,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},
 
 \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
 
 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}
 
 
 \wxheading{Parameters}
 


@@ -79,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
 \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.
 
 \begin{enumerate}
 \item Creates a temporary bitmap and copies the destination area into it.


@@ -96,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.
 
 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.
 \wxheading{Remarks}
 
 There is partial support for Blit in wxPostScriptDC, under X.


@@ -108,12 +128,62 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
 
 \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}
 
 
 \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}}
+
+Adds the specified point to the bounding box which can be retrieved with 
+\helpref{MinX}{wxdcminx}, \helpref{MaxX}{wxdcmaxx} and 
+\helpref{MinY}{wxdcminy}, \helpref{MaxY}{wxdcmaxy} functions.
+
+\wxheading{See also}
+
+\helpref{ResetBoundingBox}{wxdcresetboundingbox}
+

 \membersection{wxDC::Clear}\label{wxdcclear}
 
 \func{void}{Clear}{\void}
 
 Clears the device context using the current background brush.
 
 \membersection{wxDC::Clear}\label{wxdcclear}
 
 \func{void}{Clear}{\void}
 
 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}}
 \membersection{wxDC::CrossHair}\label{wxdccrosshair}
 
 \func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}


@@ -176,9 +246,17 @@ 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
 of the bitmap (all bits set to 1), and the current text background colour to draw the background
 
 When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground
 of the bitmap (all bits set to 1), and the current text background colour to draw the background

-(all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground},
+(all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground}, 

 \helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}.
 
 \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}}
+
+\func{void}{DrawCheckMark}{\param{const wxRect \&}{rect}}
+
+Draws a check mark inside the given rectangle.
+

 \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}}


@@ -193,8 +271,7 @@ filling the shape.
  \param{double}{ start}, \param{double}{ end}}
 
 Draws an arc of an ellipse. The current pen is used for drawing the arc and
  \param{double}{ start}, \param{double}{ end}}
 
 Draws an arc of an ellipse. The current pen is used for drawing the arc and

-the current brush is used for drawing the pie. This function is currently only available for
-X window and PostScript device contexts.
+the current brush is used for drawing the pie.

 
 {\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains
 the ellipse.
 
 {\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains
 the ellipse.


@@ -236,6 +313,10 @@ 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.}
 

+\perlnote{The wxPerl version of this method accepts 
+  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},\\


@@ -259,6 +340,10 @@ Note that wxWindows 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.}
 

+\perlnote{The wxPerl version of this method accepts 
+  as its first parameter a reference to an array
+  of wxPoint objects.}
+

 \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}}


@@ -279,6 +364,11 @@ for filling the shape.
 
 Draws the text rotated by {\it angle} degrees.
 
 
 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}
 \wxheading{See also}
 
 \helpref{DrawText}{wxdcdrawtext}


@@ -316,6 +406,9 @@ Draws a three-point spline using the current pen.
 \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.}
 

+\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}}


@@ -328,6 +421,28 @@ the string. See \helpref{wxDC::GetTextExtent}{wxdcgettextextent} for how
 to get the dimensions of a text string, which can be used to position the
 text more precisely.
 
 to get the dimensions of a text string, which can be used to position the
 text more precisely.
 

+{\bf NB:} under wxGTK the current 
+\helpref{logical function}{wxdcgetlogicalfunction} is used by this function
+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}
 \membersection{wxDC::EndDoc}\label{wxdcenddoc}
 
 \func{void}{EndDoc}{\void}


@@ -350,10 +465,10 @@ 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{wxColour *}{colour}, \param{int}{ style=wxFLOOD\_SURFACE}}
+\func{void}{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, in the given 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:

 
 \begin{itemize}\itemsep=0pt
 \item wxFLOOD\_SURFACE: the flooding occurs until a colour other than the given colour is encountered.
 
 \begin{itemize}\itemsep=0pt
 \item wxFLOOD\_SURFACE: the flooding occurs until a colour other than the given colour is encountered.


@@ -366,12 +481,26 @@ and using a style:
 
 \func{wxBrush\&}{GetBackground}{\void}
 
 
 \func{wxBrush\&}{GetBackground}{\void}
 

+\constfunc{const wxBrush\&}{GetBackground}{\void}
+

 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}
+
+Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}.
+
+\wxheading{See also}
+
+\helpref{SetBackgroundMode}{wxdcsetbackgroundmode}
+

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

+\constfunc{const wxBrush\&}{GetBrush}{\void}
+

 Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
 
 \membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight}
 Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
 
 \membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight}


@@ -395,10 +524,15 @@ Gets the rectangle surrounding the current clipping region.
 \pythonnote{No arguments are required and the four values defining the
 rectangle are returned as a tuple.}
 
 \pythonnote{No arguments are required and the four values defining the
 rectangle are returned as a tuple.}
 

+\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}
 

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

 Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 
 \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction}
 Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 
 \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction}


@@ -424,6 +558,8 @@ See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details.
 
 \func{wxPen\&}{GetPen}{\void}
 
 
 \func{wxPen\&}{GetPen}{\void}
 

+\constfunc{const wxPen\&}{GetPen}{\void}
+

 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 
 \membersection{wxDC::GetPixel}\label{wxdcgetpixel}
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 
 \membersection{wxDC::GetPixel}\label{wxdcgetpixel}


@@ -436,6 +572,9 @@ is being worked on. Not available for wxPostScriptDC or wxMetafileDC.
 \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.}
 

+\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}}


@@ -466,10 +605,20 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+\perlnote{In place of a single overloaded method, wxPerl uses:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetSize()}}{Returns a Wx::Size}
+\twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list
+  {\tt ( width, height )}}
+\end{twocollist}
+}}
+

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

+\constfunc{const wxColour\&}{GetTextBackground}{\void}
+

 Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
 
 \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}
 Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
 
 \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}


@@ -499,10 +648,17 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+\perlnote{In wxPerl this method is implemented as 
+  {\bf GetTextExtent( string, font = undef )} returning a four element
+  array {\tt ( width, height, descent, externalLeading )}
+}
+

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

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

 Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}).
 
 
 Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}).
 
 


@@ -512,6 +668,8 @@ Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{w
 
 Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}).
 
 
 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 )}}

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


@@ -571,6 +729,17 @@ Gets the minimum vertical extent used in drawing commands so far.
 
 Returns TRUE if the DC is ok to use.
 
 
 Returns TRUE if the DC is ok to use.
 

+\membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox}
+
+\func{void}{ResetBoundingBox}{\void}
+
+Resets the bounding box: after a call to this function, the bounding box
+doesn't contain anything.
+
+\wxheading{See also}
+
+\helpref{CalcBoundingBox}{wxdccalcboundingbox}
+

 \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}}


@@ -774,3 +943,38 @@ 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 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}
+
+<wx/dc.h>
+
+\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.
+