GetWxObjectPtr() returns wxObject*, not void*.

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

diff --git a/docs/latex/wx/variant.tex b/docs/latex/wx/variant.tex
index 3bdde7a28e5eff104c36803f7608490997d10e06..5f233fc1f1f48ef3fdac348161493f63dcc566d1 100644 (file)
--- a/docs/latex/wx/variant.tex
+++ b/docs/latex/wx/variant.tex
@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        variant.tex
+%% Purpose:     wxVariant docs
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:     01/30/2005
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \section{\class{wxVariant}}\label{wxvariant}
 
 The {\bf wxVariant} class represents a container for any type.
@@ -65,12 +76,6 @@ Construction from a list of wxVariant objects. This constructor
 copies {\it value}, the application is still responsible for
 deleting {\it value} and its contents.
 
-\func{}{wxVariant}{\param{const wxStringList\&}{ value}, \param{const wxString\& }{name = ``"}}
-
-Construction from a list of strings. This constructor
-copies {\it value}, the application is still responsible for
-deleting {\it value} and its contents.
-
 \func{}{wxVariant}{\param{void*}{ value}, \param{const wxString\& }{name = ``"}}
 
 Construction from a void pointer.
@@ -85,7 +90,7 @@ Construction from user-defined data.  The variant holds onto the {\it data} poin
 
 \func{}{wxVariant}{\param{wxDateTime\&}{ val}, \param{const wxString\& }{name = ``"}}
 
-Construction from a \helpref{wxDateTime}{wxdatetime}.  
+Construction from a \helpref{wxDateTime}{wxdatetime}.
 
 \func{}{wxVariant}{\param{wxArrayString\&}{ val}, \param{const wxString\& }{name = ``"}}
 
@@ -125,30 +130,30 @@ Deletes the contents of the list.
 
 \membersection{wxVariant::Convert}\label{wxvariantconvert}
 
-\constfunc{bool}{Convert}{long* value}
+\constfunc{bool}{Convert}{\param{long*}{ value}}
 
-\constfunc{bool}{Convert}{bool* value}
+\constfunc{bool}{Convert}{\param{bool*}{ value}}
 
-\constfunc{bool}{Convert}{double* value}
+\constfunc{bool}{Convert}{\param{double*}{ value}}
 
-\constfunc{bool}{Convert}{wxString* value}
+\constfunc{bool}{Convert}{\param{wxString*}{ value}}
 
-\constfunc{bool}{Convert}{char* value}
+\constfunc{bool}{Convert}{\param{char*}{ value}}
 
-\constfunc{bool}{Convert}{wxDateTime* value}
+\constfunc{bool}{Convert}{\param{wxDateTime*}{ value}}
 
 Retrieves and converts the value of this variant to the type that {\it value} is.
 
 
 \membersection{wxVariant::GetCount}\label{wxvariantgetcount}
 
-\constfunc{int}{GetCount}{\void}
+\constfunc{size\_t}{GetCount}{\void}
 
 Returns the number of elements in the list.
 
 \membersection{wxVariant::Delete}\label{wxvariantdelete}
 
-\func{bool}{Delete}{\param{int }{item}}
+\func{bool}{Delete}{\param{size\_t }{item}}
 
 Deletes the zero-based {\it item} from the list.
 
@@ -222,7 +227,7 @@ Gets the void pointer value.
 
 \membersection{wxVariant::GetWxObjectPtr}\label{wxvariantgetwxobjectptr}
 
-\constfunc{void*}{GetWxObjectPtr}{\void}
+\constfunc{wxObject*}{GetWxObjectPtr}{\void}
 
 Gets the wxObject pointer value.
 
@@ -303,8 +308,6 @@ Sets the internal variant data, deleting the existing data if there is any.
 
 \func{void}{operator $=$}{\param{const wxList\& }{value}}
 
-\func{void}{operator $=$}{\param{const wxStringList\& }{value}}
-
 \func{void}{operator $=$}{\param{const wxDateTime\& }{value}}
 
 \func{void}{operator $=$}{\param{const wxArrayString\& }{value}}
@@ -337,8 +340,6 @@ Assignment operators.
 
 \constfunc{bool}{operator $==$}{\param{const wxList\& }{value}}
 
-\constfunc{bool}{operator $==$}{\param{const wxStringList\& }{value}}
-
 \constfunc{bool}{operator $==$}{\param{const wxArrayString\& }{value}}
 
 \constfunc{bool}{operator $==$}{\param{const wxDateTime\& }{value}}
@@ -365,8 +366,6 @@ Equality test operators.
 
 \constfunc{bool}{operator $!=$}{\param{const wxList\& }{value}}
 
-\constfunc{bool}{operator $!=$}{\param{const wxStringList\& }{value}}
-
 \constfunc{bool}{operator $!=$}{\param{const wxArrayString\& }{value}}
 
 \constfunc{bool}{operator $!=$}{\param{const wxDateTime\& }{value}}
@@ -491,11 +490,10 @@ Writes the data to {\it stream} or {\it string}.
 
 This macro returns the data stored in {\it variant} cast to the type {\it classname *} if
 the data is of this type (the check is done during the run-time) or
-{\tt NULL} otherwise. 
+{\tt NULL} otherwise.
 
 
 \wxheading{See also}
 
 \helpref{RTTI overview}{runtimeclassoverview}\\
 \helpref{wxDynamicCast}{wxdynamiccast}
-