X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f690fb046b8a685f8ef35657c2f305ca0e1481a0..156194e1d525407e90c21552f8f7aa05756e0ddc:/docs/latex/wx/icon.tex diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex index f6e9d09dc3..4a7243fa00 100644 --- a/docs/latex/wx/icon.tex +++ b/docs/latex/wx/icon.tex @@ -85,6 +85,10 @@ Creates an icon from XPM data. Loads an icon from a file or resource. +\func{}{wxIcon}{\param{const wxIconLocation\& }{loc}} + +Loads an icon from the specified \helpref{location}{wxiconlocation}. + \wxheading{Parameters} \docparam{bits}{Specifies an array of pixel values.} @@ -107,6 +111,9 @@ screen is used.} \docparam{name}{This can refer to a resource name under MS Windows, or a filename under MS Windows and X. Its meaning is determined by the {\it flags} parameter.} +\docparam{loc}{The object describing the location of the native icon, see +\helpref{wxIconLocation}{wxiconlocation}.} + \docparam{type}{May be one of the following: \twocolwidtha{5cm} @@ -196,6 +203,8 @@ must have mask colour set. \begin{itemize} \item{Wx::Icon->new( width, height, depth = -1 )} \item{Wx::Icon->new( name, type, desiredWidth = -1, desiredHeight = -1 )} +\item{Wx::Icon->newFromBits( bits, width, height, depth = 1 )} +\item{Wx::Icon->newFromXPM( data )} \end{itemize} } @@ -262,7 +271,7 @@ The validity of these flags depends on the platform and wxWindows configuration. \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{See also} @@ -272,7 +281,7 @@ TRUE if the operation succeeded, FALSE otherwise. \constfunc{bool}{Ok}{\void} -Returns TRUE if icon data is present. +Returns true if icon data is present. \begin{comment} \membersection{wxIcon::SaveFile}\label{wxiconsavefile} @@ -301,7 +310,7 @@ The validity of these flags depends on the platform and wxWindows configuration. \wxheading{Return value} -TRUE if the operation succeeded, FALSE otherwise. +true if the operation succeeded, false otherwise. \wxheading{Remarks} @@ -381,7 +390,7 @@ equal (a fast test). \wxheading{Return value} -Returns TRUE if the icons were effectively equal, FALSE otherwise. +Returns true if the icons were effectively equal, false otherwise. \membersection{wxIcon::operator $!=$} @@ -396,6 +405,6 @@ unequal (a fast test). \wxheading{Return value} -Returns TRUE if the icons were unequal, FALSE otherwise. +Returns true if the icons were unequal, false otherwise.