First step in background erase optimization

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

diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex
index 29cfd76ac8b4d384918525722eb3959dd6eeca76..28999bc3dfc55d6a8fa3f50cfd9c139722f6a51b 100644 (file)
--- 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.
 
 
 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.}


@@ -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{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}
 \docparam{type}{May be one of the following:
 
 \twocolwidtha{5cm}


@@ -119,8 +126,8 @@ Its meaning is determined by the {\it flags} parameter.}
 %\twocolitem{\indexit{wxBITMAP\_TYPE\_RESOURCE}}{Load a Windows resource name.}
 \end{twocollist}
 
 %\twocolitem{\indexit{wxBITMAP\_TYPE\_RESOURCE}}{Load a Windows resource name.}
 \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.}
 


@@ -141,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


@@ -211,7 +218,7 @@ 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.
 


@@ -260,11 +267,11 @@ 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}
 


@@ -274,7 +281,7 @@ TRUE if the operation succeeded, FALSE otherwise.
 
 \constfunc{bool}{Ok}{\void}
 
 
 \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}
 
 \begin{comment}
 \membersection{wxIcon::SaveFile}\label{wxiconsavefile}


@@ -297,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}
 


@@ -383,7 +390,7 @@ 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 $!=$}
 


@@ -398,6 +405,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.