X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5b6aa0ff15be125c6f5f641e586002ec0c0330a2..5801c56fa90c4a71b6e64709b6ecab854f010015:/docs/latex/wx/bitmap.tex?ds=sidebyside

diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex
index 0deb875036..334731ab8a 100644
--- 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}}
 
@@ -80,7 +96,11 @@ Its meaning is determined by the {\it type} parameter.}
 The validity of these flags depends on the platform and wxWindows configuration.
 If all possible wxWindows settings are used, the Windows platform supports BMP file, BMP resource,
 XPM data, and XPM. Under wxGTK, the available formats are BMP file, XPM data, XPM file, and PNG file.
-Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM file.}
+Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM file.
+
+In addition, wxBitmap can read all formats that \helpref{wxImage}{wximage} can, which currently include 
+wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_TIF, wxBITMAP\_TYPE\_PNG, wxBITMAP\_TYPE\_GIF, wxBITMAP\_TYPE\_PCX, 
+and wxBITMAP\_TYPE\_PNM. Of course, you must have wxImage handlers loaded. }
 
 \wxheading{Remarks}
 
@@ -124,6 +144,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 wxBitmapFromData(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}
@@ -279,6 +312,13 @@ Gets the width of the bitmap in pixels.
 
 \helpref{wxBitmap::GetHeight}{wxbitmapgetheight}
 
+\membersection{wxBitmap::GetSubBitmap}\label{wxbitmapgetsubbitmap}
+
+\constfunc{wxBitmap}{GetSubBitmap}{\param{const wxRect&}{rect}}
+
+Returns a sub bitmap of the current one as long as the rect belongs entirely to 
+the bitmap. This function preserves bit depth and mask information.
+
 \membersection{wxBitmap::InitStandardHandlers}
 
 \func{static void}{InitStandardHandlers}{\void}
@@ -327,7 +367,11 @@ The meaning of {\it name} is determined by the {\it type} parameter.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Load an XPM bitmap file.}
 \end{twocollist}
 
-The validity of these flags depends on the platform and wxWindows configuration.}
+The validity of these flags depends on the platform and wxWindows configuration.
+
+In addition, wxBitmap can read all formats that \helpref{wxImage}{wximage} can 
+(wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_PNG, wxBITMAP\_TYPE\_GIF, wxBITMAP\_TYPE\_PCX, wxBITMAP\_TYPE\_PNM).
+(Of course you must have wxImage handlers loaded.) }
 
 \wxheading{Return value}
 
@@ -386,7 +430,11 @@ Saves a bitmap in the named file.
 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Save an XPM bitmap file.}
 \end{twocollist}
 
-The validity of these flags depends on the platform and wxWindows configuration.}
+The validity of these flags depends on the platform and wxWindows configuration.
+
+In addition, wxBitmap can save all formats that \helpref{wxImage}{wximage} can 
+(wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_PNG).
+(Of course you must have wxImage handlers loaded.) }
 
 \docparam{palette}{An optional palette used for saving the bitmap.}
 % TODO: this parameter should
@@ -539,6 +587,10 @@ application initialisation.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/bitmap.h>
+
 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}
