]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/mask.tex
wxPython documentation updates
[wxWidgets.git] / docs / latex / wx / mask.tex
index 7f004df69e5e9796078b0fa91149ad97b651b7f6..6420a633c8f5eedf48dfca400794fc11a143b0d0 100644 (file)
@@ -7,6 +7,10 @@ the unmasked area is white.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/bitmap.h>
+
 \wxheading{Remarks}
 
 A mask may be associated with a \helpref{wxBitmap}{wxbitmap}. It is used in \helpref{wxDC::Blit}{wxdcblit} when
@@ -29,13 +33,20 @@ Default constructor.
 
 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}}
 
-Constructs a mask from a bitmap and a colour that indicates the background.
+Constructs a mask from a bitmap and a colour that indicates the background. Not
+yet implemented for GTK.
+
+\pythonnote{wxPython has an alternate wxMask constructor matching this
+form called \tt{wxMaskColour}.}
 
 \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
 
-Constructs a mask from a bitmap and a palette index that indicates the background.
+Constructs a mask from a bitmap and a palette index that indicates the background. Not
+yet implemented for GTK.
 
 \wxheading{Parameters}
 
@@ -59,11 +70,13 @@ 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.
+Constructs a mask from a bitmap and a colour that indicates the background. Not
+yet implemented for GTK.
 
 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
 
-Constructs a mask from a bitmap and a palette index that indicates the background.
+Constructs a mask from a bitmap and a palette index that indicates the background. Not
+yet implemented for GTK.
 
 \wxheading{Parameters}