]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/region.tex
documented wxWindow::GetFont change
[wxWidgets.git] / docs / latex / wx / region.tex
index 1f26deea5dbd78077d58f673e5f5824d05fa0c95..09b6beb2ad9af5f701d2e3c1e82f048d4679224b 100644 (file)
@@ -46,10 +46,12 @@ 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.
+{\bf NB:} This constructor is only implemented for Win32 and GTK+ wxWidgets ports.
 
-\func{}{wxRegion}{\param{const wxBitmap&}{ bmp},
-                  \param{const wxColour&}{ transColour = wxNullColour},
+\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
@@ -97,7 +99,7 @@ all or some part of the region is contained in this region.
 
 \constfunc{wxBitmap}{ConvertToBitmap}{}
 
-Convert the region to a black and white bitmap with the black pixels
+Convert the region to a black and white bitmap with the white pixels
 being inside the region.
 
 \membersection{wxRegion::GetBox}\label{wxregiongetbox}
@@ -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},
-                  \param{const wxColour&}{ transColour = wxNullColour},
+\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},
                  \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}