Fix "depreciated" to "deprecated".

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

diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex
index 28999bc3dfc55d6a8fa3f50cfd9c139722f6a51b..b1a8b244a1ba90b713d7d2c72d5512d570c0b801 100644 (file)
--- a/docs/latex/wx/icon.tex
+++ b/docs/latex/wx/icon.tex
@@ -51,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}
 


@@ -80,7 +80,7 @@ Creates a new icon.
 
 Creates an icon from XPM data.
 
 
 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.


@@ -208,21 +208,19 @@ must have mask colour set.
 \end{itemize}
 }
 
 \end{itemize}
 }
 

-\membersection{wxIcon::\destruct{wxIcon}}
+\membersection{wxIcon::\destruct{wxIcon}}\label{wxicondtor}

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

-Destroys the wxIcon object and possibly the underlying icon data.
-Because reference counting is used, the icon may not actually be
-destroyed at this point - only when the reference count is zero will the
-data be deleted.
+Destructor.
+See \helpref{reference-counted object destruction}{refcountdestruct} for more info.

 
 If the application omits to delete the icon explicitly, the icon will be
 destroyed automatically by wxWidgets when the application exits.
 
 Do not delete an icon that is selected into a memory device context.
 
 
 If the application omits to delete the icon explicitly, the icon will be
 destroyed automatically by wxWidgets when the application exits.
 
 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}
 


@@ -247,7 +245,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.
 


@@ -275,18 +273,18 @@ 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.
 
 \begin{comment}
 \membersection{wxIcon::SaveFile}\label{wxiconsavefile}
 
 
 Returns true if icon data is present.
 
 \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.
 


@@ -341,17 +339,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}}
 


@@ -361,13 +349,11 @@ 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}}
 

-Assignment operator. This operator does not copy any data, but instead
-passes a pointer to the data in {\it icon} and increments a reference
-counter. It is a fast operation.
+Assignment operator, using \helpref{reference counting}{trefcount}.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -377,34 +363,4 @@ counter. It is a fast operation.
 
 Returns 'this' object.
 
 
 Returns 'this' object.
 

-\membersection{wxIcon::operator $==$}
-
-\func{bool}{operator $==$}{\param{const wxIcon\& }{icon}}
-
-Equality operator. This operator tests whether the internal data pointers are
-equal (a fast test).
-
-\wxheading{Parameters}
-
-\docparam{icon}{Icon to compare with 'this'}
-
-\wxheading{Return value}
-
-Returns true if the icons were effectively equal, false otherwise.
-
-\membersection{wxIcon::operator $!=$}
-
-\func{bool}{operator $!=$}{\param{const wxIcon\& }{icon}}
-
-Inequality operator. This operator tests whether the internal data pointers are
-unequal (a fast test).
-
-\wxheading{Parameters}
-
-\docparam{icon}{Icon to compare with 'this'}
-
-\wxheading{Return value}
-
-Returns true if the icons were unequal, false otherwise.
-