1. wxHtmlHelpController and related classes

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

diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex
index 30a202a37ed7f9ea9bc28f2f90bdb50ccb971de9..efe5732d7bd59a50a0cd4e9f975210fc7951512e 100644 (file)
--- a/docs/latex/wx/bitmap.tex
+++ b/docs/latex/wx/bitmap.tex
@@ -10,9 +10,23 @@ either monochrome or colour.
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/bitmap.h>
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullBitmap}
+

 \wxheading{See also}
 
 \wxheading{See also}
 

-\helpref{wxBitmap overview}{wxbitmapoverview}, \helpref{wxDC::Blit}{wxdcblit}, \helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}, \helpref{wxMemoryDC}{wxmemorydc}
+\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}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -24,28 +38,32 @@ Default constructor.
 
 \func{}{wxBitmap}{\param{const wxBitmap\& }{bitmap}}
 
 
 \func{}{wxBitmap}{\param{const wxBitmap\& }{bitmap}}
 

-\func{}{wxBitmap}{\param{const wxBitmap* }{bitmap}}
+Copy constructor.

 
 

-Copy constructors.
-
-\func{}{wxBitmap}{\param{void*}{ data}, \param{const int}{ type}, \param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}}
+\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.
 
 Creates a bitmap from the given data, which can be of arbitrary type.

+Windows only, I think.

 
 

-\func{}{wxBitmap}{\param{const char}{ bits[]}, \param{const int}{ width}, \param{const int}{ height}\\
-  \param{const int}{ depth = 1}}
+\func{}{wxBitmap}{\param{const char}{ bits[]}, \param{int}{ width}, \param{int}{ height}\\
+  \param{int}{ depth = 1}}

 
 Creates a bitmap from an array of bits.
 
 
 Creates a bitmap from an array of bits.
 

-\func{}{wxBitmap}{\param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}}
+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}}
 
 Creates a bitmap from XPM data.
 
 
 \func{}{wxBitmap}{\param{const char**}{ bits}}
 
 Creates a bitmap from XPM data.
 

-\func{}{wxBitmap}{\param{const wxString\& }{name}, \param{const long}{ type}}
+\func{}{wxBitmap}{\param{const wxString\& }{name}, \param{long}{ type}}

 
 Loads a bitmap from a file or resource.
 
 
 Loads a bitmap from a file or resource.
 


@@ -61,7 +79,7 @@ Loads a bitmap from a file or resource.
 screen is used.}
 
 \docparam{name}{This can refer to a resource name under MS Windows, or a filename under MS Windows and X.
 screen is used.}
 
 \docparam{name}{This can refer to a resource name under MS Windows, or a filename under MS Windows and X.

-Its meaning is determined by the {\it flags} parameter.}
+Its meaning is determined by the {\it type} parameter.}

 
 \docparam{type}{May be one of the following:
 
 
 \docparam{type}{May be one of the following:
 


@@ -76,8 +94,9 @@ Its meaning is determined by the {\it flags} parameter.}
 \end{twocollist}
 
 The validity of these flags depends on the platform and wxWindows configuration.
 \end{twocollist}
 
 The validity of these flags depends on the platform and wxWindows configuration.

-If all possible wxWindows settings are used, the Windows platform supports BMP, BMP\_RESOURCE,
-XPM\_DATA, and XPM. Under X, the available formats are BMP, GIF, XBM, and XPM.}
+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.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -115,12 +134,25 @@ The eighth form constructs a bitmap from a file or resource. {\it name} can refe
 to a resource name under MS Windows, or a filename under MS Windows and X.
 
 Under Windows, {\it type} defaults to wxBITMAP\_TYPE\_BMP\_RESOURCE.
 to a resource name under MS Windows, or a filename under MS Windows and X.
 
 Under Windows, {\it type} defaults to wxBITMAP\_TYPE\_BMP\_RESOURCE.

-Under X, {\it type} defaults to wxBITMAP\_TYPE\_XBM.
+Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM.

 
 \wxheading{See also}
 
 \helpref{wxBitmap::LoadFile}{wxbitmaploadfile}
 
 
 \wxheading{See also}
 
 \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}
 \membersection{wxBitmap::\destruct{wxBitmap}}
 
 \func{}{\destruct{wxBitmap}}{\void}


@@ -158,12 +190,12 @@ This function is called by wxWindows on exit.
 
 \membersection{wxBitmap::Create}
 
 
 \membersection{wxBitmap::Create}
 

