X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/aaf7ab431b85d817af39d1a19b6d392ff5bd9379..235fb242f665ea0bf3e1bff3d5344f4d621ab75e:/docs/latex/wx/icon.tex diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex index 4a7243fa00..b1a8b244a1 100644 --- a/docs/latex/wx/icon.tex +++ b/docs/latex/wx/icon.tex @@ -51,7 +51,7 @@ For more information please see \helpref{Bitmap and icon overview}{wxbitmapoverv \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxIcon::wxIcon}\label{wxiconconstr} +\membersection{wxIcon::wxIcon}\label{wxiconctor} \func{}{wxIcon}{\void} @@ -80,7 +80,7 @@ Creates a new icon. Creates an icon from XPM data. -\func{}{wxIcon}{\param{const wxString\& }{name}, \param{long}{ type}, +\func{}{wxIcon}{\param{const wxString\& }{name}, \param{wxBitmapType}{ type}, \param{int}{ desiredWidth = -1}, \param{int}{ desiredHeight = -1}} Loads an icon from a file or resource. @@ -126,8 +126,8 @@ Its meaning is determined by the {\it flags} parameter.} %\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 ICO file, ICO resource, +The validity of these flags depends on the platform and wxWidgets configuration. +If all possible wxWidgets settings are used, the Windows platform supports ICO file, ICO resource, XPM data, and XPM file. 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.} @@ -148,7 +148,7 @@ X and Windows. The sixth form constructs a new icon. -The seventh form constructs an icon from pixmap (XPM) data, if wxWindows has been configured +The seventh form constructs an icon 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 @@ -208,21 +208,19 @@ must have mask colour set. \end{itemize} } -\membersection{wxIcon::\destruct{wxIcon}} +\membersection{wxIcon::\destruct{wxIcon}}\label{wxicondtor} \func{}{\destruct{wxIcon}}{\void} -Destroys the wxIcon object and possibly the underlying icon data. -Because reference counting is used, the icon 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 icon explicitly, the icon will be -destroyed automatically by wxWindows when the application exits. +destroyed automatically by wxWidgets when the application exits. Do not delete an icon that is selected into a memory device context. -\membersection{wxIcon::GetDepth} +\membersection{wxIcon::GetDepth}\label{wxicongetdepth} \constfunc{int}{GetDepth}{\void} @@ -247,7 +245,7 @@ Gets the width of the icon in pixels. \membersection{wxIcon::LoadFile}\label{wxiconloadfile} -\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}} +\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{wxBitmapType}{ type}} Loads an icon from a file or resource. @@ -267,7 +265,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} -The validity of these flags depends on the platform and wxWindows configuration.} +The validity of these flags depends on the platform and wxWidgets configuration.} \wxheading{Return value} @@ -275,18 +273,18 @@ true if the operation succeeded, false otherwise. \wxheading{See also} -\helpref{wxIcon::wxIcon}{wxiconconstr} +\helpref{wxIcon::wxIcon}{wxiconctor} -\membersection{wxIcon::Ok}\label{wxiconok} +\membersection{wxIcon::IsOk}\label{wxiconisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns true if icon data is present. \begin{comment} \membersection{wxIcon::SaveFile}\label{wxiconsavefile} -\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}, \param{wxPalette* }{palette = NULL}} +\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{wxBitmapType}{ type}, \param{wxPalette* }{palette = NULL}} Saves an icon in the named file. @@ -304,7 +302,7 @@ Saves an icon in the named file. \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.} \docparam{palette}{An optional palette used for saving the icon.} @@ -314,7 +312,7 @@ true if the operation succeeded, false otherwise. \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} @@ -341,17 +339,7 @@ Sets the height member (does not affect the icon data). \docparam{height}{Icon height in pixels.} -\membersection{wxIcon::SetOk} - -\func{void}{SetOk}{\param{int }{isOk}} - -Sets the validity member (does not affect the icon data). - -\wxheading{Parameters} - -\docparam{isOk}{Validity flag.} - -\membersection{wxIcon::SetWidth} +\membersection{wxIcon::SetWidth}\label{wxiconsetwidth} \func{void}{SetWidth}{\param{int }{width}} @@ -361,13 +349,11 @@ Sets the width member (does not affect the icon data). \docparam{width}{Icon width in pixels.} -\membersection{wxIcon::operator $=$} +\membersection{wxIcon::operator $=$}\label{wxiconassign} \func{wxIcon\& }{operator $=$}{\param{const wxIcon\& }{icon}} -Assignment operator. This operator does not copy any data, but instead -passes a pointer to the data in {\it icon} and increments a reference -counter. It is a fast operation. +Assignment operator, using \helpref{reference counting}{trefcount}. \wxheading{Parameters} @@ -377,34 +363,4 @@ counter. It is a fast operation. Returns 'this' object. -\membersection{wxIcon::operator $==$} - -\func{bool}{operator $==$}{\param{const wxIcon\& }{icon}} - -Equality operator. This operator tests whether the internal data pointers are -equal (a fast test). - -\wxheading{Parameters} - -\docparam{icon}{Icon to compare with 'this'} - -\wxheading{Return value} - -Returns true if the icons were effectively equal, false otherwise. - -\membersection{wxIcon::operator $!=$} - -\func{bool}{operator $!=$}{\param{const wxIcon\& }{icon}} - -Inequality operator. This operator tests whether the internal data pointers are -unequal (a fast test). - -\wxheading{Parameters} - -\docparam{icon}{Icon to compare with 'this'} - -\wxheading{Return value} - -Returns true if the icons were unequal, false otherwise. -