finished implementation for stencil and colored patterns

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

diff --git a/docs/latex/wx/variant.tex b/docs/latex/wx/variant.tex
index f09ee5898c733f8a7c0f7e25fcaee4f17c58f81a..e1c3d5602a70bbd812e07a2b74596781085f0c4c 100644 (file)
--- 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,
 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.
 
 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.


@@ -17,10 +12,6 @@ for different data types, or a remote procedure call protocol.
 An optional name member is associated with a wxVariant. This might be used, for example, in CORBA
 or OLE automation classes, where named parameters are required.
 
 An optional name member is associated with a wxVariant. This might be used, for example, in CORBA
 or OLE automation classes, where named parameters are required.
 

-wxVariant is similar to wxExpr and also to wxPropertyValue. However, wxExpr is efficiency-optimized for
-a restricted range of data types, whereas wxVariant is less efficient but more extensible.
-wxPropertyValue may be replaced by wxVariant eventually.
-

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


@@ -74,29 +65,37 @@ Construction from a list of wxVariant objects. This constructor
 copies {\it value}, the application is still responsible for
 deleting {\it value} and its contents.
 
 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 = ``"}}
+\func{}{wxVariant}{\param{void*}{ 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.
+Construction from a void pointer.

 
 

-%Note: this constructor is currently disabled because it causes a C++ ambiguity.
+\func{}{wxVariant}{\param{wxObject*}{ value}, \param{const wxString\& }{name = ``"}}

 
 

-\func{}{wxVariant}{\param{const wxTime\&}{ value}, \param{const wxString\& }{name = ``"}}
+Construction from a wxObject pointer.

 
 

-Construction from a time.
+\func{}{wxVariant}{\param{wxVariantData*}{ data}, \param{const wxString\& }{name = ``"}}

 
 

-\func{}{wxVariant}{\param{const wxDate\&}{ value}, \param{const wxString\& }{name = ``"}}
+Construction from user-defined data.  The variant holds onto the {\it data} pointer.

 
 

-Construction from a date.
+\func{}{wxVariant}{\param{wxDateTime\&}{ val}, \param{const wxString\& }{name = ``"}}

 
 

-\func{}{wxVariant}{\param{void*}{ value}, \param{const wxString\& }{name = ``"}}
+Construction from a \helpref{wxDateTime}{wxdatetime}.  

 
 

-Construction from a void pointer.
+\func{}{wxVariant}{\param{wxArrayString\&}{ val}, \param{const wxString\& }{name = ``"}}

 
 

-\func{}{wxVariant}{\param{wxVariantData*}{ data}, \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 user-defined data. The variant holds on to the {\it data} pointer.
+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}
 
 
 \membersection{wxVariant::\destruct{wxVariant}}\label{wxvariantdtor}
 


@@ -104,6 +103,7 @@ Construction from user-defined data. The variant holds on to the {\it data} poin
 
 Destructor.
 
 
 Destructor.
 

+

 \membersection{wxVariant::Append}\label{wxvariantappend}
 
 \func{void}{Append}{\param{const wxVariant\&}{ value}}
 \membersection{wxVariant::Append}\label{wxvariantappend}
 
 \func{void}{Append}{\param{const wxVariant\&}{ value}}


@@ -116,6 +116,24 @@ Appends a value to the list.
 
 Deletes the contents of the list.
 
 
 Deletes the contents of the list.
 

+
+\membersection{wxVariant::Convert}\label{wxvariantconvert}
+
+\constfunc{bool}{Convert}{\param{long*}{ value}}
+
+\constfunc{bool}{Convert}{\param{bool*}{ value}}
+
+\constfunc{bool}{Convert}{\param{double*}{ value}}
+
+\constfunc{bool}{Convert}{\param{wxString*}{ value}}
+
+\constfunc{bool}{Convert}{\param{char*}{ 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}
 \membersection{wxVariant::GetCount}\label{wxvariantgetcount}
 
 \constfunc{int}{GetCount}{\void}


@@ -128,6 +146,12 @@ Returns the number of elements in the list.
 
 Deletes the zero-based {\it item} from 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}
 \membersection{wxVariant::GetBool}\label{wxvariantgetbool}
 
 \constfunc{bool}{GetBool}{\void}


@@ -146,11 +170,11 @@ Returns the character value.
 
 Returns a pointer to the internal variant data.
 
 
 Returns a pointer to the internal variant data.
 

-\membersection{wxVariant::GetDate}\label{wxvariantgetdate}
+\membersection{wxVariant::GetDateTime}\label{wxvariantgetdatetime}

 
 

-\constfunc{wxDate}{GetDate}{\void}
+\constfunc{wxDateTime}{GetDateTime}{\void}

 
 

-Gets the date value.
+Returns the date value.

 
 \membersection{wxVariant::GetDouble}\label{wxvariantgetdouble}
 
 
 \membersection{wxVariant::GetDouble}\label{wxvariantgetdouble}
 


@@ -176,12 +200,6 @@ Returns a constant reference to the variant name.
 
 Gets the string value.
 
 
 Gets the string value.
 

-\membersection{wxVariant::GetTime}\label{wxvariantgettime}
-
-\constfunc{wxTime}{GetTime}{\void}
-
-Gets the time value.
-

 \membersection{wxVariant::GetType}\label{wxvariantgettype}
 
 \constfunc{wxString}{GetType}{\void}
 \membersection{wxVariant::GetType}\label{wxvariantgettype}
 
 \constfunc{wxString}{GetType}{\void}


@@ -196,6 +214,12 @@ If the variant is null, the value type returned is the string ``null" (not the e
 
 Gets the void pointer value.
 
 
 Gets the void pointer value.
 

+\membersection{wxVariant::GetWxObjectPtr}\label{wxvariantgetwxobjectptr}
+
+\constfunc{void*}{GetWxObjectPtr}{\void}
+
+Gets the wxObject pointer value.
+

 \membersection{wxVariant::Insert}\label{wxvariantinsert}
 
 \func{void}{Insert}{\param{const wxVariant\&}{ value}}
 \membersection{wxVariant::Insert}\label{wxvariantinsert}
 
 \func{void}{Insert}{\param{const wxVariant\&}{ value}}


@@ -206,13 +230,19 @@ Inserts a value at the front of the list.
 
 \constfunc{bool}{IsNull}{\void}
 
 
 \constfunc{bool}{IsNull}{\void}
 

-Returns TRUE if there is no data associated with this variant, FALSE if there is data.
+Returns true if there is no data associated with this variant, false if there is data.

 
 \membersection{wxVariant::IsType}\label{wxvariantistype}
 
 \constfunc{bool}{IsType}{\param{const wxString\&}{ type}}
 
 
 \membersection{wxVariant::IsType}\label{wxvariantistype}
 
 \constfunc{bool}{IsType}{\param{const wxString\&}{ type}}
 

-Returns TRUE if {\it type} matches the type of the variant, FALSE otherwise.
+Returns true if {\it type} matches the type of the variant, false otherwise.
+
+\membersection{wxVariant::IsValueKindOf}\label{wxvariantisvaluekindof}
+
+\constfunc{bool}{IsValueKindOf}{\param{const wxClassInfo* type}{ type}}
+
+Returns true if the data is derived from the class described by {\it type}, false otherwise.

 
 \membersection{wxVariant::MakeNull}\label{wxvariantmakenull}
 
 
 \membersection{wxVariant::MakeNull}\label{wxvariantmakenull}
 


@@ -230,7 +260,7 @@ Makes a string representation of the variant value (for any type).
 
 \constfunc{bool}{Member}{\param{const wxVariant\&}{ value}}
 
 
 \constfunc{bool}{Member}{\param{const wxVariant\&}{ value}}
 

-Returns TRUE if {\it value} matches an element in the list.
+Returns true if {\it value} matches an element in the list.

 
 \membersection{wxVariant::NullList}\label{wxvariantnulllist}
 
 
 \membersection{wxVariant::NullList}\label{wxvariantnulllist}
 


@@ -263,71 +293,71 @@ Sets the internal variant data, deleting the existing data if there is any.
 
 \func{void}{operator $=$}{\param{const double }{value}}
 
 
 \func{void}{operator $=$}{\param{const double }{value}}
 

-\func{void}{operator $=$}{\param{const wxDate\& }{value}}
-
-\func{void}{operator $=$}{\param{const wxTime\& }{value}}
-

 \func{void}{operator $=$}{\param{void* }{value}}
 
 \func{void}{operator $=$}{\param{const wxList\& }{value}}
 
 \func{void}{operator $=$}{\param{void* }{value}}
 
 \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}}
+
+\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}
 
 
 Assignment operators.
 
 \membersection{wxVariant::operator $==$}\label{wxvarianteq}
 

-\func{bool}{operator $==$}{\param{const wxVariant\& }{value}}
-
-\func{bool}{operator $==$}{\param{const wxString\& }{value}}
+\constfunc{bool}{operator $==$}{\param{const wxVariant\& }{value}}

 
 

-\func{bool}{operator $==$}{\param{const char* }{value}}
+\constfunc{bool}{operator $==$}{\param{const wxString\& }{value}}

 
 

-\func{bool}{operator $==$}{\param{char }{value}}
+\constfunc{bool}{operator $==$}{\param{const char* }{value}}

 
 

-\func{bool}{operator $==$}{\param{const long }{value}}
+\constfunc{bool}{operator $==$}{\param{char }{value}}

 
 

-\func{bool}{operator $==$}{\param{const bool }{value}}
+\constfunc{bool}{operator $==$}{\param{const long }{value}}

 
 

-\func{bool}{operator $==$}{\param{const double }{value}}
+\constfunc{bool}{operator $==$}{\param{const bool }{value}}

 
 

-\func{bool}{operator $==$}{\param{const wxDate\& }{value}}
+\constfunc{bool}{operator $==$}{\param{const double }{value}}

 
 

-\func{bool}{operator $==$}{\param{const wxTime\& }{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 wxArrayString\& }{value}}

 
 

-\func{bool}{operator $==$}{\param{const wxStringList\& }{value}}
+\constfunc{bool}{operator $==$}{\param{const wxDateTime\& }{value}}

 
 Equality test operators.
 
 \membersection{wxVariant::operator $!=$}\label{wxvariantneq}
 
 
 Equality test operators.
 
 \membersection{wxVariant::operator $!=$}\label{wxvariantneq}
 

-\func{bool}{operator $!=$}{\param{const wxVariant\& }{value}}
+\constfunc{bool}{operator $!=$}{\param{const wxVariant\& }{value}}

 
 

-\func{bool}{operator $!=$}{\param{const wxString\& }{value}}
+\constfunc{bool}{operator $!=$}{\param{const wxString\& }{value}}

 
 

-\func{bool}{operator $!=$}{\param{const char* }{value}}
+\constfunc{bool}{operator $!=$}{\param{const char* }{value}}

 
 

-\func{bool}{operator $!=$}{\param{char }{value}}
+\constfunc{bool}{operator $!=$}{\param{char }{value}}

 
 

-\func{bool}{operator $!=$}{\param{const long }{value}}
+\constfunc{bool}{operator $!=$}{\param{const long }{value}}

 
 

-\func{bool}{operator $!=$}{\param{const bool }{value}}
+\constfunc{bool}{operator $!=$}{\param{const bool }{value}}

 
 

-\func{bool}{operator $!=$}{\param{const double }{value}}
+\constfunc{bool}{operator $!=$}{\param{const double }{value}}

 
 

-\func{bool}{operator $!=$}{\param{const wxDate\& }{value}}
+\constfunc{bool}{operator $!=$}{\param{void* }{value}}

 
 

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

 
 

-\func{bool}{operator $!=$}{\param{void* }{value}}
+\constfunc{bool}{operator $!=$}{\param{const wxArrayString\& }{value}}

 
 

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

 
 Inequality test operators.
 
 
 Inequality test operators.
 


@@ -358,30 +388,24 @@ Operator for implicit conversion to a double, using \helpref{wxVariant::GetDoubl
 
 Operator for implicit conversion to a long, using \helpref{wxVariant::GetLong}{wxvariantgetlong}.
 
 
 Operator for implicit conversion to a long, using \helpref{wxVariant::GetLong}{wxvariantgetlong}.
 

-\membersection{wxVariant::operator wxDate}\label{wxvariantwxdate}
-
-\constfunc{wxDate}{operator wxDate}{\void}
-
-Operator for implicit conversion to a wxDate, using \helpref{wxVariant::GetDate}{wxvariantgetdate}.
-

 \membersection{wxVariant::operator wxString}\label{wxvariantwxstring}
 
 \constfunc{wxString}{operator wxString}{\void}
 
 Operator for implicit conversion to a string, using \helpref{wxVariant::MakeString}{wxvariantmakestring}.
 
 \membersection{wxVariant::operator wxString}\label{wxvariantwxstring}
 
 \constfunc{wxString}{operator wxString}{\void}
 
 Operator for implicit conversion to a string, using \helpref{wxVariant::MakeString}{wxvariantmakestring}.
 

-\membersection{wxVariant::operator wxTime}\label{wxvariantwxtime}
-
-\constfunc{wxTime}{operator wxTime}{\void}
-
-Operator for implicit conversion to a wxTime, using \helpref{wxVariant::GetTime}{wxvariantgettime}.
-

 \membersection{wxVariant::operator void*}\label{wxvariantvoid}
 
 \constfunc{void*}{operator void*}{\void}
 
 Operator for implicit conversion to a pointer to a void, using \helpref{wxVariant::GetVoidPtr}{wxvariantgetvoidptr}.
 
 \membersection{wxVariant::operator void*}\label{wxvariantvoid}
 
 \constfunc{void*}{operator void*}{\void}
 
 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,
 \section{\class{wxVariantData}}\label{wxvariantdata}
 
 The {\bf wxVariantData} is used to implement a new type for wxVariant. Derive from wxVariantData,


@@ -417,7 +441,7 @@ Copy the data from `this' object to {\it data}.
 
 \constfunc{bool}{Eq}{\param{wxVariantData\&}{ data}}
 
 
 \constfunc{bool}{Eq}{\param{wxVariantData\&}{ data}}
 

-Returns TRUE if this object is equal to {\it data}.
+Returns true if this object is equal to {\it data}.

 
 \membersection{wxVariantData::GetType}\label{wxvariantdatagettype}
 
 
 \membersection{wxVariantData::GetType}\label{wxvariantdatagettype}
 


@@ -425,6 +449,13 @@ Returns TRUE if this object is equal to {\it data}.
 
 Returns the string type of the data.
 
 
 Returns the string type of the data.
 

+\membersection{wxVariantData::GetValueClassInfo}\label{wxvariantdatagetvalueclassinfo}
+
+\constfunc{wxClassInfo*}{GetValueClassInfo}{\void}
+
+If the data is a wxObject returns a pointer to the objects wxClassInfo structure, if
+the data isn't a wxObject the method returns NULL.
+

 \membersection{wxVariantData::Read}\label{wxvariantdataread}
 
 \func{bool}{Read}{\param{ostream\&}{ stream}}
 \membersection{wxVariantData::Read}\label{wxvariantdataread}
 
 \func{bool}{Read}{\param{ostream\&}{ stream}}


@@ -442,4 +473,17 @@ Reads the data from {\it stream} or {\it string}.
 Writes the data to {\it stream} or {\it string}.
 
 
 Writes the data to {\it stream} or {\it string}.
 
 

+\membersection{wxGetVariantCast}\label{wxgetvariantcast}
+
+\func{classname *}{wxGetVariantCast}{wxVariant\&, classname}
+
+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. 
+
+
+\wxheading{See also}
+
+\helpref{RTTI overview}{runtimeclassoverview}\\
+\helpref{wxDynamicCast}{wxdynamiccast}