-\func{virtual bool}{Create}{\param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}}
+\func{virtual bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}

 
 Creates a fresh bitmap. If the final argument is omitted, the display depth of
 the screen is used.
 
 
 Creates a fresh bitmap. If the final argument is omitted, the display depth of
 the screen is used.
 

-\func{virtual bool}{Create}{\param{void*}{ data}, \param{const int}{ type}, \param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}}
+\func{virtual bool}{Create}{\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.
 
 
 Creates a bitmap from the given data, which can be of arbitrary type.
 


@@ -259,7 +291,7 @@ or set for the bitmap.
 
 \constfunc{wxMask*}{GetMask}{\void}
 
 
 \constfunc{wxMask*}{GetMask}{\void}
 

-Gets the associated mask if any) which may have been loaded from a file
+Gets the associated mask (if any) which may have been loaded from a file

 or set for the bitmap.
 
 \wxheading{See also}
 or set for the bitmap.
 
 \wxheading{See also}


@@ -304,7 +336,7 @@ of a given handler class in an application session.}
 
 \membersection{wxBitmap::LoadFile}\label{wxbitmaploadfile}
 
 
 \membersection{wxBitmap::LoadFile}\label{wxbitmaploadfile}
 

-\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const long}{ type}}
+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}

 
 Loads a bitmap from a file or resource.
 
 
 Loads a bitmap from a file or resource.
 


@@ -385,8 +417,9 @@ Saves a bitmap in the named file.
 
 The validity of these flags depends on the platform and wxWindows configuration.}
 
 
 The validity of these flags depends on the platform and wxWindows configuration.}
 

-\docparam{palette}{An optional palette used for saving the bitmap. TODO: this parameter should
-probably be eliminated; instead the app should set the palette before saving.}
+\docparam{palette}{An optional palette used for saving the bitmap.}
+% TODO: this parameter should
+%probably be eliminated; instead the app should set the palette before saving.

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 


@@ -535,6 +568,10 @@ application initialisation.
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/bitmap.h>
+

 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}
 \wxheading{See also}
 
 \helpref{wxBitmap}{wxbitmap}, \helpref{wxIcon}{wxicon}, \helpref{wxCursor}{wxcursor}


@@ -556,7 +593,7 @@ Destroys the wxBitmapHandler object.
 
 \membersection{wxBitmapHandler::Create}
 
 
 \membersection{wxBitmapHandler::Create}
 

-\func{virtual bool}{Create}{\param{wxBitmap* }{bitmap}, \param{void*}{ data}, \param{const int}{ type}, \param{const int}{ width}, \param{const int}{ height}, \param{const int}{ depth = -1}}
+\func{virtual bool}{Create}{\param{wxBitmap* }{bitmap}, \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. The wxBitmap object {\it bitmap} is
 manipulated by this function.
 
 Creates a bitmap from the given data, which can be of arbitrary type. The wxBitmap object {\it bitmap} is
 manipulated by this function.


@@ -600,7 +637,7 @@ Gets the bitmap type associated with this handler.
 
 \membersection{wxBitmapHandler::LoadFile}\label{wxbitmaphandlerloadfile}
 
 
 \membersection{wxBitmapHandler::LoadFile}\label{wxbitmaphandlerloadfile}
 

-\func{bool}{LoadFile}{\param{wxBitmap* }{bitmap}, \param{const wxString\&}{ name}, \param{const long}{ type}}
+\func{bool}{LoadFile}{\param{wxBitmap* }{bitmap}, \param{const wxString\&}{ name}, \param{long}{ type}}

 
 Loads a bitmap from a file or resource, putting the resulting data into {\it bitmap}.
 
 
 Loads a bitmap from a file or resource, putting the resulting data into {\it bitmap}.
 


@@ -637,8 +674,7 @@ Saves a bitmap in the named file.
 
 \docparam{type}{See \helpref{wxBitmap::wxBitmap}{wxbitmapconstr} for values this can take.}
 
 
 \docparam{type}{See \helpref{wxBitmap::wxBitmap}{wxbitmapconstr} for values this can take.}
 

-\docparam{palette}{An optional palette used for saving the bitmap. TODO: this parameter should
-probably be eliminated; instead the app should set the palette before saving.}
+\docparam{palette}{An optional palette used for saving the bitmap.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}