X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2fd284a4a09793c29078296529d3e9db5acd0a0f..5442f43593bab13c6e56e7952ef07f64191e8500:/docs/latex/wx/icon.tex diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex index c374790965..fb8b0eb930 100644 --- a/docs/latex/wx/icon.tex +++ b/docs/latex/wx/icon.tex @@ -9,6 +9,22 @@ some platforms (X-based applications usually standardize on XPMs for small bitma and icons). However, some platforms (such as Windows) make the distinction, so a separate class is provided. +\wxheading{Derived from} + +\helpref{wxBitmap}{wxbitmap}\\ +\helpref{wxGDIObject}{wxgdiobject}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Predefined objects} + +Objects: + +{\bf wxNullIcon} + \wxheading{Remarks} It is usually desirable to associate a pertinent icon with a frame. Icons @@ -28,12 +44,6 @@ be deleted when the frame is deleted. For more information please see \helpref{Bitmap and icon overview}{wxbitmapoverview}. -\wxheading{Derived from} - -\helpref{wxBitmap}{wxbitmap}\\ -\helpref{wxGDIObject}{wxgdiobject}\\ -\helpref{wxObject}{wxobject} - \wxheading{See also} \helpref{Bitmap and icon overview}{wxbitmapoverview}, \helpref{supported bitmap file formats}{supportedbitmapformats}, @@ -64,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. @@ -169,6 +181,15 @@ 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} \membersection{wxIcon::\destruct{wxIcon}} @@ -269,8 +290,7 @@ Saves an icon in the named file. The validity of these flags depends on the platform and wxWindows configuration.} -\docparam{palette}{An optional palette used for saving the icon. TODO: this parameter should -probably be eliminated; instead the app should set the palette before saving.} +\docparam{palette}{An optional palette used for saving the icon.} \wxheading{Return value}