This form of the event cloning patch survived my

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

diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex
index fa15dd36d38410552ab9a4684ad745f24f85aeac..1e7feb5b168b4d1b34969a95a38fdab088f88c33 100644 (file)
--- a/docs/latex/wx/bitmap.tex
+++ b/docs/latex/wx/bitmap.tex
@@ -10,7 +10,7 @@ either monochrome or colour.
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 

-\wxheading{Include files}
+\wxheading{Include file}

 
 <wx/bitmap.h>
 
 
 <wx/bitmap.h>
 


@@ -55,7 +55,7 @@ portable programs: in this case the {\it bits} parameter should contain an XBM
 image.
 
 For other bit depths, the behaviour is platform dependent: under Windows, the
 image.
 
 For other bit depths, the behaviour is platform dependent: under Windows, the

-data is passed withotu any changes to the underlying {\tt CreateBitmap()} API.
+data is passed without any changes to the underlying {\tt CreateBitmap()} API.

 Under other platforms, only monochrome bitmaps may be created using this
 constructor and \helpref{wxImage}{wximage} should be used for creating colour
 bitmaps from static data.
 Under other platforms, only monochrome bitmaps may be created using this
 constructor and \helpref{wxImage}{wximage} should be used for creating colour
 bitmaps from static data.


@@ -74,6 +74,23 @@ Creates a bitmap from XPM data.
 
 Loads a bitmap from a file or resource.
 
 
 Loads a bitmap from a file or resource.
 

+\func{}{wxBitmap}{\param{const wxImage\&}{ img}, \param{int}{ depth = -1}}
+
+Creates bitmap object from the image. This has to be done
+to actually display an image as you cannot draw an image directly on a window.
+The resulting bitmap will use the provided colour depth (or that of the
+current system if depth is -1) which entails that a colour reduction has
+to take place.
+
+When in 8-bit mode (PseudoColour mode), the GTK port will use a color cube created
+on program start-up to look up colors. This ensures a very fast conversion, but
+the image quality won't be perfect (and could be better for photo images using more
+sophisticated dithering algorithms).
+
+On Windows, if there is a palette present (set with SetPalette), it will be used when
+creating the wxBitmap (most useful in 8-bit display mode). On other platforms,
+the palette is currently ignored.
+

 \wxheading{Parameters}
 
 \docparam{bits}{Specifies an array of pixel values.}
 \wxheading{Parameters}
 
 \docparam{bits}{Specifies an array of pixel values.}


@@ -92,12 +109,12 @@ Its meaning is determined by the {\it type} parameter.}
 
 \twocolwidtha{5cm}
 \begin{twocollist}
 
 \twocolwidtha{5cm}
 \begin{twocollist}

-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP}}}{Load a Windows bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP\_RESOURCE}}}{Load a Windows bitmap from the resource database.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_XBM}}}{Load an X bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_XPM}}}{Load an XPM bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_RESOURCE}}}{Load a Windows resource name.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_BMP}}{Load a Windows bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_BMP\_RESOURCE}}{Load a Windows bitmap from the resource database.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_GIF}}{Load a GIF bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_XBM}}{Load an X bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_XPM}}{Load an XPM bitmap file.}
+\twocolitem{\indexit{wxBITMAP\_TYPE\_RESOURCE}}{Load a Windows resource name.}

 \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.


@@ -105,10 +122,12 @@ If all possible wxWindows settings are used, the Windows platform supports BMP f
 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.
 
 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.
 

-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, 
+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. }
 
 and wxBITMAP\_TYPE\_PNM. Of course, you must have wxImage handlers loaded. }
 

+\docparam{img}{Platform-independent wxImage object.}
+

 \wxheading{Remarks}
 
 The first form constructs a bitmap object with no data; an assignment or another member function such as Create
 \wxheading{Remarks}
 
 The first form constructs a bitmap object with no data; an assignment or another member function such as Create


