+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% 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.
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.
\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 = ``"}}
\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.
\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}}
\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}}
\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}}
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}
-