]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/variant.tex
GetCurrentSelection() was documented but not present in all ports (just MSW and GTK...
[wxWidgets.git] / docs / latex / wx / variant.tex
index 11c574c389b7c274dc9a7888d7faf01a0fb99897..0313c9316328b5be44327bed7321142f40f9c5f1 100644 (file)
@@ -14,7 +14,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,
+As standard, wxVariant can store values of type bool, wxChar, 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
@@ -23,7 +23,7 @@ Actual values for user-defined types will need to be accessed via the wxVariantD
 object, unlike the case for basic data types where convenience functions such as
 \helpref{GetLong}{wxvariantgetlong} can be used.
 
-Pointers to any \helpref{wxObject}{helpref} derived class can also easily be stored
+Pointers to any \helpref{wxObject}{wxobject} derived class can also easily be stored
 in a wxVariant. wxVariant will then use wxWidgets' built-in RTTI system to set the
 type name (returned by \helpref{GetType}{wxvariantgettype}) and to perform 
 type-safety checks at runtime.
@@ -34,10 +34,10 @@ 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.
 
-Note that as of wxWidgets 2.7.1, wxVariant is reference counted. Additionly, the
+Note that as of wxWidgets 2.7.1, wxVariant is reference counted. Additionally, the
 conveniance macros {\bf DECLARE\_VARIANT\_OBJECT} and {\bf IMPLEMENT\_VARIANT\_OBJECT}
 were added so that adding (limited) support for conversion to and from wxVariant
-can be very easily implemented without modifiying either the wxVariant or the class
+can be very easily implemented without modifiying either wxVariant or the class
 to be stored by wxVariant. Since assignement operators cannot be declared outside
 the class, the shift left operators are used like this:
 
@@ -67,8 +67,6 @@ the shift operator conversion for a few of its drawing related classes:
 
 \begin{verbatim}
 IMPLEMENT_VARIANT_OBJECT(wxColour)
-IMPLEMENT_VARIANT_OBJECT(wxPen)
-IMPLEMENT_VARIANT_OBJECT(wxBrush)
 IMPLEMENT_VARIANT_OBJECT(wxImage)
 IMPLEMENT_VARIANT_OBJECT(wxIcon)
 IMPLEMENT_VARIANT_OBJECT(wxBitmap)
@@ -98,13 +96,13 @@ Default constructor.
 
 Copy constructor.
 
-\func{}{wxVariant}{\param{const char*}{ value}, \param{const wxString\& }{name = ``"}}
+\func{}{wxVariant}{\param{const wxChar*}{ value}, \param{const wxString\& }{name = ``"}}
 
 \func{}{wxVariant}{\param{const wxString\&}{ value}, \param{const wxString\& }{name = ``"}}
 
 Construction from a string value.
 
-\func{}{wxVariant}{\param{char}{ value}, \param{const wxString\& }{name = ``"}}
+\func{}{wxVariant}{\param{wxChar}{ value}, \param{const wxString\& }{name = ``"}}
 
 Construction from a character value.
 
@@ -199,7 +197,7 @@ Deletes the contents of the list.
 
 \constfunc{bool}{Convert}{\param{wxString*}{ value}}
 
-\constfunc{bool}{Convert}{\param{char*}{ value}}
+\constfunc{bool}{Convert}{\param{wxChar*}{ value}}
 
 \constfunc{bool}{Convert}{\param{wxDateTime*}{ value}}
 
@@ -232,7 +230,7 @@ Returns the boolean value.
 
 \membersection{wxVariant::GetChar}\label{wxvariantgetchar}
 
-\constfunc{char}{GetChar}{\void}
+\constfunc{wxChar}{GetChar}{\void}
 
 Returns the character value.
 
@@ -358,9 +356,9 @@ Sets the internal variant data, deleting the existing data if there is any.
 
 \func{void}{operator $=$}{\param{const wxString\& }{value}}
 
-\func{void}{operator $=$}{\param{const char* }{value}}
+\func{void}{operator $=$}{\param{const wxChar* }{value}}
 
-\func{void}{operator $=$}{\param{char }{value}}
+\func{void}{operator $=$}{\param{wxChar }{value}}
 
 \func{void}{operator $=$}{\param{const long }{value}}
 
@@ -392,9 +390,9 @@ Assignment operators.
 
 \constfunc{bool}{operator $==$}{\param{const wxString\& }{value}}
 
-\constfunc{bool}{operator $==$}{\param{const char* }{value}}
+\constfunc{bool}{operator $==$}{\param{const wxChar* }{value}}
 
-\constfunc{bool}{operator $==$}{\param{char }{value}}
+\constfunc{bool}{operator $==$}{\param{wxChar }{value}}
 
 \constfunc{bool}{operator $==$}{\param{const long }{value}}
 
@@ -420,9 +418,9 @@ Equality test operators.
 
 \constfunc{bool}{operator $!=$}{\param{const wxString\& }{value}}
 
-\constfunc{bool}{operator $!=$}{\param{const char* }{value}}
+\constfunc{bool}{operator $!=$}{\param{const wxChar* }{value}}
 
-\constfunc{bool}{operator $!=$}{\param{char }{value}}
+\constfunc{bool}{operator $!=$}{\param{wxChar }{value}}
 
 \constfunc{bool}{operator $!=$}{\param{const long }{value}}
 
@@ -453,11 +451,11 @@ Returns the value at {\it idx} (zero-based).
 Returns a reference to the value at {\it idx} (zero-based). This can be used
 to change the value at this index.
 
-\membersection{wxVariant::operator char}\label{wxvariantchar}
+\membersection{wxVariant::operator wxChar}\label{wxvariantchar}
 
-\constfunc{char}{operator char}{\void}
+\constfunc{char}{operator wxChar}{\void}
 
-Operator for implicit conversion to a char, using \helpref{wxVariant::GetChar}{wxvariantgetchar}.
+Operator for implicit conversion to a wxChar, using \helpref{wxVariant::GetChar}{wxvariantgetchar}.
 
 \membersection{wxVariant::operator double}\label{wxvariantdouble}
 
@@ -586,3 +584,4 @@ the data is of this type (the check is done during the run-time) or
 
 \helpref{RTTI overview}{runtimeclassoverview}\\
 \helpref{wxDynamicCast}{wxdynamiccast}
+