added wxLongLong::ToString()

[wxWidgets.git] / docs / latex / wx / icon.tex

diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex
index c3747909654d421f05f800dffbe493608a63fe88..f6e9d09dc32e9c0c51e85d222482f5fd538a313a 100644 (file)
--- 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.
 
 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}
+
+<wx/icon.h>
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullIcon}
+

 \wxheading{Remarks}
 
 It is usually desirable to associate a pertinent icon with a frame. Icons
 \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}.
 
 
 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}, 
 \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.
 
 
 Creates a new icon.
 

+\func{}{wxIcon}{\param{char**}{ bits}}
+

 \func{}{wxIcon}{\param{const char**}{ bits}}
 
 Creates an icon from XPM data.
 \func{}{wxIcon}{\param{const char**}{ bits}}
 
 Creates an icon from XPM data.


@@ -99,12 +111,12 @@ Its meaning is determined by the {\it flags} parameter.}
 
 \twocolwidtha{5cm}
 \begin{twocollist}
 
 \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.
 \end{twocollist}
 
 The validity of these flags depends on the platform and wxWindows configuration.


@@ -169,8 +181,24 @@ Under X, {\it type} defaults to wxBITMAP\_TYPE\_XPM.
 
 \wxheading{See also}
 
 
 \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}
 
 \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 )}
+\end{itemize}
+}
+

 \membersection{wxIcon::\destruct{wxIcon}}
 
 \func{}{\destruct{wxIcon}}{\void}
 \membersection{wxIcon::\destruct{wxIcon}}
 
 \func{}{\destruct{wxIcon}}{\void}


@@ -269,8 +297,7 @@ Saves an icon in the named file.
 
 The validity of these flags depends on the platform and wxWindows configuration.}
 
 
 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}
 
 
 \wxheading{Return value}