X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eb753b56c4b01bc5a00ae19b48c0d7ea229ddf44..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/variant.tex?ds=sidebyside diff --git a/docs/latex/wx/variant.tex b/docs/latex/wx/variant.tex index f265034be5..6394598e1d 100644 --- a/docs/latex/wx/variant.tex +++ b/docs/latex/wx/variant.tex @@ -34,12 +34,12 @@ 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. 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 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: +Note that as of wxWidgets 2.7.1, wxVariant is \helpref{reference counted}{trefcount}. +Additionally, the convenience 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 modifying +either wxVariant or the class to be stored by wxVariant. Since assignment operators +cannot be declared outside the class, the shift left operators are used like this: \begin{verbatim} // in the header file @@ -72,6 +72,10 @@ IMPLEMENT_VARIANT_OBJECT(wxIcon) 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} @@ -80,6 +84,10 @@ IMPLEMENT_VARIANT_OBJECT(wxBitmap) +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxVariantData}{wxvariantdata} @@ -94,7 +102,7 @@ Default constructor. \func{}{wxVariant}{\param{const wxVariant\& }{variant}} -Copy constructor. +Copy constructor, uses \helpref{reference counting}{trefcount}. \func{}{wxVariant}{\param{const wxChar*}{ value}, \param{const wxString\& }{name = ``"}} @@ -119,7 +127,7 @@ Construction from a boolean 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 @@ -165,6 +173,7 @@ Destructor. Note that destructor is protected, so wxVariantData cannot usually be deleted. Instead, \helpref{DecRef}{wxvariantdatadecref} should be called. +See \helpref{reference-counted object destruction}{refcountdestruct} for more info. \membersection{wxVariant::Append}\label{wxvariantappend} @@ -255,6 +264,13 @@ Returns the date 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} @@ -277,7 +293,7 @@ Gets the string value. \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). @@ -370,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{const wxList\& }{value}} +\func{void}{operator $=$}{\param{const wxVariantList\& }{value}} \func{void}{operator $=$}{\param{const wxDateTime\& }{value}} @@ -382,7 +398,7 @@ Sets the internal variant data, deleting the existing data if there is any. \func{void}{operator $=$}{\param{const TIMESTAMP\_STRUCT* }{value}} -Assignment operators. +Assignment operators, using \helpref{reference counting}{trefcount} when possible. \membersection{wxVariant::operator $==$}\label{wxvarianteq} @@ -404,7 +420,7 @@ Assignment operators. \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}} @@ -432,7 +448,7 @@ Equality test operators. \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}} @@ -485,13 +501,18 @@ Operator for implicit conversion to a pointer to a void, using \helpref{wxVarian Operator for implicit conversion to a pointer to a \helpref{wxDateTime}{wxdatetime}, using \helpref{wxVariant::GetDateTime}{wxvariantgetdatetime}. + + +%% wxVariantData + + \section{\class{wxVariantData}}\label{wxvariantdata} -The {\bf wxVariantData} is used to implement a new type for wxVariant. Derive from wxVariantData, -and override the pure virtual functions. +The {\bf wxVariantData} class is used to implement a new type for \helpref{wxVariant}{wxvariant}. +Derive from wxVariantData, and override the pure virtual functions. -wxVariantData is reference counted, but you don't normally have to care about this, as -wxVariant manages the count automatically. However, incase your application needs to take +wxVariantData is \helpref{reference counted}{refcount}, but you don't normally have to care about this, +as wxVariant manages the count automatically. However, in case your application needs to take ownership of wxVariantData, be aware that the object is created with reference count of 1, and passing it to wxVariant will not increase this. In other words, \helpref{IncRef}{wxvariantdataincref} needs to be called only if you both take ownership of wxVariantData and pass it to a wxVariant. @@ -499,14 +520,14 @@ 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. -\wxheading{Derived from} - -\helpref{wxObject}{wxobject} - \wxheading{Include files} +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxVariant}{wxvariant} @@ -527,7 +548,9 @@ Decreases reference count. If the count reaches zero, the object is automatically deleted. Note that destructor of wxVariantData is protected, so delete -cannot be used as normal. Instead, DecRef should be called. +cannot be used as normal. Instead, \helpref{DecRef}{wxvariantdatadecref} should be called. + + \membersection{wxVariantData::Eq}\label{wxvariantdataeq} @@ -584,3 +607,4 @@ the data is of this type (the check is done during the run-time) or \helpref{RTTI overview}{runtimeclassoverview}\\ \helpref{wxDynamicCast}{wxdynamiccast} +