added vendor display name (for consistency with app display name &c) (patch 1831303)

[wxWidgets.git] / docs / latex / wx / mask.tex

diff --git a/docs/latex/wx/mask.tex b/docs/latex/wx/mask.tex
index 8933486d1c822f91ded9a90449c6c82d380bdd91..c5c3cf2eb0be4a034b85f26ba41c6a1551a090fc 100644 (file)
--- 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
 \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}
 
 
 \wxheading{Derived from}
 


@@ -11,6 +12,10 @@ the unmasked area is white.
 
 <wx/bitmap.h>
 
 
 <wx/bitmap.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Remarks}
 
 A mask may be associated with a \helpref{wxBitmap}{wxbitmap}. It is used in \helpref{wxDC::Blit}{wxdcblit} when
 \wxheading{Remarks}
 
 A mask may be associated with a \helpref{wxBitmap}{wxbitmap}. It is used in \helpref{wxDC::Blit}{wxdcblit} when


@@ -23,23 +28,29 @@ contains a mask.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxMask::wxMask}\label{wxmaskconstr}
+\membersection{wxMask::wxMask}\label{wxmaskctor}

 
 \func{}{wxMask}{\void}
 
 Default constructor.
 
 
 \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.
 
 
 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.}
+
+\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.
 
 
 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}}
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -49,7 +60,7 @@ Constructs a mask from a bitmap and a palette index that indicates the backgroun
 
 \docparam{index}{Index into a palette, specifying the transparency colour.}
 
 
 \docparam{index}{Index into a palette, specifying the transparency colour.}
 

-\membersection{wxMask::\destruct{wxMask}}
+\membersection{wxMask::\destruct{wxMask}}\label{wxmaskdtor}

 
 \func{}{\destruct{wxMask}}{\void}
 
 
 \func{}{\destruct{wxMask}}{\void}
 


@@ -67,7 +78,8 @@ Constructs a mask from a bitmap and a colour that indicates the background.
 
 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
 
 
 \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}
 
 
 \wxheading{Parameters}