/////////////////////////////////////////////////////////////////////////////
// Name: variant.h
-// Purpose: documentation for wxVariant class
+// Purpose: interface of wxVariant
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxVariant
@wxheader{variant.h}
-
+
The @b 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, wxChar, double, long,
string,
- string list, time, date, void pointer, list of strings, and list of variants.
+ 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 wxVariantData and using the wxVariantData form of
the wxVariant constructor or assignment operator to assign this data to a
wxVariantData
object, unlike the case for basic data types where convenience functions such as
wxVariant::GetLong can be used.
-
+
Pointers to any 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 wxVariant::GetType) and to perform
+ type name (returned by wxVariant::GetType) and to perform
type-safety checks at runtime.
-
+
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.
-
+
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 @ref overview_trefcount
- "reference counted".
- Additionally, the convenience macros @b DECLARE_VARIANT_OBJECT and
- @b IMPLEMENT_VARIANT_OBJECT were added so that adding (limited) support
+ "reference counted".
+ Additionally, the convenience macros @b DECLARE_VARIANT_OBJECT and
+ @b IMPLEMENT_VARIANT_OBJECT were added so that adding (limited) support
for conversion to and from wxVariant can be very easily implemented without
- modifying
+ modifying
either wxVariant or the class to be stored by wxVariant. Since assignment
- operators
+ operators
cannot be declared outside the class, the shift left operators are used like
this:
-
+
@code
// in the header file
DECLARE_VARIANT_OBJECT(MyClass)
-
+
// in the implementation file
IMPLEMENT_VARIANT_OBJECT(MyClass)
-
+
// in the user code
wxVariant variant;
MyClass value;
variant value;
-
+
// or
value variant;
@endcode
-
+
For this to work, MyClass must derive from wxObject, implement
the @ref overview_runtimeclassoverview "wxWidgets RTTI system"
and support the assignment operator and equality operator for itself. Ideally,
can be most easily implemented using the reference counting support offered by
wxObject itself. By default, wxWidgets already implements
the shift operator conversion for a few of its drawing related classes:
-
+
@code
IMPLEMENT_VARIANT_OBJECT(wxColour)
IMPLEMENT_VARIANT_OBJECT(wxImage)
IMPLEMENT_VARIANT_OBJECT(wxIcon)
IMPLEMENT_VARIANT_OBJECT(wxBitmap)
@endcode
-
+
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. Also, wxVariantData now
supports the Clone function for implementing the wxVariant::Unshare function.
Clone is implemented automatically by IMPLEMENT_VARIANT_OBJECT.
-
+
Since wxVariantData no longer derives from wxObject, any code that tests the
type
of the data using wxDynamicCast will require adjustment. You can use the macro
wxDynamicCastVariantData with the same arguments as wxDynamicCast, to use C++
RTTI
type information instead of wxWidgets RTTI.
-
+
@library{wxbase}
@category{data}
-
- @seealso
- wxVariantData
+
+ @see wxVariantData
*/
class wxVariant : public wxObject
{
wxDateTime value.
*/
wxVariant();
- wxVariant(const wxVariant& variant);
- wxVariant(const wxChar* value, const wxString& name = "");
- wxVariant(const wxString& value, const wxString& name = "");
- wxVariant(wxChar value, const wxString& name = "");
- wxVariant(long value, const wxString& name = "");
- wxVariant(bool value, const wxString& name = "");
- wxVariant(double value, const wxString& name = "");
- wxVariant(const wxVariantList& value,
- const wxString& name = "");
- wxVariant(void* value, const wxString& name = "");
- wxVariant(wxObject* value, const wxString& name = "");
- wxVariant(wxVariantData* data, const wxString& name = "");
- wxVariant(wxDateTime& val, const wxString& name = "");
- wxVariant(wxArrayString& val, const wxString& name = "");
- wxVariant(DATE_STRUCT* val, const wxString& name = "");
- wxVariant(TIME_STRUCT* val, const wxString& name = "");
- wxVariant(TIMESTAMP_STRUCT* val, const wxString& name = "");
+ wxVariant(const wxVariant& variant);
+ wxVariant(const wxChar* value, const wxString& name = "");
+ wxVariant(const wxString& value, const wxString& name = "");
+ wxVariant(wxChar value, const wxString& name = "");
+ wxVariant(long value, const wxString& name = "");
+ wxVariant(bool value, const wxString& name = "");
+ wxVariant(double value, const wxString& name = "");
+ wxVariant(const wxVariantList& value,
+ const wxString& name = "");
+ wxVariant(void* value, const wxString& name = "");
+ wxVariant(wxObject* value, const wxString& name = "");
+ wxVariant(wxVariantData* data, const wxString& name = "");
+ wxVariant(wxDateTime& val, const wxString& name = "");
+ wxVariant(wxArrayString& val, const wxString& name = "");
+ wxVariant(DATE_STRUCT* val, const wxString& name = "");
+ wxVariant(TIME_STRUCT* val, const wxString& name = "");
+ wxVariant(TIMESTAMP_STRUCT* val, const wxString& name = "");
//@}
/**
Destructor.
-
Note that destructor is protected, so wxVariantData cannot usually
be deleted. Instead, wxVariantData::DecRef should be called.
See @ref overview_refcountdestruct "reference-counted object destruction" for
//@{
/**
- Retrieves and converts the value of this variant to the type that @e value is.
+ Retrieves and converts the value of this variant to the type that @a value is.
*/
- bool Convert(long* value);
- bool Convert(bool* value);
- bool Convert(double* value);
- bool Convert(wxString* value);
- bool Convert(wxChar* value);
- bool Convert(wxDateTime* value);
+ bool Convert(long* value) const;
+ const bool Convert(bool* value) const;
+ const bool Convert(double* value) const;
+ const bool Convert(wxString* value) const;
+ const bool Convert(wxChar* value) const;
+ const bool Convert(wxDateTime* value) const;
//@}
/**
- Deletes the zero-based @e item from the list.
+ Deletes the zero-based @a item from the list.
*/
bool Delete(size_t item);
/**
Returns the string array value.
*/
- wxArrayString GetArrayString();
+ wxArrayString GetArrayString() const;
/**
Returns the boolean value.
*/
- bool GetBool();
+ bool GetBool() const;
/**
Returns the character value.
*/
- wxChar GetChar();
+ wxChar GetChar() const;
/**
Returns the number of elements in the list.
*/
- size_t GetCount();
+ size_t GetCount() const;
/**
Returns a pointer to the internal variant data. To take ownership
method. When you stop using it, wxVariantData::DecRef
must be likewise called.
*/
- wxVariantData* GetData();
+ wxVariantData* GetData() const;
/**
Returns the date value.
*/
- wxDateTime GetDateTime();
+ wxDateTime GetDateTime() const;
/**
Returns the floating point value.
*/
- double GetDouble();
+ double GetDouble() const;
/**
Returns a reference to the wxVariantList class used by
wxVariant if this wxVariant is currently a list of variants.
*/
- wxVariantList GetList();
+ wxVariantList GetList() const;
/**
Returns the integer value.
*/
- long GetLong();
+ long GetLong() const;
/**
Returns a constant reference to the variant name.
*/
- const wxString GetName();
+ const wxString GetName() const;
/**
Gets the string value.
*/
- wxString GetString();
+ wxString GetString() const;
/**
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).
*/
- wxString GetType();
+ wxString GetType() const;
/**
Gets the void pointer value.
*/
- void* GetVoidPtr();
+ void* GetVoidPtr() const;
/**
Gets the wxObject pointer value.
*/
- wxObject* GetWxObjectPtr();
+ wxObject* GetWxObjectPtr() const;
/**
Inserts a value at the front of the list.
Returns @true if there is no data associated with this variant, @false if there
is data.
*/
- bool IsNull();
+ bool IsNull() const;
/**
- Returns @true if @e type matches the type of the variant, @false otherwise.
+ Returns @true if @a type matches the type of the variant, @false otherwise.
*/
- bool IsType(const wxString& type);
+ bool IsType(const wxString& type) const;
/**
Returns @true if the data is derived from the class described by @e type, @false
otherwise.
*/
- bool IsValueKindOf(const wxClassInfo* type type);
+ bool IsValueKindOf(const wxClassInfo* type type) const;
/**
Makes the variant null by deleting the internal data.
/**
Makes a string representation of the variant value (for any type).
*/
- wxString MakeString();
+ wxString MakeString() const;
/**
- Returns @true if @e value matches an element in the list.
+ Returns @true if @a value matches an element in the list.
*/
- bool Member(const wxVariant& value);
+ bool Member(const wxVariant& value) const;
/**
Makes an empty list. This differs from a null variant which has no data; a null
/**
Inequality test operators.
*/
- bool operator !=(const wxVariant& value);
- bool operator !=(const wxString& value);
- bool operator !=(const wxChar* value);
- bool operator !=(wxChar value);
- bool operator !=(const long value);
- bool operator !=(const bool value);
- bool operator !=(const double value);
- bool operator !=(void* value);
- bool operator !=(wxObject* value);
- bool operator !=(const wxVariantList& value);
- bool operator !=(const wxArrayString& value);
- bool operator !=(const wxDateTime& value);
+ bool operator !=(const wxVariant& value) const;
+ const bool operator !=(const wxString& value) const;
+ const bool operator !=(const wxChar* value) const;
+ const bool operator !=(wxChar value) const;
+ const bool operator !=(const long value) const;
+ const bool operator !=(const bool value) const;
+ const bool operator !=(const double value) const;
+ const bool operator !=(void* value) const;
+ const bool operator !=(wxObject* value) const;
+ const bool operator !=(const wxVariantList& value) const;
+ const bool operator !=(const wxArrayString& value) const;
+ const bool operator !=(const wxDateTime& value) const;
//@}
//@{
possible.
*/
void operator =(const wxVariant& value);
- void operator =(wxVariantData* value);
- void operator =(const wxString& value);
- void operator =(const wxChar* value);
- void operator =(wxChar value);
- void operator =(const long value);
- void operator =(const bool value);
- void operator =(const double value);
- void operator =(void* value);
- void operator =(wxObject* value);
- void operator =(const wxVariantList& value);
- void operator =(const wxDateTime& value);
- void operator =(const wxArrayString& value);
- void operator =(const DATE_STRUCT* value);
- void operator =(const TIME_STRUCT* value);
- void operator =(const TIMESTAMP_STRUCT* value);
+ void operator =(wxVariantData* value);
+ void operator =(const wxString& value);
+ void operator =(const wxChar* value);
+ void operator =(wxChar value);
+ void operator =(const long value);
+ void operator =(const bool value);
+ void operator =(const double value);
+ void operator =(void* value);
+ void operator =(wxObject* value);
+ void operator =(const wxVariantList& value);
+ void operator =(const wxDateTime& value);
+ void operator =(const wxArrayString& value);
+ void operator =(const DATE_STRUCT* value);
+ void operator =(const TIME_STRUCT* value);
+ void operator =(const TIMESTAMP_STRUCT* value);
//@}
//@{
/**
Equality test operators.
*/
- bool operator ==(const wxVariant& value);
- bool operator ==(const wxString& value);
- bool operator ==(const wxChar* value);
- bool operator ==(wxChar value);
- bool operator ==(const long value);
- bool operator ==(const bool value);
- bool operator ==(const double value);
- bool operator ==(void* value);
- bool operator ==(wxObject* value);
- bool operator ==(const wxVariantList& value);
- bool operator ==(const wxArrayString& value);
- bool operator ==(const wxDateTime& value);
+ bool operator ==(const wxVariant& value) const;
+ const bool operator ==(const wxString& value) const;
+ const bool operator ==(const wxChar* value) const;
+ const bool operator ==(wxChar value) const;
+ const bool operator ==(const long value) const;
+ const bool operator ==(const bool value) const;
+ const bool operator ==(const double value) const;
+ const bool operator ==(void* value) const;
+ const bool operator ==(wxObject* value) const;
+ const bool operator ==(const wxVariantList& value) const;
+ const bool operator ==(const wxArrayString& value) const;
+ const bool operator ==(const wxDateTime& value) const;
//@}
//@{
/**
- Returns a reference to the value at @e idx (zero-based). This can be used
+ Returns a reference to the value at @a idx (zero-based). This can be used
to change the value at this index.
*/
wxVariant operator [](size_t idx);
- wxVariant operator [](size_t idx);
+ const wxVariant& operator [](size_t idx);
//@}
//@{
/**
Operator for implicit conversion to a long, using GetLong().
*/
- double operator double();
- long operator long();
+ double operator double() const;
+ const long operator long() const;
//@}
/**
Operator for implicit conversion to a pointer to a void, using GetVoidPtr().
*/
- void* operator void*();
+ void* operator void*() const;
/**
Operator for implicit conversion to a wxChar, using GetChar().
*/
- char operator wxChar();
+ char operator wxChar() const;
/**
Operator for implicit conversion to a pointer to a wxDateTime, using
GetDateTime().
*/
- void* operator wxDateTime();
+ void* operator wxDateTime() const;
/**
Operator for implicit conversion to a string, using MakeString().
*/
- wxString operator wxString();
+ wxString operator wxString() const;
};
+
/**
@class wxVariantData
@wxheader{variant.h}
-
- The @b wxVariantData class is used to implement a new type for wxVariant.
+
+ The @b wxVariantData class is used to implement a new type for wxVariant.
Derive from wxVariantData, and override the pure virtual functions.
-
+
wxVariantData is @ref overview_refcount "reference counted", but you don't
- normally have to care about this,
+ 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
a wxVariantData
instance. Instead, wxVariantData::DecRef will delete the object automatically
when the reference count reaches zero.
-
+
@library{wxbase}
@category{FIXME}
-
- @seealso
- wxVariant
+
+ @see wxVariant
*/
-class wxVariantData
+class wxVariantData
{
public:
/**
Implement Clone if you wish wxVariant::Unshare to work
for your data. This function is implemented for all built-in data types.
*/
- wxVariantData* Clone();
+ wxVariantData* Clone() const;
/**
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.
*/
/**
Returns @true if this object is equal to @e data.
*/
-#define bool Eq(wxVariantData& data) /* implementation is private */
+ bool Eq(wxVariantData& data) const;
/**
Returns the string type of the data.
*/
- wxString GetType();
+ wxString GetType() const;
/**
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.
*/
- wxClassInfo* GetValueClassInfo();
+ wxClassInfo* GetValueClassInfo() const;
/**
Increases reference count. Note that initially wxVariantData has reference
//@{
/**
- Reads the data from @e stream or @e string.
+ Reads the data from @a stream or @e string.
*/
bool Read(ostream& stream);
- bool Read(wxString& string);
+ bool Read(wxString& string);
//@}
//@{
/**
- Writes the data to @e stream or @e string.
+ Writes the data to @a stream or @e string.
*/
- bool Write(ostream& stream);
- bool Write(wxString& string);
+ bool Write(ostream& stream) const;
+ const bool Write(wxString& string) const;
//@}
/**
the data is of this type (the check is done during the run-time) or
@NULL otherwise.
*/
- classname * wxGetVariantCast();
+ classname* wxGetVariantCast();
};
+
projects / wxWidgets.git / blobdiff