]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/mask.tex
toplevel code transferred to wxTopLevelWindow
[wxWidgets.git] / docs / latex / wx / mask.tex
index 6420a633c8f5eedf48dfca400794fc11a143b0d0..86e80d898dcf3c036c131c1df4a0228d6e7f0fe2 100644 (file)
@@ -1,7 +1,8 @@
 \section{\class{wxMask}}\label{wxmask}
 
 This class encapsulates a monochrome mask bitmap, where the masked area is black and
-the unmasked area is white.
+the unmasked area is white. When associated with a bitmap and drawn in a device context,
+the unmasked area of the bitmap will be drawn, and the masked area will not be drawn.
 
 \wxheading{Derived from}
 
@@ -29,19 +30,18 @@ contains a mask.
 
 Default constructor.
 
-\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}}
+\func{}{wxMask}{\param{const \helpref{wxBitmap}{wxbitmap}\& }{bitmap}}
 
 Constructs a mask from a monochrome bitmap.
 
 \pythonnote{This is the default constructor for wxMask in wxPython.}
 
-\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}}
+\func{}{wxMask}{\param{const \helpref{wxBitmap}{wxbitmap}\& }{bitmap}, \param{const \helpref{wxColour}{wxcolour}\& }{colour}}
 
-Constructs a mask from a bitmap and a colour that indicates the background. Not
-yet implemented for GTK.
+Constructs a mask from a bitmap and a colour that indicates the background.
 
 \pythonnote{wxPython has an alternate wxMask constructor matching this
-form called \tt{wxMaskColour}.}
+form called {\tt wxMaskColour}.}
 
 \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
 
@@ -70,8 +70,7 @@ Constructs a mask from a monochrome bitmap.
 
 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}}
 
-Constructs a mask from a bitmap and a colour that indicates the background. Not
-yet implemented for GTK.
+Constructs a mask from a bitmap and a colour that indicates the background.
 
 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}