Missing wxWindow member, manual decorations to pure text list of changes.

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

diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex
index 74e19618575d6c74b15c2a5ff8f25a85f61ed04e..385a64fde1ca78532c2f2f6337e8f1d9d1e7e625 100644 (file)
--- a/docs/latex/wx/bitmap.tex
+++ b/docs/latex/wx/bitmap.tex
@@ -30,7 +30,7 @@ Objects:
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxBitmap::wxBitmap}\label{wxbitmapconstr}
+\membersection{wxBitmap::wxBitmap}\label{wxbitmapctor}

 
 \func{}{wxBitmap}{\void}
 
 
 \func{}{wxBitmap}{\void}
 


@@ -38,7 +38,15 @@ Default constructor.
 
 \func{}{wxBitmap}{\param{const wxBitmap\& }{bitmap}}
 
 
 \func{}{wxBitmap}{\param{const wxBitmap\& }{bitmap}}
 

-Copy constructor.
+Copy constructor. Note that this does not take a fresh copy of the data,
+but instead makes the internal data point to {\it bitmap}'s data. So
+changing one bitmap will change the other. To make a real copy, you can
+use:
+
+\begin{verbatim}
+    wxBitmap newBitmap = oldBitmap.GetSubBitmap(
+                             wxRect(0, 0, oldBitmap.GetWidth(), oldBitmap.GetHeight()));
+\end{verbatim}

 
 \func{}{wxBitmap}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
 
 
 \func{}{wxBitmap}{\param{void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
 


@@ -117,8 +125,8 @@ Its meaning is determined by the {\it type} parameter.}
 \twocolitem{\indexit{wxBITMAP\_TYPE\_RESOURCE}}{Load a Windows resource name.}
 \end{twocollist}
 
 \twocolitem{\indexit{wxBITMAP\_TYPE\_RESOURCE}}{Load a Windows resource name.}
 \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 file, BMP resource,
+The validity of these flags depends on the platform and wxWidgets configuration.
+If all possible wxWidgets 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.
 
 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.
 


@@ -145,7 +153,7 @@ X and Windows.
 
 The sixth form constructs a new bitmap.
 
 
 The sixth form constructs a new bitmap.
 

-The seventh form constructs a bitmap from pixmap (XPM) data, if wxWindows has been configured
+The seventh form constructs a bitmap from pixmap (XPM) data, if wxWidgets has been configured

 to incorporate this feature.
 
 To use this constructor, you must first include an XPM file. For
 to incorporate this feature.
 
 To use this constructor, you must first include an XPM file. For


@@ -190,10 +198,12 @@ wxImage to a wxBitmap.}
 \item{Wx::Bitmap->new( width, height, depth = -1 )}
 \item{Wx::Bitmap->new( name, type )}
 \item{Wx::Bitmap->new( icon )}
 \item{Wx::Bitmap->new( width, height, depth = -1 )}
 \item{Wx::Bitmap->new( name, type )}
 \item{Wx::Bitmap->new( icon )}

+\item{Wx::Bitmap->newFromBits( bits, width, height, depth = 1 )}
+\item{Wx::Bitmap->newFromXPM( data )}

 \end{itemize}
 }
 
 \end{itemize}
 }
 

-\membersection{wxBitmap::\destruct{wxBitmap}}
+\membersection{wxBitmap::\destruct{wxBitmap}}\label{wxbitmapdtor}

 
 \func{}{\destruct{wxBitmap}}{\void}
 
 
 \func{}{\destruct{wxBitmap}}{\void}
 


@@ -203,7 +213,7 @@ destroyed at this point - only when the reference count is zero will the
 data be deleted.
 
 If the application omits to delete the bitmap explicitly, the bitmap will be
 data be deleted.
 
 If the application omits to delete the bitmap explicitly, the bitmap will be

-destroyed automatically by wxWindows when the application exits.
+destroyed automatically by wxWidgets when the application exits.

 
 Do not delete a bitmap that is selected into a memory device context.
 
 
 Do not delete a bitmap that is selected into a memory device context.
 


@@ -220,13 +230,13 @@ of a given handler class in an application session.}
 
 \helpref{wxBitmapHandler}{wxbitmaphandler}
 
 
 \helpref{wxBitmapHandler}{wxbitmaphandler}
 

-\membersection{wxBitmap::CleanUpHandlers}
+\membersection{wxBitmap::CleanUpHandlers}\label{wxbitmapcleanuphandlers}

 
 \func{static void}{CleanUpHandlers}{\void}
 
 Deletes all bitmap handlers.
 
 
 \func{static void}{CleanUpHandlers}{\void}
 
 Deletes all bitmap handlers.
 

