Applied patch [ 619539 ] patch to get small icon via geticon

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

diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex
index ad356d307ab1495f3b8360e063e42d8d858f6e2b..c80bdeb535318ea8fa4c3e26e47175f649a6b937 100644 (file)
--- a/docs/latex/wx/region.tex
+++ b/docs/latex/wx/region.tex
@@ -24,7 +24,7 @@ reference counting, so copying and assignment operations are fast.
 
 Default constructor.
 
-\func{}{wxRegion}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}}
+\func{}{wxRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 
 Constructs a rectangular region with the given position and size.
 
@@ -40,6 +40,22 @@ Constructs a rectangular region a wxRect object.
 
 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
+{\tt wxWINDING\_RULE} or {\tt wxODDEVEN\_RULE}.
+
+{\bf NB:} This constructor is only implemented for Win32 and GTK+ wxWindows ports.
+
+\func{}{wxRegion}{\param{const wxBitmap&}{ bmp},
+                  \param{const wxColour&}{ transColour = wxNullColour},
+                 \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}}
 
 \func{}{\destruct{wxRegion}}{\void}
@@ -77,6 +93,13 @@ 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}}
@@ -89,7 +112,7 @@ Returns the outer bounds of the region.
 
 \membersection{wxRegion::Intersect}\label{wxregionintersect}
 
-\func{bool}{Intersect}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}}
+\func{bool}{Intersect}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 
 Finds the intersection of this region and another, rectangular region, specified using position and size.
 
@@ -103,7 +126,7 @@ Finds the intersection of this region and another region.
 
 \wxheading{Return value}
 
-TRUE if successful, FALSE otherwise.
+{\tt true} if successful, {\tt false} otherwise.
 
 \wxheading{Remarks}
 
@@ -114,9 +137,9 @@ is stored in this region.
 
 \constfunc{bool}{IsEmpty}{\void}
 
-\func{bool}{IsEmpty}{\void}
+Returns {\tt true} if the region is empty, {\tt false} otherwise.
 
-Returns TRUE if the region is empty, FALSE otherwise.
+\membersection{wxRegion::Subtract}\label{wxregionsubstract}
 
 \func{bool}{Subtract}{\param{const wxRect\&}{ rect}}
 
@@ -128,16 +151,27 @@ Subtracts a region from this region.
 
 \wxheading{Return value}
 
-TRUE if successful, FALSE otherwise.
+{\tt true} if successful, {\tt false} otherwise.
 
 \wxheading{Remarks}
 
 This operation combines the parts of 'this' region that are not part of the second region.
 The result is stored in this region.
 
+\membersection{wxRegion::Offset}\label{wxregionoffset}
+
+\func{bool}{Offset}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
+
+Moves the region by the specified offsets in horizontal and vertical
+directions.
+
+\wxheading{Return value}
+
+{\tt true} if successful, {\tt false} otherwise (the region is unchanged then).
+
 \membersection{wxRegion::Union}\label{wxregionunion}
 
-\func{bool}{Union}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}}
+\func{bool}{Union}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 
 Finds the union of this region and another, rectangular region, specified using position and size.
 
@@ -149,9 +183,18 @@ 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},
+                  \param{const wxColour&}{ transColour = wxNullColour},
+                 \param{int}{ tolerance = 0}}
+
+Finds the union of this region and the the non-transparent pixels of a
+bitmap.  If the bitmap has a mask then it will be used, otherwise the
+colour to be treated as transparent may be specified, along with an
+optional colour tolerance value.
+
 \wxheading{Return value}
 
-TRUE if successful, FALSE otherwise.
+{\tt true} if successful, {\tt false} otherwise.
 
 \wxheading{Remarks}
 
@@ -160,7 +203,7 @@ The result is stored in this region.
 
 \membersection{wxRegion::Xor}\label{wxregionxor}
 
-\func{bool}{Xor}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}}
+\func{bool}{Xor}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 
 Finds the Xor of this region and another, rectangular region, specified using position and size.
 
@@ -174,7 +217,7 @@ Finds the Xor of this region and another region.
 
 \wxheading{Return value}
 
-TRUE if successful, FALSE otherwise.
+{\tt true} if successful, {\tt false} otherwise.
 
 \wxheading{Remarks}
 
@@ -195,7 +238,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}
 
@@ -207,7 +250,7 @@ See \helpref{wxWindow::OnPaint}{wxwindowonpaint} for an example of use.
 
 \wxheading{See also}
 
-\helpref{wxWindow::OnPaint}{wxwindowonpaint}
+\helpref{wxPaintEvent}{wxpaintevent}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -223,37 +266,37 @@ Creates an iterator object given a region.
 
 \membersection{wxRegionIterator::GetX}
 
-\constfunc{long}{GetX}{\void}
+\constfunc{wxCoord}{GetX}{\void}
 
 Returns the x value for the current region.
 
 \membersection{wxRegionIterator::GetY}
 
-\constfunc{long}{GetY}{\void}
+\constfunc{wxCoord}{GetY}{\void}
 
 Returns the y value for the current region.
 
 \membersection{wxRegionIterator::GetW}
 
-\constfunc{long}{GetW}{\void}
+\constfunc{wxCoord}{GetW}{\void}
 
 An alias for GetWidth.
 
 \membersection{wxRegionIterator::GetWidth}
 
-\constfunc{long}{GetWidth}{\void}
+\constfunc{wxCoord}{GetWidth}{\void}
 
 Returns the width value for the current region.
 
 \membersection{wxRegionIterator::GetH}
 
-\constfunc{long}{GetH}{\void}
+\constfunc{wxCoord}{GetH}{\void}
 
 An alias for GetHeight.
 
 \membersection{wxRegionIterator::GetHeight}
 
-\constfunc{long}{GetWidth}{\void}
+\constfunc{wxCoord}{GetWidth}{\void}
 
 Returns the width value for the current region.
 
@@ -267,7 +310,7 @@ Returns the current rectangle.
 
 \constfunc{bool}{HaveRects}{\void}
 
-Returns TRUE if there are still some rectangles; otherwise returns FALSE.
+Returns {\tt true} if there are still some rectangles; otherwise returns {\tt false}.
 
 \membersection{wxRegionIterator::Reset}
 
@@ -285,13 +328,13 @@ Resets the iterator to the given region.
 
 Increment operator. Increments the iterator to the next region.
 
-\pythonnote{A wxPython alias for this operator is called \tt{Next}.}
+\pythonnote{A wxPython alias for this operator is called {\tt Next}.}
 
 \membersection{wxRegionIterator::operator bool}
 
 \constfunc{}{operator bool}{\void}
 
-Returns TRUE if there are still some rectangles; otherwise returns 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.