use explicit virtual keyword with overridden virtual methods

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

diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex
index cb0c24cef537a7231f41f97e3028f9061bd33051..e1df5b3e7d58a0d168644299b76d3df6a066d83a 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}, 


@@ -41,7 +51,7 @@ For more information please see \helpref{Bitmap and icon overview}{wxbitmapoverv
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxIcon::wxIcon}\label{wxiconconstr}
+\membersection{wxIcon::wxIcon}\label{wxiconctor}

 
 \func{}{wxIcon}{\void}
 
 
 \func{}{wxIcon}{\void}
 


@@ -64,15 +74,21 @@ 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.
 

-\func{}{wxIcon}{\param{const wxString\& }{name}, \param{long}{ type},
+\func{}{wxIcon}{\param{const wxString\& }{name}, \param{wxBitmapType}{ type},

   \param{int}{ desiredWidth = -1}, \param{int}{ desiredHeight = -1}}
 
 Loads an icon from a file or resource.
 
   \param{int}{ desiredWidth = -1}, \param{int}{ desiredHeight = -1}}
 
 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.}
 \wxheading{Parameters}
 
 \docparam{bits}{Specifies an array of pixel values.}


@@ -95,20 +111,23 @@ 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{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}
 \begin{twocollist}
 \docparam{type}{May be one of the following:
 
 \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}
 
 \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.}
 
 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.}
 


@@ -129,7 +148,7 @@ X and Windows.
 
 The sixth form constructs a new icon.
 
 
 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
 to incorporate this feature.
 
 To use this constructor, you must first include an XPM file. For


@@ -169,9 +188,27 @@ 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}
 

-\membersection{wxIcon::\destruct{wxIcon}}
+\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}}\label{wxicondtor}

 
 \func{}{\destruct{wxIcon}}{\void}
 
 
 \func{}{\destruct{wxIcon}}{\void}
 


@@ -181,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
 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.
 
 
 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}
 
 
 \constfunc{int}{GetDepth}{\void}
 


@@ -210,7 +247,7 @@ Gets the width of the icon in pixels.
 
 \membersection{wxIcon::LoadFile}\label{wxiconloadfile}
 
 
 \membersection{wxIcon::LoadFile}\label{wxiconloadfile}
 

-\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{wxBitmapType}{ type}}

 
 Loads an icon from a file or resource.
 
 
 Loads an icon from a file or resource.
 


@@ -230,26 +267,26 @@ The meaning of {\it name} is determined by the {\it type} parameter.}
 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Load an XPM bitmap file.}
 \end{twocollist}
 
 \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}
 
 
 \wxheading{Return value}
 

-TRUE if the operation succeeded, FALSE otherwise.
+true if the operation succeeded, false otherwise.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxIcon::wxIcon}{wxiconconstr}
+\helpref{wxIcon::wxIcon}{wxiconctor}

 
 

-\membersection{wxIcon::Ok}\label{wxiconok}
+\membersection{wxIcon::IsOk}\label{wxiconisok}

 
 

-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}

 
 

-Returns TRUE if icon data is present.
+Returns true if icon data is present.

 
 \begin{comment}
 \membersection{wxIcon::SaveFile}\label{wxiconsavefile}
 
 
 \begin{comment}
 \membersection{wxIcon::SaveFile}\label{wxiconsavefile}
 

-\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}, \param{wxPalette* }{palette = NULL}}
+\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{wxBitmapType}{ type}, \param{wxPalette* }{palette = NULL}}

 
 Saves an icon in the named file.
 
 
 Saves an icon in the named file.
 


@@ -267,17 +304,17 @@ Saves an icon in the named file.
 \twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Save an XPM bitmap file.}
 \end{twocollist}
 
 \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.}
 
 \wxheading{Return value}
 
 
 \docparam{palette}{An optional palette used for saving the icon.}
 
 \wxheading{Return value}
 

-TRUE if the operation succeeded, FALSE otherwise.
+true if the operation succeeded, false otherwise.

 
 \wxheading{Remarks}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -304,17 +341,7 @@ Sets the height member (does not affect the icon data).
 
 \docparam{height}{Icon height in pixels.}
 
 
 \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}}
 
 
 \func{void}{SetWidth}{\param{int }{width}}
 


@@ -324,7 +351,7 @@ Sets the width member (does not affect the icon data).
 
 \docparam{width}{Icon width in pixels.}
 
 
 \docparam{width}{Icon width in pixels.}
 

-\membersection{wxIcon::operator $=$}
+\membersection{wxIcon::operator $=$}\label{wxiconassign}

 
 \func{wxIcon\& }{operator $=$}{\param{const wxIcon\& }{icon}}
 
 
 \func{wxIcon\& }{operator $=$}{\param{const wxIcon\& }{icon}}
 


@@ -340,7 +367,7 @@ counter. It is a fast operation.
 
 Returns 'this' object.
 
 
 Returns 'this' object.
 

-\membersection{wxIcon::operator $==$}
+\membersection{wxIcon::operator $==$}\label{wxiconequal}

 
 \func{bool}{operator $==$}{\param{const wxIcon\& }{icon}}
 
 
 \func{bool}{operator $==$}{\param{const wxIcon\& }{icon}}
 


@@ -353,9 +380,9 @@ equal (a fast test).
 
 \wxheading{Return value}
 
 
 \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 $!=$}
+\membersection{wxIcon::operator $!=$}\label{wxiconnotequal}

 
 \func{bool}{operator $!=$}{\param{const wxIcon\& }{icon}}
 
 
 \func{bool}{operator $!=$}{\param{const wxIcon\& }{icon}}
 


@@ -368,6 +395,6 @@ unequal (a fast test).
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns TRUE if the icons were unequal, FALSE otherwise.
+Returns true if the icons were unequal, false otherwise.