From 6c975af106877241716b2e324983e86fc18322a7 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 9 Jul 2001 18:31:53 +0000 Subject: [PATCH] documented wxDCClipper git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@10918 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/category.tex | 1 + docs/latex/wx/dc.tex | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index ce41326a43..7e04c61f86 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -164,6 +164,7 @@ These classes are related to drawing on device contexts and windows. \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxColour}{wxcolour}}{Represents the red, blue and green elements of a colour} +\twocolitem{\helpref{wxDCClipper}{wxdcclipper}}{Wraps the operations of setting and destroying the clipping region} \twocolitem{\helpref{wxBitmap}{wxbitmap}}{Represents a bitmap} \twocolitem{\helpref{wxBrush}{wxbrush}}{Used for filling areas on a device context} \twocolitem{\helpref{wxBrushList}{wxbrushlist}}{The list of previously-created brushes} diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex index a090adaae7..d77950b563 100644 --- a/docs/latex/wx/dc.tex +++ b/docs/latex/wx/dc.tex @@ -870,3 +870,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. + -- 2.45.2