Some work on GTK focus handling and events.

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

diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex
index a2828e8e244314f4a5791bf86e542b6380f4fcda..dbffb944659a914425abd783bcd00def3bfb6f84 100644 (file)
--- a/docs/latex/wx/region.tex
+++ b/docs/latex/wx/region.tex
@@ -8,6 +8,10 @@ reference counting, so copying and assignment operations are fast.
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/region.h>
+

 \wxheading{See also}
 
 \helpref{wxRegionIterator}{wxregioniterator}
 \wxheading{See also}
 
 \helpref{wxRegionIterator}{wxregioniterator}


@@ -20,7 +24,7 @@ reference counting, so copying and assignment operations are fast.
 
 Default constructor.
 
 
 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.
 
 
 Constructs a rectangular region with the given position and size.
 


@@ -36,6 +40,14 @@ Constructs a rectangular region a wxRect object.
 
 Constructs a region by copying another region.
 
 
 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.
+

 \membersection{wxRegion::\destruct{wxRegion}}
 
 \func{}{\destruct{wxRegion}}{\void}
 \membersection{wxRegion::\destruct{wxRegion}}
 
 \func{}{\destruct{wxRegion}}{\void}


@@ -85,7 +97,7 @@ Returns the outer bounds of the region.
 
 \membersection{wxRegion::Intersect}\label{wxregionintersect}
 
 
 \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.
 
 
 Finds the intersection of this region and another, rectangular region, specified using position and size.
 


@@ -99,7 +111,7 @@ Finds the intersection of this region and another region.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if successful, FALSE otherwise.
+{\tt TRUE} if successful, {\tt FALSE} otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -110,9 +122,9 @@ is stored in this region.
 
 \constfunc{bool}{IsEmpty}{\void}
 
 
 \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}}
 
 
 \func{bool}{Subtract}{\param{const wxRect\&}{ rect}}
 


@@ -124,16 +136,27 @@ Subtracts a region from this region.
 
 \wxheading{Return value}
 
 
 \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.
 
 
 \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}
 
 \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.
 
 
 Finds the union of this region and another, rectangular region, specified using position and size.
 


@@ -147,7 +170,7 @@ Finds the union of this region and another region.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if successful, FALSE otherwise.
+{\tt TRUE} if successful, {\tt FALSE} otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -156,7 +179,7 @@ The result is stored in this region.
 
 \membersection{wxRegion::Xor}\label{wxregionxor}
 
 
 \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.
 
 
 Finds the Xor of this region and another, rectangular region, specified using position and size.
 


@@ -170,7 +193,7 @@ Finds the Xor of this region and another region.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if successful, FALSE otherwise.
+{\tt TRUE} if successful, {\tt FALSE} otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -197,6 +220,10 @@ See \helpref{wxWindow::OnPaint}{wxwindowonpaint} for an example of use.
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/region.h>
+

 \wxheading{See also}
 
 \helpref{wxWindow::OnPaint}{wxwindowonpaint}
 \wxheading{See also}
 
 \helpref{wxWindow::OnPaint}{wxwindowonpaint}


@@ -215,37 +242,37 @@ Creates an iterator object given a region.
 
 \membersection{wxRegionIterator::GetX}
 
 
 \membersection{wxRegionIterator::GetX}
 

-\constfunc{long}{GetX}{\void}
+\constfunc{wxCoord}{GetX}{\void}

 
 Returns the x value for the current region.
 
 \membersection{wxRegionIterator::GetY}
 
 
 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}
 
 
 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}
 
 
 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}
 
 
 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}
 
 
 An alias for GetHeight.
 
 \membersection{wxRegionIterator::GetHeight}
 

-\constfunc{long}{GetWidth}{\void}
+\constfunc{wxCoord}{GetWidth}{\void}

 
 Returns the width value for the current region.
 
 
 Returns the width value for the current region.
 


@@ -259,7 +286,7 @@ Returns the current rectangle.
 
 \constfunc{bool}{HaveRects}{\void}
 
 
 \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}
 
 
 \membersection{wxRegionIterator::Reset}
 


@@ -277,11 +304,13 @@ Resets the iterator to the given region.
 
 Increment operator. Increments the iterator to the next region.
 
 
 Increment operator. Increments the iterator to the next region.
 

+\pythonnote{A wxPython alias for this operator is called {\tt Next}.}
+

 \membersection{wxRegionIterator::operator bool}
 
 \constfunc{}{operator bool}{\void}
 
 \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.
 
 
 You can use this to test the iterator object as if it were of type bool.