-This function is called by wxWindows on exit.
+This function is called by wxWidgets on exit.

 
 \membersection{wxBitmap::ConvertToImage}\label{wxbitmapconverttoimage}
 
 
 \membersection{wxBitmap::ConvertToImage}\label{wxbitmapconverttoimage}
 


@@ -236,6 +246,12 @@ 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.
 
 mask information so that bitmaps and images can be converted back
 and forth without loss in that respect.
 

+\membersection{wxBitmap::CopyFromIcon}\label{wxbitmapcopyfromicon}
+
+\func{bool}{CopyFromIcon}{\param{const wxIcon\&}{ icon}}
+
+Creates the bitmap from an icon.
+

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


@@ -257,12 +273,12 @@ Creates a bitmap from the given data, which can be of arbitrary type.
 
 \docparam{data}{Data whose type depends on the value of {\it type}.}
 
 
 \docparam{data}{Data whose type depends on the value of {\it type}.}
 

-\docparam{type}{A bitmap type identifier - see \helpref{wxBitmap::wxBitmap}{wxbitmapconstr} for a list
+\docparam{type}{A bitmap type identifier - see \helpref{wxBitmap::wxBitmap}{wxbitmapctor} for a list

 of possible values.}
 
 \wxheading{Return value}
 
 of possible values.}
 
 \wxheading{Return value}
 

-TRUE if the call succeeded, FALSE otherwise.
+true if the call succeeded, false otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -271,9 +287,9 @@ type of data.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxBitmap::wxBitmap}{wxbitmapconstr}
+\helpref{wxBitmap::wxBitmap}{wxbitmapctor}

 
 

-\membersection{wxBitmap::FindHandler}
+\membersection{wxBitmap::FindHandler}\label{wxbitmapfindhandler}

 
 \func{static wxBitmapHandler*}{FindHandler}{\param{const wxString\& }{name}}
 
 
 \func{static wxBitmapHandler*}{FindHandler}{\param{const wxString\& }{name}}
 


@@ -301,14 +317,14 @@ A pointer to the handler if found, NULL otherwise.
 
 \helpref{wxBitmapHandler}{wxbitmaphandler}
 
 
 \helpref{wxBitmapHandler}{wxbitmaphandler}
 

-\membersection{wxBitmap::GetDepth}
+\membersection{wxBitmap::GetDepth}\label{wxbitmapgetdepth}

 
 \constfunc{int}{GetDepth}{\void}
 
 Gets the colour depth of the bitmap. A value of 1 indicates a
 monochrome bitmap.
 
 
 \constfunc{int}{GetDepth}{\void}
 
 Gets the colour depth of the bitmap. A value of 1 indicates a
 monochrome bitmap.
 

-\membersection{wxBitmap::GetHandlers}
+\membersection{wxBitmap::GetHandlers}\label{wxbitmapgethandlers}

 
 \func{static wxList\&}{GetHandlers}{\void}
 
 
 \func{static wxList\&}{GetHandlers}{\void}
 


@@ -363,20 +379,20 @@ Gets the width of the bitmap in pixels.
 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.
 
 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}
+\membersection{wxBitmap::InitStandardHandlers}\label{wxbitmapinitstandardhandlers}

 
 \func{static void}{InitStandardHandlers}{\void}
 
 
 \func{static void}{InitStandardHandlers}{\void}
 

-Adds the standard bitmap format handlers, which, depending on wxWindows
+Adds the standard bitmap format handlers, which, depending on wxWidgets

 configuration, can be handlers for Windows bitmap, Windows bitmap resource, and XPM.
 
 configuration, can be handlers for Windows bitmap, Windows bitmap resource, and XPM.
 

-This function is called by wxWindows on startup.
+This function is called by wxWidgets on startup.

 
 \wxheading{See also}
 
 \helpref{wxBitmapHandler}{wxbitmaphandler}
 
 
 \wxheading{See also}
 
 \helpref{wxBitmapHandler}{wxbitmaphandler}
 

-\membersection{wxBitmap::InsertHandler}
+\membersection{wxBitmap::InsertHandler}\label{wxbitmapinserthandler}

 
 \func{static void}{InsertHandler}{\param{wxBitmapHandler*}{ handler}}
 
 
 \func{static void}{InsertHandler}{\param{wxBitmapHandler*}{ handler}}
 


@@ -411,7 +427,7 @@ The meaning of {\it name} is determined by the {\it type} parameter.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Load an XPM bitmap file.}
 \end{twocollist}
 
 \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 wxWidgets 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).
 
 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).


