From 8715d2d3c20e354b252075e8f070ba38582e3f0a Mon Sep 17 00:00:00 2001 From: Ryan Norton Date: Fri, 24 Sep 2004 01:20:18 +0000 Subject: [PATCH] Add doc TODOs for wxVariant. You know, Convert wasn't documented _at all_, heh :). git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@29305 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/variant.tex | 124 +++++++++++++++++++++++++++++--------- include/wx/variant.h | 10 --- 2 files changed, 97 insertions(+), 37 deletions(-) diff --git a/docs/latex/wx/variant.tex b/docs/latex/wx/variant.tex index 951992df29..3bdde7a28e 100644 --- a/docs/latex/wx/variant.tex +++ b/docs/latex/wx/variant.tex @@ -4,12 +4,7 @@ The {\bf wxVariant} class represents a container for any type. A variant's value can be changed at run time, possibly to a different type of value. As standard, wxVariant can store values of type bool, char, double, long, string, -string list, time, date, void pointer, list of strings, and list of variants. However, an application can extend -wxVariant's capabilities by deriving from the class \helpref{wxVariantData}{wxvariantdata} and -using the wxVariantData form of the wxVariant constructor or assignment operator -to assign this data to a variant. Actual values for user-defined types will need to be accessed -via the wxVariantData object, unlike the case for basic data types where convenience -functions such as GetLong can be used. +string list, time, date, void pointer, list of strings, and list of variants. However, an application can extend wxVariant's capabilities by deriving from the class \helpref{wxVariantData}{wxvariantdata} and using the wxVariantData form of the wxVariant constructor or assignment operator to assign this data to a variant. Actual values for user-defined types will need to be accessed via the wxVariantData object, unlike the case for basic data types where convenience functions such as GetLong can be used. This class is useful for reducing the programming for certain tasks, such as an editor for different data types, or a remote procedure call protocol. @@ -86,7 +81,27 @@ Construction from a wxObject pointer. \func{}{wxVariant}{\param{wxVariantData*}{ data}, \param{const wxString\& }{name = ``"}} -Construction from user-defined data. The variant holds on to the {\it data} pointer. +Construction from user-defined data. The variant holds onto the {\it data} pointer. + +\func{}{wxVariant}{\param{wxDateTime\&}{ val}, \param{const wxString\& }{name = ``"}} + +Construction from a \helpref{wxDateTime}{wxdatetime}. + +\func{}{wxVariant}{\param{wxArrayString\&}{ val}, \param{const wxString\& }{name = ``"}} + +Construction from an array of strings. This constructor copies {\it value} and its contents. + +\func{}{wxVariant}{\param{DATE\_STRUCT*}{ val}, \param{const wxString\& }{name = ``"}} + +Construction from a odbc date value. Represented internally by a \helpref{wxDateTime}{wxdatetime} value. + +\func{}{wxVariant}{\param{TIME\_STRUCT*}{ val}, \param{const wxString\& }{name = ``"}} + +Construction from a odbc time value. Represented internally by a \helpref{wxDateTime}{wxdatetime} value. + +\func{}{wxVariant}{\param{TIMESTAMP\_STRUCT*}{ val}, \param{const wxString\& }{name = ``"}} + +Construction from a odbc timestamp value. Represented internally by a \helpref{wxDateTime}{wxdatetime} value. \membersection{wxVariant::\destruct{wxVariant}}\label{wxvariantdtor} @@ -94,6 +109,7 @@ Construction from user-defined data. The variant holds on to the {\it data} poin Destructor. + \membersection{wxVariant::Append}\label{wxvariantappend} \func{void}{Append}{\param{const wxVariant\&}{ value}} @@ -106,6 +122,24 @@ Appends a value to the list. Deletes the contents of the list. + +\membersection{wxVariant::Convert}\label{wxvariantconvert} + +\constfunc{bool}{Convert}{long* value} + +\constfunc{bool}{Convert}{bool* value} + +\constfunc{bool}{Convert}{double* value} + +\constfunc{bool}{Convert}{wxString* value} + +\constfunc{bool}{Convert}{char* value} + +\constfunc{bool}{Convert}{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} @@ -118,6 +152,12 @@ Returns the number of elements in the list. Deletes the zero-based {\it item} from the list. +\membersection{wxVariant::GetArrayString}\label{wxvariantgetarraystring} + +\constfunc{wxArrayString}{GetArrayString}{\void} + +Returns the string array value. + \membersection{wxVariant::GetBool}\label{wxvariantgetbool} \constfunc{bool}{GetBool}{\void} @@ -136,6 +176,12 @@ Returns the character value. Returns a pointer to the internal variant data. +\membersection{wxVariant::GetDateTime}\label{wxvariantgetdatetime} + +\constfunc{wxDateTime}{GetDateTime}{\void} + +Returns the date value. + \membersection{wxVariant::GetDouble}\label{wxvariantgetdouble} \constfunc{double}{GetDouble}{\void} @@ -259,53 +305,71 @@ Sets the internal variant data, deleting the existing data if there is any. \func{void}{operator $=$}{\param{const wxStringList\& }{value}} +\func{void}{operator $=$}{\param{const wxDateTime\& }{value}} + +\func{void}{operator $=$}{\param{const wxArrayString\& }{value}} + +\func{void}{operator $=$}{\param{const DATE\_STRUCT* }{value}} + +\func{void}{operator $=$}{\param{const TIME\_STRUCT* }{value}} + +\func{void}{operator $=$}{\param{const TIMESTAMP\_STRUCT* }{value}} + Assignment operators. \membersection{wxVariant::operator $==$}\label{wxvarianteq} -\func{bool}{operator $==$}{\param{const wxVariant\& }{value}} +\constfunc{bool}{operator $==$}{\param{const wxVariant\& }{value}} + +\constfunc{bool}{operator $==$}{\param{const wxString\& }{value}} -\func{bool}{operator $==$}{\param{const wxString\& }{value}} +\constfunc{bool}{operator $==$}{\param{const char* }{value}} -\func{bool}{operator $==$}{\param{const char* }{value}} +\constfunc{bool}{operator $==$}{\param{char }{value}} -\func{bool}{operator $==$}{\param{char }{value}} +\constfunc{bool}{operator $==$}{\param{const long }{value}} -\func{bool}{operator $==$}{\param{const long }{value}} +\constfunc{bool}{operator $==$}{\param{const bool }{value}} -\func{bool}{operator $==$}{\param{const bool }{value}} +\constfunc{bool}{operator $==$}{\param{const double }{value}} -\func{bool}{operator $==$}{\param{const double }{value}} +\constfunc{bool}{operator $==$}{\param{void* }{value}} -\func{bool}{operator $==$}{\param{void* }{value}} +\constfunc{bool}{operator $==$}{\param{const wxList\& }{value}} -\func{bool}{operator $==$}{\param{const wxList\& }{value}} +\constfunc{bool}{operator $==$}{\param{const wxStringList\& }{value}} -\func{bool}{operator $==$}{\param{const wxStringList\& }{value}} +\constfunc{bool}{operator $==$}{\param{const wxArrayString\& }{value}} + +\constfunc{bool}{operator $==$}{\param{const wxDateTime\& }{value}} Equality test operators. \membersection{wxVariant::operator $!=$}\label{wxvariantneq} -\func{bool}{operator $!=$}{\param{const wxVariant\& }{value}} +\constfunc{bool}{operator $!=$}{\param{const wxVariant\& }{value}} + +\constfunc{bool}{operator $!=$}{\param{const wxString\& }{value}} -\func{bool}{operator $!=$}{\param{const wxString\& }{value}} +\constfunc{bool}{operator $!=$}{\param{const char* }{value}} -\func{bool}{operator $!=$}{\param{const char* }{value}} +\constfunc{bool}{operator $!=$}{\param{char }{value}} -\func{bool}{operator $!=$}{\param{char }{value}} +\constfunc{bool}{operator $!=$}{\param{const long }{value}} -\func{bool}{operator $!=$}{\param{const long }{value}} +\constfunc{bool}{operator $!=$}{\param{const bool }{value}} -\func{bool}{operator $!=$}{\param{const bool }{value}} +\constfunc{bool}{operator $!=$}{\param{const double }{value}} -\func{bool}{operator $!=$}{\param{const double }{value}} +\constfunc{bool}{operator $!=$}{\param{void* }{value}} -\func{bool}{operator $!=$}{\param{void* }{value}} +\constfunc{bool}{operator $!=$}{\param{const wxList\& }{value}} -\func{bool}{operator $!=$}{\param{const wxList\& }{value}} +\constfunc{bool}{operator $!=$}{\param{const wxStringList\& }{value}} -\func{bool}{operator $!=$}{\param{const wxStringList\& }{value}} +\constfunc{bool}{operator $!=$}{\param{const wxArrayString\& }{value}} + +\constfunc{bool}{operator $!=$}{\param{const wxDateTime\& }{value}} Inequality test operators. @@ -348,6 +412,12 @@ Operator for implicit conversion to a string, using \helpref{wxVariant::MakeStri Operator for implicit conversion to a pointer to a void, using \helpref{wxVariant::GetVoidPtr}{wxvariantgetvoidptr}. +\membersection{wxVariant::operator wxDateTime}\label{wxvariantdatetime} + +\constfunc{void*}{operator wxDateTime}{\void} + +Operator for implicit conversion to a pointer to a \helpref{wxDateTime}{wxdatetime}, using \helpref{wxVariant::GetDateTime}{wxvariantgetdatetime}. + \section{\class{wxVariantData}}\label{wxvariantdata} The {\bf wxVariantData} is used to implement a new type for wxVariant. Derive from wxVariantData, diff --git a/include/wx/variant.h b/include/wx/variant.h index ef70b0e3ae..3c1a55dc0c 100644 --- a/include/wx/variant.h +++ b/include/wx/variant.h @@ -100,7 +100,6 @@ public: wxVariant(void* ptr, const wxString& name = wxEmptyString); // void* (general purpose) wxVariant(wxObject* ptr, const wxString& name = wxEmptyString); //wxObject wxVariant(wxVariantData* data, const wxString& name = wxEmptyString); // User-defined data -//TODO: Need to document #if wxUSE_DATETIME wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); // Date #endif // wxUSE_DATETIME @@ -110,7 +109,6 @@ public: wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime #endif -//TODO: End of Need to document wxVariant(const wxVariant& variant); ~wxVariant(); @@ -119,7 +117,6 @@ public: // Assignment void operator= (const wxVariant& variant); -//TODO: Need to document #if wxUSE_DATETIME bool operator== (const wxDateTime& value) const; bool operator!= (const wxDateTime& value) const; @@ -134,7 +131,6 @@ public: void operator= (const TIME_STRUCT* value) ; void operator= (const TIMESTAMP_STRUCT* value) ; #endif -//TODO: End of Need to document // Assignment using data, e.g. // myVariant = new wxStringVariantData("hello"); @@ -188,11 +184,9 @@ public: // No implicit conversion to wxObject, as that would really // confuse people between conversion to our contained data // and downcasting to see our base type. -//TODO: Need to document #if wxUSE_DATETIME inline operator wxDateTime () const { return GetDateTime(); } #endif // wxUSE_DATETIME -//TODO: End of Need to document // Accessors // Sets/gets name @@ -228,12 +222,10 @@ public: void* GetVoidPtr() const ; wxObject* GetWxObjectPtr() ; -//TODO: Need to document #if wxUSE_DATETIME wxDateTime GetDateTime() const ; #endif // wxUSE_DATETIME wxArrayString GetArrayString() const; -//TODO: End of Need to document // Operations // Make NULL (i.e. delete the data) @@ -265,11 +257,9 @@ public: bool Convert(double* value) const; bool Convert(wxString* value) const; bool Convert(char* value) const; -//TODO: Need to document #if wxUSE_DATETIME bool Convert(wxDateTime* value) const; #endif // wxUSE_DATETIME -//TODO: End of Need to document // Attributes protected: -- 2.45.2