eVC3 (older WinCE) build fix.

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

diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex
index dbffb944659a914425abd783bcd00def3bfb6f84..fed642106c29e17ad5af97da05704267f18bd809 100644 (file)
--- a/docs/latex/wx/region.tex
+++ b/docs/latex/wx/region.tex
@@ -18,7 +18,7 @@ reference counting, so copying and assignment operations are fast.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxRegion::wxRegion}\label{wxregionconstr}
+\membersection{wxRegion::wxRegion}\label{wxregionctor}
 
 \func{}{wxRegion}{\void}
 
@@ -43,12 +43,22 @@ Constructs a region by copying another region.
 \func{}{wxRegion}{\param{size\_t}{ n}, \param{const wxPoint }{*points}, \param{int }{fillStyle = wxWINDING\_RULE}}
 
 Constructs a region corresponding to the polygon made of {\it n} points in the
-provided array. {\it fillStyle} parameter may have values 
+provided array. {\it fillStyle} parameter may have values
 {\tt wxWINDING\_RULE} or {\tt wxODDEVEN\_RULE}.
 
-{\bf NB:} This constructor is only implemented for Win32 and GTK+ wxWindows ports.
+{\bf NB:} This constructor is only implemented for Win32 and GTK+ wxWidgets ports.
 
-\membersection{wxRegion::\destruct{wxRegion}}
+\func{}{wxRegion}{\param{const wxBitmap\&}{ bmp}}
+
+\func{}{wxRegion}{\param{const wxBitmap\&}{ bmp},
+                  \param{const wxColour\&}{ transColour},
+                 \param{int}{ tolerance = 0}}
+
+Constructs a region using the non-transparent pixels of a bitmap.  See
+\helpref{Union}{wxregionunion} for more details.
+
+
+\membersection{wxRegion::\destruct{wxRegion}}\label{wxregiondtor}
 
 \func{}{\destruct{wxRegion}}{\void}
 
@@ -85,9 +95,16 @@ The return value is one of wxOutRegion, wxPartRegion and wxInRegion.
 On Windows, only wxOutRegion and wxInRegion are returned; a value wxInRegion then indicates that
 all or some part of the region is contained in this region.
 
+\membersection{wxRegion::ConvertToBitmap}\label{wxregionconverttobitmap}
+
+\constfunc{wxBitmap}{ConvertToBitmap}{}
+
+Convert the region to a black and white bitmap with the white pixels
+being inside the region.
+
 \membersection{wxRegion::GetBox}\label{wxregiongetbox}
 
-\constfunc{void}{GetBox}{\param{long\& }{x}, \param{long\& }{y}, \param{long\& }{width}, \param{long\& }{height}}
+\constfunc{void}{GetBox}{\param{wxCoord\& }{x}, \param{wxCoord\& }{y}, \param{wxCoord\& }{width}, \param{wxCoord\& }{height}}
 
 Returns the outer bounds of the region.
 
@@ -111,7 +128,7 @@ Finds the intersection of this region and another region.
 
 \wxheading{Return value}
 
-{\tt TRUE} if successful, {\tt FALSE} otherwise.
+{\tt true} if successful, {\tt false} otherwise.
 
 \wxheading{Remarks}
 
@@ -122,9 +139,9 @@ is stored in this region.
 
 \constfunc{bool}{IsEmpty}{\void}
 
-Returns {\tt TRUE} if the region is empty, {\tt FALSE} otherwise.
+Returns {\tt true} if the region is empty, {\tt false} otherwise.
 
-\membersection{wxRegion::Subtract}\label{wxregionsubstract}
+\membersection{wxRegion::Subtract}\label{wxregionsubtract}
 
 \func{bool}{Subtract}{\param{const wxRect\&}{ rect}}
 
@@ -136,7 +153,7 @@ Subtracts a region from this region.
 
 \wxheading{Return value}
 
-{\tt TRUE} if successful, {\tt FALSE} otherwise.
+{\tt true} if successful, {\tt false} otherwise.
 
 \wxheading{Remarks}
 
@@ -152,7 +169,7 @@ directions.
 
 \wxheading{Return value}
 
-{\tt TRUE} if successful, {\tt FALSE} otherwise (the region is unchanged then).
+{\tt true} if successful, {\tt false} otherwise (the region is unchanged then).
 
 \membersection{wxRegion::Union}\label{wxregionunion}
 
@@ -168,9 +185,24 @@ Finds the union of this region and another, rectangular region.
 
 Finds the union of this region and another region.
 
+\func{bool}{Union}{\param{const wxBitmap\&}{ bmp}}
+
+Finds the union of this region and the non-transparent pixels of a
+bitmap. Bitmap's mask is used to determine transparency. If the bitmap doesn't
+have a mask, solid rectangle of bitmap's dimensions is used.
+
+\func{bool}{Union}{\param{const wxBitmap\&}{ bmp},
+                  \param{const wxColour\&}{ transColour},
+                 \param{int}{ tolerance = 0}}
+
+Finds the union of this region and the non-transparent pixels of a
+bitmap. Colour to be treated as transparent is specified in the
+\arg{transColour} argument, along with an
+optional colour tolerance value.
+
 \wxheading{Return value}
 
