X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..27bb69ac80420cf4681182ac9b75260048b77f90:/docs/latex/wx/bitmap.tex diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex index 3fde13a915..3dc40bc738 100644 --- a/docs/latex/wx/bitmap.tex +++ b/docs/latex/wx/bitmap.tex @@ -30,7 +30,7 @@ Objects: \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxBitmap::wxBitmap}\label{wxbitmapconstr} +\membersection{wxBitmap::wxBitmap}\label{wxbitmapctor} \func{}{wxBitmap}{\void} @@ -38,7 +38,15 @@ Default constructor. \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}} @@ -195,7 +203,7 @@ wxImage to a wxBitmap.} \end{itemize} } -\membersection{wxBitmap::\destruct{wxBitmap}} +\membersection{wxBitmap::\destruct{wxBitmap}}\label{wxbitmapdtor} \func{}{\destruct{wxBitmap}}{\void} @@ -222,7 +230,7 @@ of a given handler class in an application session.} \helpref{wxBitmapHandler}{wxbitmaphandler} -\membersection{wxBitmap::CleanUpHandlers} +\membersection{wxBitmap::CleanUpHandlers}\label{wxbitmapcleanuphandlers} \func{static void}{CleanUpHandlers}{\void} @@ -265,7 +273,7 @@ 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{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} @@ -279,9 +287,9 @@ type of data. \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}} @@ -309,14 +317,14 @@ A pointer to the handler if found, NULL otherwise. \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. -\membersection{wxBitmap::GetHandlers} +\membersection{wxBitmap::GetHandlers}\label{wxbitmapgethandlers} \func{static wxList\&}{GetHandlers}{\void} @@ -371,7 +379,7 @@ 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. -\membersection{wxBitmap::InitStandardHandlers} +\membersection{wxBitmap::InitStandardHandlers}\label{wxbitmapinitstandardhandlers} \func{static void}{InitStandardHandlers}{\void} @@ -384,7 +392,7 @@ This function is called by wxWidgets on startup. \helpref{wxBitmapHandler}{wxbitmaphandler} -\membersection{wxBitmap::InsertHandler} +\membersection{wxBitmap::InsertHandler}\label{wxbitmapinserthandler} \func{static void}{InsertHandler}{\param{wxBitmapHandler*}{ handler}} @@ -445,7 +453,7 @@ if one has been created by using the \helpref{GetPalette}{wxbitmapgetpalette} me Returns true if bitmap data is present. -\membersection{wxBitmap::RemoveHandler} +\membersection{wxBitmap::RemoveHandler}\label{wxbitmapremovehandler} \func{static bool}{RemoveHandler}{\param{const wxString\& }{name}} @@ -539,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 -%%\membersection{wxBitmap::SetOk} +%%\membersection{wxBitmap::SetOk}\label{wxbitmapsetok} %% %%\func{void}{SetOk}{\param{int }{isOk}} %% @@ -553,7 +561,7 @@ The bitmap object owns the mask once this has been called. \func{void}{SetPalette}{\param{const wxPalette\& }{palette}} -Sets the associated palette. +Sets the associated palette. (Not implemented under GTK+). \wxheading{Parameters} @@ -563,7 +571,7 @@ Sets the associated palette. \helpref{wxPalette}{wxpalette} -\membersection{wxBitmap::SetWidth} +\membersection{wxBitmap::SetWidth}\label{wxbitmapsetwidth} \func{void}{SetWidth}{\param{int }{width}} @@ -573,7 +581,7 @@ Sets the width member (does not affect the bitmap data). \docparam{width}{Bitmap width in pixels.} -\membersection{wxBitmap::operator $=$} +\membersection{wxBitmap::operator $=$}\label{wxbitmapassign} \func{wxBitmap\& }{operator $=$}{\param{const wxBitmap\& }{bitmap}} @@ -589,7 +597,7 @@ counter. It is a fast operation. Returns 'this' object. -\membersection{wxBitmap::operator $==$} +\membersection{wxBitmap::operator $==$}\label{wxbitmapequal} \func{bool}{operator $==$}{\param{const wxBitmap\& }{bitmap}} @@ -604,7 +612,7 @@ equal (a fast test). 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}}