wxRichTextAttr does not exist anymore - document instead wxTextAttr

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

diff --git a/docs/latex/wx/icon.tex b/docs/latex/wx/icon.tex
index bcbb41f6d1b02ca580f4c7b9988cb9efdd1aee27..5199f35c44c077f4aeeefbbc4ab7a67013e7f780 100644 (file)
--- a/docs/latex/wx/icon.tex
+++ b/docs/latex/wx/icon.tex
@@ -19,6 +19,10 @@ a separate class is provided.
 
 <wx/icon.h>
 
 
 <wx/icon.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Predefined objects}
 
 Objects:
 \wxheading{Predefined objects}
 
 Objects:


@@ -80,7 +84,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.


@@ -212,10 +216,8 @@ must have mask colour set.
 
 \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.
 
 If the application omits to delete the icon explicitly, the icon will be
 destroyed automatically by wxWidgets when the application exits.


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


@@ -277,16 +279,16 @@ true if the operation succeeded, false otherwise.
 
 \helpref{wxIcon::wxIcon}{wxiconctor}
 
 
 \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,16 +343,6 @@ 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}\label{wxiconsetok}
-
-\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}\label{wxiconsetwidth}
 
 \func{void}{SetWidth}{\param{int }{width}}
 \membersection{wxIcon::SetWidth}\label{wxiconsetwidth}
 
 \func{void}{SetWidth}{\param{int }{width}}


@@ -365,9 +357,7 @@ Sets the width member (does not affect the icon data).
 
 \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 +367,4 @@ counter. It is a fast operation.
 
 Returns 'this' object.
 
 
 Returns 'this' object.
 

-\membersection{wxIcon::operator $==$}\label{wxiconequal}
-
-\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 $!=$}\label{wxiconnotequal}
-
-\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.
-