X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/20e85460c40ebc4dcc9577928771adb264cc998f..3e43d6143ba737da833e58b8f51eb400d374cb00:/docs/latex/wx/icon.tex diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex index b5561fc37f..7d2ca62537 100644 --- a/docs/latex/wx/icon.tex +++ b/docs/latex/wx/icon.tex @@ -74,6 +74,8 @@ Creates an icon from an array of bits. Creates a new icon. +\func{}{wxIcon}{\param{char**}{ bits}} + \func{}{wxIcon}{\param{const char**}{ bits}} Creates an icon from XPM data. @@ -109,12 +111,12 @@ Its meaning is determined by the {\it flags} parameter.} \twocolwidtha{5cm} \begin{twocollist} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_ICO}}}{Load a Windows icon file.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_ICO\_RESOURCE}}}{Load a Windows icon from the resource database.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF bitmap file.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_XBM}}}{Load an X bitmap file.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_XPM}}}{Load an XPM bitmap file.} -%\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_RESOURCE}}}{Load a Windows resource name.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_ICO\_RESOURCE}}{Load a Windows icon from the resource database.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_GIF}}{Load a GIF bitmap file.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_XBM}}{Load an X bitmap file.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_XPM}}{Load an XPM bitmap file.} +%\twocolitem{\indexit{wxBITMAP\_TYPE\_RESOURCE}}{Load a Windows resource name.} \end{twocollist} The validity of these flags depends on the platform and wxWindows configuration. @@ -179,8 +181,26 @@ Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM. \wxheading{See also} + +\membersection{wxIcon::CopyFromBitmap}\label{wxiconcopyfrombitmap} + +\func{void}{CopyFromBitmap}{\param{const wxBitmap\&}{ bmp}} + +Copies {\it bmp} bitmap to this icon. Under MS Windows the bitmap +must have mask colour set. + + \helpref{wxIcon::LoadFile}{wxiconloadfile} +\perlnote{Constructors supported by wxPerl are:\par +\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} +} + \membersection{wxIcon::\destruct{wxIcon}} \func{}{\destruct{wxIcon}}{\void} @@ -244,7 +264,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} @@ -254,7 +274,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} @@ -283,7 +303,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} @@ -363,7 +383,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 $!=$} @@ -378,6 +398,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.