-{\tt TRUE} if successful, {\tt FALSE} otherwise.
+{\tt true} if successful, {\tt false} otherwise.
 
 \wxheading{Remarks}
 
@@ -193,7 +225,7 @@ Finds the Xor of this region and another region.
 
 \wxheading{Return value}
 
-{\tt TRUE} if successful, {\tt FALSE} otherwise.
+{\tt true} if successful, {\tt false} otherwise.
 
 \wxheading{Remarks}
 
@@ -214,7 +246,7 @@ typically when examining the damaged regions of a window within an OnPaint call.
 To use it, construct an iterator object on the stack and loop through the
 regions, testing the object and incrementing the iterator at the end of the loop.
 
-See \helpref{wxWindow::OnPaint}{wxwindowonpaint} for an example of use.
+See \helpref{wxPaintEvent}{wxpaintevent} for an example of use.
 
 \wxheading{Derived from}
 
@@ -226,11 +258,11 @@ See \helpref{wxWindow::OnPaint}{wxwindowonpaint} for an example of use.
 
 \wxheading{See also}
 
-\helpref{wxWindow::OnPaint}{wxwindowonpaint}
+\helpref{wxPaintEvent}{wxpaintevent}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxRegionIterator::wxRegionIterator}
+\membersection{wxRegionIterator::wxRegionIterator}\label{wxregioniteratorctor}
 
 \func{}{wxRegionIterator}{\void}
 
@@ -240,55 +272,55 @@ Default constructor.
 
 Creates an iterator object given a region.
 
-\membersection{wxRegionIterator::GetX}
+\membersection{wxRegionIterator::GetX}\label{wxregioniteratorgetx}
 
 \constfunc{wxCoord}{GetX}{\void}
 
 Returns the x value for the current region.
 
-\membersection{wxRegionIterator::GetY}
+\membersection{wxRegionIterator::GetY}\label{wxregioniteratorgety}
 
 \constfunc{wxCoord}{GetY}{\void}
 
 Returns the y value for the current region.
 
-\membersection{wxRegionIterator::GetW}
+\membersection{wxRegionIterator::GetW}\label{wxregioniteratorgetw}
 
 \constfunc{wxCoord}{GetW}{\void}
 
 An alias for GetWidth.
 
-\membersection{wxRegionIterator::GetWidth}
+\membersection{wxRegionIterator::GetHeight}\label{wxregioniteratorgetheight}
 
-\constfunc{wxCoord}{GetWidth}{\void}
+\constfunc{wxCoord}{GetHeight}{\void}
 
-Returns the width value for the current region.
+Returns the height value for the current region.
 
-\membersection{wxRegionIterator::GetH}
+\membersection{wxRegionIterator::GetH}\label{wxregioniteratorgeth}
 
 \constfunc{wxCoord}{GetH}{\void}
 
 An alias for GetHeight.
 
-\membersection{wxRegionIterator::GetHeight}
+\membersection{wxRegionIterator::GetRect}\label{wxregioniteratorgetrect}
 
-\constfunc{wxCoord}{GetWidth}{\void}
+\constfunc{wxRect}{GetRect}{\void}
 
-Returns the width value for the current region.
+Returns the current rectangle.
 
-\membersection{wxRegionIterator::GetRect}
+\membersection{wxRegionIterator::GetWidth}\label{wxregioniteratorgetwidth}
 
-\constfunc{wxRect}{GetRect}{\void}
+\constfunc{wxCoord}{GetWidth}{\void}
 
-Returns the current rectangle.
+Returns the width value for the current region.
 
-\membersection{wxRegionIterator::HaveRects}
+\membersection{wxRegionIterator::HaveRects}\label{wxregioniteratorhaverects}
 
 \constfunc{bool}{HaveRects}{\void}
 
-Returns {\tt TRUE} if there are still some rectangles; otherwise returns {\tt FALSE}.
+Returns {\tt true} if there are still some rectangles; otherwise returns {\tt false}.
 
-\membersection{wxRegionIterator::Reset}
+\membersection{wxRegionIterator::Reset}\label{wxregioniteratorreset}
 
 \func{void}{Reset}{\void}
 
@@ -298,7 +330,7 @@ Resets the iterator to the beginning of the rectangles.
 
 Resets the iterator to the given region.
 
-\membersection{wxRegionIterator::operator $++$}
+\membersection{wxRegionIterator::operator $++$}\label{wxregioniteratorinc}
 
 \func{void}{operator $++$}{\void}
 
@@ -306,11 +338,11 @@ Increment operator. Increments the iterator to the next region.
 
 \pythonnote{A wxPython alias for this operator is called {\tt Next}.}
 
-\membersection{wxRegionIterator::operator bool}
+\membersection{wxRegionIterator::operator bool}\label{wxregioniteratorbool}
 
 \constfunc{}{operator bool}{\void}
 
-Returns {\tt TRUE} if there are still some rectangles; otherwise returns {\tt FALSE}.
+Returns {\tt true} if there are still some rectangles; otherwise returns {\tt false}.
 
 You can use this to test the iterator object as if it were of type bool.