X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/452418c4b0763eb611432e84f077c9766e282057..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/bitmap.tex?ds=sidebyside diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex index f75303f6f2..479ca1ca56 100644 --- a/docs/latex/wx/bitmap.tex +++ b/docs/latex/wx/bitmap.tex @@ -14,6 +14,10 @@ either monochrome or colour or colour with alpha channel support. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Predefined objects} Objects: @@ -38,10 +42,8 @@ Default constructor. \func{}{wxBitmap}{\param{const wxBitmap\& }{bitmap}} -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: +Copy constructor, uses \helpref{reference counting}{trefcount}. +To make a real copy, you can use: \begin{verbatim} wxBitmap newBitmap = oldBitmap.GetSubBitmap( @@ -208,10 +210,8 @@ wxImage to a wxBitmap.} \func{}{\destruct{wxBitmap}}{\void} -Destroys the wxBitmap object and possibly the underlying bitmap data. -Because reference counting is used, the bitmap may not actually be -destroyed at this point - only when the reference count is zero will the -data be deleted. +Destructor. +See \helpref{reference-counted object destruction}{refcountdestruct} for more info. If the application omits to delete the bitmap explicitly, the bitmap will be destroyed automatically by wxWidgets when the application exits. @@ -449,9 +449,9 @@ if one has been created by using the \helpref{GetPalette}{wxbitmapgetpalette} me \helpref{wxBitmap::SaveFile}{wxbitmapsavefile} -\membersection{wxBitmap::Ok}\label{wxbitmapok} +\membersection{wxBitmap::IsOk}\label{wxbitmapisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns true if bitmap data is present. @@ -587,9 +587,7 @@ Sets the width member (does not affect the bitmap data). \func{wxBitmap\& }{operator $=$}{\param{const wxBitmap\& }{bitmap}} -Assignment operator. This operator does not copy any data, but instead -passes a pointer to the data in {\it bitmap} and increments a reference -counter. It is a fast operation. +Assignment operator, using \helpref{reference counting}{trefcount}. \wxheading{Parameters} @@ -599,33 +597,4 @@ counter. It is a fast operation. Returns 'this' object. -\membersection{wxBitmap::operator $==$}\label{wxbitmapequal} - -\func{bool}{operator $==$}{\param{const wxBitmap\& }{bitmap}} - -Equality operator. This operator tests whether the internal data pointers are -equal (a fast test). - -\wxheading{Parameters} - -\docparam{bitmap}{Bitmap to compare with 'this'} - -\wxheading{Return value} - -Returns true if the bitmaps were effectively equal, false otherwise. - -\membersection{wxBitmap::operator $!=$}\label{wxbitmapnotequal} - -\func{bool}{operator $!=$}{\param{const wxBitmap\& }{bitmap}} - -Inequality operator. This operator tests whether the internal data pointers are -unequal (a fast test). - -\wxheading{Parameters} - -\docparam{bitmap}{Bitmap to compare with 'this'} - -\wxheading{Return value} - -Returns true if the bitmaps were unequal, false otherwise.