X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2a138829cb011bc427b61d30eb85a6c3ff658455..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/bitmap.tex diff --git a/docs/latex/wx/bitmap.tex b/docs/latex/wx/bitmap.tex index 4e08167b27..db2d9f7ac3 100644 --- a/docs/latex/wx/bitmap.tex +++ b/docs/latex/wx/bitmap.tex @@ -10,7 +10,7 @@ either monochrome or colour or colour with alpha channel support. \helpref{wxGDIObject}{wxgdiobject}\\ \helpref{wxObject}{wxobject} -\wxheading{Include file} +\wxheading{Include files} @@ -38,17 +38,15 @@ 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( 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{const void*}{ data}, \param{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} Creates a bitmap from the given data which is interpreted in platform-dependent manner. @@ -75,7 +73,7 @@ or visual. Some platforms only support 1 for monochrome and -1 for the current colour setting. Beginning with version 2.5.4 of wxWidgets a depth of 32 including an alpha channel is supported under MSW, Mac and GTK+. -\func{}{wxBitmap}{\param{const char**}{ bits}} +\func{}{wxBitmap}{\param{const char* const*}{ bits}} Creates a bitmap from XPM data. @@ -208,10 +206,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. @@ -260,7 +256,7 @@ Creates the bitmap from an icon. 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{int}{ type}, \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}} +\func{virtual bool}{Create}{\param{const 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. @@ -449,9 +445,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 +583,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 +593,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.