X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/aaf7ab431b85d817af39d1a19b6d392ff5bd9379..27bb69ac80420cf4681182ac9b75260048b77f90:/docs/latex/wx/icon.tex?ds=sidebyside diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex index 4a7243fa00..519f3df88d 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} @@ -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,7 +208,7 @@ must have mask colour set. \end{itemize} } -\membersection{wxIcon::\destruct{wxIcon}} +\membersection{wxIcon::\destruct{wxIcon}}\label{wxicondtor} \func{}{\destruct{wxIcon}}{\void} @@ -218,11 +218,11 @@ destroyed at this point - only when the reference count is zero will the data be deleted. 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} @@ -267,7 +267,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,7 +275,7 @@ true if the operation succeeded, false otherwise. \wxheading{See also} -\helpref{wxIcon::wxIcon}{wxiconconstr} +\helpref{wxIcon::wxIcon}{wxiconctor} \membersection{wxIcon::Ok}\label{wxiconok} @@ -304,7 +304,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 +314,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 +341,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,7 +351,7 @@ 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}} @@ -377,7 +367,7 @@ counter. It is a fast operation. Returns 'this' object. -\membersection{wxIcon::operator $==$} +\membersection{wxIcon::operator $==$}\label{wxiconequal} \func{bool}{operator $==$}{\param{const wxIcon\& }{icon}} @@ -392,7 +382,7 @@ equal (a fast test). Returns true if the icons were effectively equal, false otherwise. -\membersection{wxIcon::operator $!=$} +\membersection{wxIcon::operator $!=$}\label{wxiconnotequal} \func{bool}{operator $!=$}{\param{const wxIcon\& }{icon}}