remove C++ comment

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

diff --git a/docs/latex/wx/variant.tex b/docs/latex/wx/variant.tex
index d165cd62816e8b6bb5f4d6674ce9f927fad8b2b0..6394598e1d3c1244675b15d75b5331fcce4eb05f 100644 (file)
--- a/docs/latex/wx/variant.tex
+++ b/docs/latex/wx/variant.tex
@@ -72,6 +72,10 @@ IMPLEMENT_VARIANT_OBJECT(wxIcon)
 IMPLEMENT_VARIANT_OBJECT(wxBitmap)
 \end{verbatim}
 
 IMPLEMENT_VARIANT_OBJECT(wxBitmap)
 \end{verbatim}
 

+Note that as of wxWidgets 2.9.0, wxVariantData no longer inherits from wxObject
+and wxVariant no longer uses the type-unsafe wxList class for list
+operations but the type-safe wxVariantList class.
+

 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}


@@ -123,7 +127,7 @@ Construction from a boolean value.
 
 Construction from a double-precision floating point value.
 
 
 Construction from a double-precision floating point value.
 

-\func{}{wxVariant}{\param{const wxList\&}{ value}, \param{const wxString\& }{name = ``"}}
+\func{}{wxVariant}{\param{const wxVariantList\&}{ value}, \param{const wxString\& }{name = ``"}}

 
 Construction from a list of wxVariant objects. This constructor
 copies {\it value}, the application is still responsible for
 
 Construction from a list of wxVariant objects. This constructor
 copies {\it value}, the application is still responsible for


@@ -260,6 +264,13 @@ Returns the date value.
 
 Returns the floating point value.
 
 
 Returns the floating point value.
 

+\membersection{wxVariant::GetList}\label{wxvariantgetlist}
+
+\constfunc{wxVariantList &}{GetList}{\void}
+
+Returns a reference to the wxVariantList class used by
+wxVariant if this wxVariant is currently a list of variants.
+

 \membersection{wxVariant::GetLong}\label{wxvariantgetlong}
 
 \constfunc{long}{GetLong}{\void}
 \membersection{wxVariant::GetLong}\label{wxvariantgetlong}
 
 \constfunc{long}{GetLong}{\void}


@@ -282,7 +293,7 @@ Gets the string value.
 
 \constfunc{wxString}{GetType}{\void}
 
 
 \constfunc{wxString}{GetType}{\void}
 

-Returns the value type as a string. The built-in types are: bool, char, date, double, list, long, string, stringlist, time, void*.
+Returns the value type as a string. The built-in types are: bool, char, datetime, double, list, long, string, arrstring, void*.

 
 If the variant is null, the value type returned is the string ``null" (not the empty string).
 
 
 If the variant is null, the value type returned is the string ``null" (not the empty string).
 


@@ -375,7 +386,7 @@ Sets the internal variant data, deleting the existing data if there is any.
 
 \func{void}{operator $=$}{\param{wxObject* }{value}}
 
 
 \func{void}{operator $=$}{\param{wxObject* }{value}}
 

-\func{void}{operator $=$}{\param{const wxList\& }{value}}
+\func{void}{operator $=$}{\param{const wxVariantList\& }{value}}

 
 \func{void}{operator $=$}{\param{const wxDateTime\& }{value}}
 
 
 \func{void}{operator $=$}{\param{const wxDateTime\& }{value}}
 


@@ -409,7 +420,7 @@ Assignment operators, using \helpref{reference counting}{trefcount} when possibl
 
 \constfunc{bool}{operator $==$}{\param{wxObject* }{value}}
 
 
 \constfunc{bool}{operator $==$}{\param{wxObject* }{value}}
 

-\constfunc{bool}{operator $==$}{\param{const wxList\& }{value}}
+\constfunc{bool}{operator $==$}{\param{const wxVariantList\& }{value}}

 
 \constfunc{bool}{operator $==$}{\param{const wxArrayString\& }{value}}
 
 
 \constfunc{bool}{operator $==$}{\param{const wxArrayString\& }{value}}
 


@@ -437,7 +448,7 @@ Equality test operators.
 
 \constfunc{bool}{operator $!=$}{\param{wxObject* }{value}}
 
 
 \constfunc{bool}{operator $!=$}{\param{wxObject* }{value}}
 

-\constfunc{bool}{operator $!=$}{\param{const wxList\& }{value}}
+\constfunc{bool}{operator $!=$}{\param{const wxVariantList\& }{value}}

 
 \constfunc{bool}{operator $!=$}{\param{const wxArrayString\& }{value}}
 
 
 \constfunc{bool}{operator $!=$}{\param{const wxArrayString\& }{value}}
 


@@ -509,10 +520,6 @@ Also note that the destructor is protected, so you can never explicitly delete a
 instance. Instead, \helpref{DecRef}{wxvariantdatadecref} will delete the object automatically
 when the reference count reaches zero.
 
 instance. Instead, \helpref{DecRef}{wxvariantdatadecref} will delete the object automatically
 when the reference count reaches zero.
 

-\wxheading{Derived from}
-
-\helpref{wxObject}{wxobject}
-

 \wxheading{Include files}
 
 <wx/variant.h>
 \wxheading{Include files}
 
 <wx/variant.h>