Added Set/GetSelection to wxPrintDialogData (the value of the Selection radio button);

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

diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex
index 0deb875036975a07a13e5094739bf47aac64271a..efe5732d7bd59a50a0cd4e9f975210fc7951512e 100644 (file)
--- a/docs/latex/wx/bitmap.tex
+++ b/docs/latex/wx/bitmap.tex
@@ -10,12 +10,22 @@ either monochrome or colour.
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/bitmap.h>
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullBitmap}
+
 \wxheading{See also}
 
-\helpref{wxBitmap overview}{wxbitmapoverview}, 
-\helpref{supported bitmap file formats}{supportedbitmapformats}, 
-\helpref{wxDC::Blit}{wxdcblit}, 
-\helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}, \helpref{wxBitmap}{wxbitmap}, 
+\helpref{wxBitmap overview}{wxbitmapoverview},
+\helpref{supported bitmap file formats}{supportedbitmapformats},
+\helpref{wxDC::Blit}{wxdcblit},
+\helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}, \helpref{wxBitmap}{wxbitmap},
 \helpref{wxMemoryDC}{wxmemorydc}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -33,15 +43,21 @@ Copy constructor.
 \func{}{wxBitmap}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
 
 Creates a bitmap from the given data, which can be of arbitrary type.
+Windows only, I think.
 
 \func{}{wxBitmap}{\param{const char}{ bits[]}, \param{int}{ width}, \param{int}{ height}\\
   \param{int}{ depth = 1}}
 
 Creates a bitmap from an array of bits.
 
+Note that the bit depth is ignored on GTK+ and Motif. If you want to create a bitmap
+from something else than a 1-bit data array, use the \helpref{wxImage}{wximage} class.
+
 \func{}{wxBitmap}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
 
-Creates a new bitmap.
+Creates a new bitmap. A depth of -1 indicates the depth of the current screen or
+visual. Some platforms only support 1 for monochrome and -1 for the current colour
+setting.
 
 \func{}{wxBitmap}{\param{const char**}{ bits}}
 
@@ -124,6 +140,19 @@ Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM.
 
 \helpref{wxBitmap::LoadFile}{wxbitmaploadfile}
 
+\pythonnote{Constructors supported by wxPython are:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{\bf{wxBitmap(name, flag)}}{Loads a bitmap from a file}
+\twocolitem{\bf{wxBitmap(data, type, width, height, depth=1)}}{Creates
+a bitmap from the given data, which can be of arbitrary type.}
+\twocolitem{\bf{wxNoRefBitmap(name, flag)}}{This one won't own the
+reference, so Python won't call the destructor, this is good for toolbars
+and such where the parent will manage the bitmap.}
+\twocolitem{\bf{wxEmptyBitmap(width, height, depth = -1)}}{Creates an
+empty bitmap with the given specifications}
+\end{twocollist}}
+}
+
 \membersection{wxBitmap::\destruct{wxBitmap}}
 
 \func{}{\destruct{wxBitmap}}{\void}
@@ -539,6 +568,10 @@ application initialisation.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/bitmap.h>
+
 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}