X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..78603ad208c39cfd20b9e39fb760851148120407:/docs/latex/wx/region.tex?ds=sidebyside diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex index 2246cba2cb..696a66fa92 100644 --- 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} @@ -48,15 +48,17 @@ provided array. {\it fillStyle} parameter may have values {\bf NB:} This constructor is only implemented for Win32 and GTK+ wxWidgets ports. +\func{}{wxRegion}{\param{const wxBitmap\&}{ bmp}} + \func{}{wxRegion}{\param{const wxBitmap\&}{ bmp}, - \param{const wxColour\&}{ transColour = wxNullColour}, + \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}} +\membersection{wxRegion::\destruct{wxRegion}}\label{wxregiondtor} \func{}{\destruct{wxRegion}}{\void} @@ -102,7 +104,7 @@ 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. @@ -139,7 +141,7 @@ is stored in this region. 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}} @@ -183,13 +185,19 @@ 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 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 = wxNullColour}, + \param{const wxColour\&}{ transColour}, \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 +bitmap. Colour to be treated as transparent is specified in the +\arg{transColour} argument, along with an optional colour tolerance value. \wxheading{Return value} @@ -254,7 +262,7 @@ See \helpref{wxPaintEvent}{wxpaintevent} for an example of use. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxRegionIterator::wxRegionIterator} +\membersection{wxRegionIterator::wxRegionIterator}\label{wxregioniteratorctor} \func{}{wxRegionIterator}{\void} @@ -264,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}. -\membersection{wxRegionIterator::Reset} +\membersection{wxRegionIterator::Reset}\label{wxregioniteratorreset} \func{void}{Reset}{\void} @@ -322,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} @@ -330,7 +338,7 @@ 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}