X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/91b8de8dee3e7ae3c4edc0ab0923b84bba20d9c4..917be7ed065337e8a7a67615969ecaade9eea809:/docs/latex/wx/mask.tex?ds=inline diff --git a/docs/latex/wx/mask.tex b/docs/latex/wx/mask.tex index cfe8fc68d1..96a473096c 100644 --- a/docs/latex/wx/mask.tex +++ b/docs/latex/wx/mask.tex @@ -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} @@ -23,20 +24,24 @@ contains a mask. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMask::wxMask}\label{wxmaskconstr} +\membersection{wxMask::wxMask}\label{wxmaskctor} \func{}{wxMask}{\void} Default constructor. -\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}} +\func{}{wxMask}{\param{const \helpref{wxBitmap}{wxbitmap}\& }{bitmap}} Constructs a mask from a monochrome bitmap. -\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}} +\pythonnote{This is the default constructor for wxMask in wxPython.} -Constructs a mask from a bitmap and a colour that indicates the background. Not -yet implemented for GTK. +\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. + +\pythonnote{wxPython has an alternate wxMask constructor matching this +form called {\tt wxMaskColour}.} \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}} @@ -51,7 +56,7 @@ yet implemented for GTK. \docparam{index}{Index into a palette, specifying the transparency colour.} -\membersection{wxMask::\destruct{wxMask}} +\membersection{wxMask::\destruct{wxMask}}\label{wxmaskdtor} \func{}{\destruct{wxMask}}{\void} @@ -65,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}}