@@ -154,16 +173,26 @@ Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM.
 \pythonnote{Constructors supported by wxPython are:\par
 \indented{2cm}{\begin{twocollist}
 \twocolitem{{\bf wxBitmap(name, flag)}}{Loads a bitmap from a file}
 \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}
 \twocolitem{{\bf wxEmptyBitmap(width, height, depth = -1)}}{Creates an
 empty bitmap with the given specifications}

+\twocolitem{{\bf wxBitmapFromXPMData(listOfStrings)}}{Create a bitmap
+from a Python list of strings whose contents are XPM data.}
+\twocolitem{{\bf wxBitmapFromBits(bits, width, height,
+depth=-1)}}{Create a bitmap from an array of bits contained in a
+string.}
+\twocolitem{{\bf wxBitmapFromImage(image, depth=-1)}}{Convert a
+wxImage to a wxBitmap.}

 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

+\perlnote{Constructors supported by wxPerl are:\par
+\begin{itemize}
+\item{Wx::Bitmap->new( width, height, depth = -1 )}
+\item{Wx::Bitmap->new( name, type )}
+\item{Wx::Bitmap->new( icon )}
+\end{itemize}
+}
+

 \membersection{wxBitmap::\destruct{wxBitmap}}
 
 \func{}{\destruct{wxBitmap}}{\void}
 \membersection{wxBitmap::\destruct{wxBitmap}}
 
 \func{}{\destruct{wxBitmap}}{\void}


@@ -199,6 +228,14 @@ Deletes all bitmap handlers.
 
 This function is called by wxWindows on exit.
 
 
 This function is called by wxWindows on exit.
 

+\membersection{wxBitmap::ConvertToImage}\label{wxbitmapconverttoimage}
+
+\func{wxImage}{ConvertToImage}{\void}
+
+Creates an image from a platform-dependent bitmap. This preserves
+mask information so that bitmaps and images can be converted back
+and forth without loss in that respect.
+

 \membersection{wxBitmap::Create}\label{wxbitmapcreate}
 
 \func{virtual bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
 \membersection{wxBitmap::Create}\label{wxbitmapcreate}
 
 \func{virtual bool}{Create}{\param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}


@@ -323,7 +360,7 @@ Gets the width of the bitmap in pixels.
 
 \constfunc{wxBitmap}{GetSubBitmap}{\param{const wxRect\&}{rect}}
 
 
 \constfunc{wxBitmap}{GetSubBitmap}{\param{const wxRect\&}{rect}}
 

-Returns a sub bitmap of the current one as long as the rect belongs entirely to 
+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}
 the bitmap. This function preserves bit depth and mask information.
 
 \membersection{wxBitmap::InitStandardHandlers}


@@ -376,7 +413,7 @@ The meaning of {\it name} is determined by the {\it type} parameter.}
 
 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 
+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.) }
 
 (wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_PNG, wxBITMAP\_TYPE\_GIF, wxBITMAP\_TYPE\_PCX, wxBITMAP\_TYPE\_PNM).
 (Of course you must have wxImage handlers loaded.) }
 


@@ -439,7 +476,7 @@ 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.
 

-In addition, wxBitmap can save all formats that \helpref{wxImage}{wximage} can 
+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.) }
 
 (wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_PNG).
 (Of course you must have wxImage handlers loaded.) }
 


@@ -493,32 +530,27 @@ The bitmap object owns the mask once this has been called.
 
 \helpref{wxBitmap::GetMask}{wxbitmapgetmask}, \helpref{wxMask}{wxmask}
 
 
 \helpref{wxBitmap::GetMask}{wxbitmapgetmask}, \helpref{wxMask}{wxmask}
 

-\membersection{wxBitmap::SetOk}
-
-\func{void}{SetOk}{\param{int }{isOk}}
-
-Sets the validity member (does not affect the bitmap data).
-
-\wxheading{Parameters}
-
-\docparam{isOk}{Validity flag.}
+%% VZ: this function is an implementation detail and shouldn't be documented
+%%\membersection{wxBitmap::SetOk}
+%%
+%%\func{void}{SetOk}{\param{int }{isOk}}
+%%
+%%Sets the validity member (does not affect the bitmap data).
+%%
+%%\wxheading{Parameters}
+%%
+%%\docparam{isOk}{Validity flag.}

 
 \membersection{wxBitmap::SetPalette}\label{wxbitmapsetpalette}
 
 
 \membersection{wxBitmap::SetPalette}\label{wxbitmapsetpalette}
 

-\func{void}{SetPalette}{\param{wxPalette* }{palette}}
+\func{void}{SetPalette}{\param{const wxPalette\& }{palette}}

 
 

-Sets the associated palette: it will be deleted in the wxBitmap
-destructor, so if you do not wish it to be deleted automatically,
-reset the palette to NULL before the bitmap is deleted.
+Sets the associated palette.

 
 \wxheading{Parameters}
 
 \docparam{palette}{The palette to set.}
 
 
 \wxheading{Parameters}
 
 \docparam{palette}{The palette to set.}
 

-\wxheading{Remarks}
-
-The bitmap object owns the palette once this has been called.
-

 \wxheading{See also}
 
 \helpref{wxPalette}{wxpalette}
 \wxheading{See also}
 
 \helpref{wxPalette}{wxpalette}