X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..649a48a216a3f373344826253ba43819555a60ee:/docs/latex/wx/region.tex diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex index 1d3c224ada..0ca8231cdf 100644 --- a/docs/latex/wx/region.tex +++ b/docs/latex/wx/region.tex @@ -8,6 +8,14 @@ reference counting, so copying and assignment operations are fast. \helpref{wxGDIObject}{wxgdiobject}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxRegionIterator}{wxregioniterator} + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxRegion::wxRegion}\label{wxregionconstr} @@ -16,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. @@ -32,6 +40,14 @@ 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. + \membersection{wxRegion::\destruct{wxRegion}} \func{}{\destruct{wxRegion}}{\void} @@ -81,7 +97,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. @@ -95,7 +111,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} @@ -106,9 +122,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}} @@ -120,16 +136,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. @@ -143,7 +170,7 @@ Finds the union of this region and another region. \wxheading{Return value} -TRUE if successful, FALSE otherwise. +{\tt TRUE} if successful, {\tt FALSE} otherwise. \wxheading{Remarks} @@ -152,7 +179,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. @@ -166,7 +193,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} @@ -179,4 +206,111 @@ for any overlapping areas. The result is stored in this region. Copies {\it region} by reference counting. +\section{\class{wxRegionIterator}}\label{wxregioniterator} + +This class is used to iterate through the rectangles in a region, +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{wxPaintEvent}{wxpaintevent} for an example of use. + +\wxheading{Derived from} + +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxPaintEvent}{wxpaintevent} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxRegionIterator::wxRegionIterator} + +\func{}{wxRegionIterator}{\void} + +Default constructor. + +\func{}{wxRegionIterator}{\param{const wxRegion\&}{ region}} + +Creates an iterator object given a region. + +\membersection{wxRegionIterator::GetX} + +\constfunc{wxCoord}{GetX}{\void} + +Returns the x value for the current region. + +\membersection{wxRegionIterator::GetY} + +\constfunc{wxCoord}{GetY}{\void} + +Returns the y value for the current region. + +\membersection{wxRegionIterator::GetW} + +\constfunc{wxCoord}{GetW}{\void} + +An alias for GetWidth. + +\membersection{wxRegionIterator::GetWidth} + +\constfunc{wxCoord}{GetWidth}{\void} + +Returns the width value for the current region. + +\membersection{wxRegionIterator::GetH} + +\constfunc{wxCoord}{GetH}{\void} + +An alias for GetHeight. + +\membersection{wxRegionIterator::GetHeight} + +\constfunc{wxCoord}{GetWidth}{\void} + +Returns the width value for the current region. + +\membersection{wxRegionIterator::GetRect} + +\constfunc{wxRect}{GetRect}{\void} + +Returns the current rectangle. + +\membersection{wxRegionIterator::HaveRects} + +\constfunc{bool}{HaveRects}{\void} + +Returns {\tt TRUE} if there are still some rectangles; otherwise returns {\tt FALSE}. + +\membersection{wxRegionIterator::Reset} + +\func{void}{Reset}{\void} + +Resets the iterator to the beginning of the rectangles. + +\func{void}{Reset}{\param{const wxRegion\&}{ region}} + +Resets the iterator to the given region. + +\membersection{wxRegionIterator::operator $++$} + +\func{void}{operator $++$}{\void} + +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} + +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.