@@ -419,7 +435,7 @@ In addition, wxBitmap can read all formats that \helpref{wxImage}{wximage} can
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the operation succeeded, FALSE otherwise.
+true if the operation succeeded, false otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -435,9 +451,9 @@ if one has been created by using the \helpref{GetPalette}{wxbitmapgetpalette} me
 
 \constfunc{bool}{Ok}{\void}
 
 
 \constfunc{bool}{Ok}{\void}
 

-Returns TRUE if bitmap data is present.
+Returns true if bitmap data is present.

 
 

-\membersection{wxBitmap::RemoveHandler}
+\membersection{wxBitmap::RemoveHandler}\label{wxbitmapremovehandler}

 
 \func{static bool}{RemoveHandler}{\param{const wxString\& }{name}}
 
 
 \func{static bool}{RemoveHandler}{\param{const wxString\& }{name}}
 


@@ -448,7 +464,7 @@ is not deleted.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the handler was found and removed, FALSE otherwise.
+true if the handler was found and removed, false otherwise.

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


@@ -474,7 +490,7 @@ Saves a bitmap in the named file.
 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Save an XPM bitmap file.}
 \end{twocollist}
 
 \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 wxWidgets configuration.

 
 In addition, wxBitmap can save all formats that \helpref{wxImage}{wximage} can
 (wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_PNG).
 
 In addition, wxBitmap can save all formats that \helpref{wxImage}{wximage} can
 (wxBITMAP\_TYPE\_JPEG, wxBITMAP\_TYPE\_PNG).


@@ -486,11 +502,11 @@ In addition, wxBitmap can save all formats that \helpref{wxImage}{wximage} can
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the operation succeeded, FALSE otherwise.
+true if the operation succeeded, false otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Depending on how wxWindows has been configured, not all formats may be available.
+Depending on how wxWidgets has been configured, not all formats may be available.

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


@@ -531,7 +547,7 @@ The bitmap object owns the mask once this has been called.
 \helpref{wxBitmap::GetMask}{wxbitmapgetmask}, \helpref{wxMask}{wxmask}
 
 %% VZ: this function is an implementation detail and shouldn't be documented
 \helpref{wxBitmap::GetMask}{wxbitmapgetmask}, \helpref{wxMask}{wxmask}
 
 %% VZ: this function is an implementation detail and shouldn't be documented

-%%\membersection{wxBitmap::SetOk}
+%%\membersection{wxBitmap::SetOk}\label{wxbitmapsetok}

 %%
 %%\func{void}{SetOk}{\param{int }{isOk}}
 %%
 %%
 %%\func{void}{SetOk}{\param{int }{isOk}}
 %%


@@ -555,7 +571,7 @@ Sets the associated palette.
 
 \helpref{wxPalette}{wxpalette}
 
 
 \helpref{wxPalette}{wxpalette}
 

-\membersection{wxBitmap::SetWidth}
+\membersection{wxBitmap::SetWidth}\label{wxbitmapsetwidth}

 
 \func{void}{SetWidth}{\param{int }{width}}
 
 
 \func{void}{SetWidth}{\param{int }{width}}
 


@@ -565,7 +581,7 @@ Sets the width member (does not affect the bitmap data).
 
 \docparam{width}{Bitmap width in pixels.}
 
 
 \docparam{width}{Bitmap width in pixels.}
 

-\membersection{wxBitmap::operator $=$}
+\membersection{wxBitmap::operator $=$}\label{wxbitmapassign}

 
 \func{wxBitmap\& }{operator $=$}{\param{const wxBitmap\& }{bitmap}}
 
 
 \func{wxBitmap\& }{operator $=$}{\param{const wxBitmap\& }{bitmap}}
 


@@ -581,7 +597,7 @@ counter. It is a fast operation.
 
 Returns 'this' object.
 
 
 Returns 'this' object.
 

-\membersection{wxBitmap::operator $==$}
+\membersection{wxBitmap::operator $==$}\label{wxbitmapequal}

 
 \func{bool}{operator $==$}{\param{const wxBitmap\& }{bitmap}}
 
 
 \func{bool}{operator $==$}{\param{const wxBitmap\& }{bitmap}}
 


@@ -594,9 +610,9 @@ equal (a fast test).
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns TRUE if the bitmaps were effectively equal, FALSE otherwise.
+Returns true if the bitmaps were effectively equal, false otherwise.

 
 

-\membersection{wxBitmap::operator $!=$}
+\membersection{wxBitmap::operator $!=$}\label{wxbitmapnotequal}

 
 \func{bool}{operator $!=$}{\param{const wxBitmap\& }{bitmap}}
 
 
 \func{bool}{operator $!=$}{\param{const wxBitmap\& }{bitmap}}
 


@@ -609,5 +625,5 @@ unequal (a fast test).
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns TRUE if the bitmaps were unequal, FALSE otherwise.
+Returns true if the bitmaps were unequal, false otherwise.