[wxWidgets.git] / include / wx / variant.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/variant.h
// Purpose:     wxVariant class, container for any type
// Author:      Julian Smart
// Modified by:
// Created:     10/09/98
// RCS-ID:      $Id$
// Copyright:   (c) Julian Smart
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_VARIANT_H_
#define _WX_VARIANT_H_

#include "wx/defs.h"

#if wxUSE_VARIANT

#include "wx/object.h"
#include "wx/string.h"
#include "wx/arrstr.h"
#include "wx/list.h"

#if wxUSE_DATETIME
    #include "wx/datetime.h"
#endif // wxUSE_DATETIME

#if wxUSE_ODBC
    #include "wx/db.h"  // will #include sqltypes.h
#endif //ODBC

#include "wx/iosfwrap.h"

/*
 * wxVariantData stores the actual data in a wxVariant object,
 * to allow it to store any type of data.
 * Derive from this to provide custom data handling.
 *
 * NB: To prevent addition of extra vtbl pointer to wxVariantData,
 *     we don't multiple-inherit from wxObjectRefData. Instead,
 *     we simply replicate the wxObject ref-counting scheme.
 *
 * NB: When you construct a wxVariantData, it will have refcount
 *     of one. Refcount will not be further increased when
 *     it is passed to wxVariant. This simulates old common
 *     scenario where wxVariant took ownership of wxVariantData
 *     passed to it.
 *     If you create wxVariantData for other reasons than passing
 *     it to wxVariant, technically you are not required to call
 *     DecRef() before deleting it.
 *
 * TODO: in order to replace wxPropertyValue, we would need
 * to consider adding constructors that take pointers to C++ variables,
 * or removing that functionality from the wxProperty library.
 * Essentially wxPropertyValue takes on some of the wxValidator functionality
 * by storing pointers and not just actual values, allowing update of C++ data
 * to be handled automatically. Perhaps there's another way of doing this without
 * overloading wxVariant with unnecessary functionality.
 */

class WXDLLIMPEXP_BASE wxVariantData: public wxObject
{
    friend class wxVariant;
public:
    wxVariantData()
        : wxObject(), m_count(1)
    { }

    // Override these to provide common functionality
    virtual bool Eq(wxVariantData& data) const = 0;

#if wxUSE_STD_IOSTREAM
    virtual bool Write(wxSTD ostream& WXUNUSED(str)) const { return false; }
#endif
    virtual bool Write(wxString& WXUNUSED(str)) const { return false; }
#if wxUSE_STD_IOSTREAM
    virtual bool Read(wxSTD istream& WXUNUSED(str)) { return false; }
#endif
    virtual bool Read(wxString& WXUNUSED(str)) { return false; }
    // What type is it? Return a string name.
    virtual wxString GetType() const = 0;
    // If it based on wxObject return the ClassInfo.
    virtual wxClassInfo* GetValueClassInfo() { return NULL; }

    void IncRef() { m_count++; }
    void DecRef()
    {
        if ( --m_count == 0 )
            delete this;
    }

    int GetRefCount() const { return m_count; }

protected:
    // Protected dtor should make some incompatible code
    // break more louder. That is, they should do data->DecRef()
    // instead of delete data.
    virtual ~wxVariantData() { }

private:
    int     m_count;

private:
    DECLARE_ABSTRACT_CLASS(wxVariantData)
};

/*
 * wxVariant can store any kind of data, but has some basic types
 * built in.
 */

class WXDLLIMPEXP_BASE wxVariant: public wxObject
{
public:
    wxVariant();

    wxVariant(const wxVariant& variant);
    wxVariant(wxVariantData* data, const wxString& name = wxEmptyString);
    virtual ~wxVariant();

    // generic assignment
    void operator= (const wxVariant& variant);

    // Assignment using data, e.g.
    // myVariant = new wxStringVariantData("hello");
    void operator= (wxVariantData* variantData);

    bool operator== (const wxVariant& variant) const;
    bool operator!= (const wxVariant& variant) const;

    // Sets/gets name
    inline void SetName(const wxString& name) { m_name = name; }
    inline const wxString& GetName() const { return m_name; }

    // Tests whether there is data
    bool IsNull() const;

    // For compatibility with wxWidgets <= 2.6, this doesn't increase
    // reference count.
    wxVariantData* GetData() const { return m_data; }
    void SetData(wxVariantData* data) ;

    // make a 'clone' of the object
    void Ref(const wxVariant& clone);

    // destroy a reference
    void UnRef();

    // Make NULL (i.e. delete the data)
    void MakeNull();

    // Delete data and name
    void Clear();

    // Returns a string representing the type of the variant,
    // e.g. "string", "bool", "stringlist", "list", "double", "long"
    wxString GetType() const;

    bool IsType(const wxString& type) const;
    bool IsValueKindOf(const wxClassInfo* type) const;

    // write contents to a string (e.g. for debugging)
    wxString MakeString() const;

    // double
    wxVariant(double val, const wxString& name = wxEmptyString);
    bool operator== (double value) const;
    bool operator!= (double value) const;
    void operator= (double value) ;
    inline operator double () const {  return GetDouble(); }
    inline double GetReal() const { return GetDouble(); }
    double GetDouble() const;

    // long
    wxVariant(long val, const wxString& name = wxEmptyString);
    wxVariant(int val, const wxString& name = wxEmptyString);
    wxVariant(short val, const wxString& name = wxEmptyString);
    bool operator== (long value) const;
    bool operator!= (long value) const;
    void operator= (long value) ;
    inline operator long () const {  return GetLong(); }
    inline long GetInteger() const { return GetLong(); }
    long GetLong() const;

    // bool
#ifdef HAVE_BOOL
    wxVariant(bool val, const wxString& name = wxEmptyString);
    bool operator== (bool value) const;
    bool operator!= (bool value) const;
    void operator= (bool value) ;
    inline operator bool () const {  return GetBool(); }
    bool GetBool() const ;
#endif

    // wxDateTime
#if wxUSE_DATETIME
    wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString);
#if wxUSE_ODBC
    wxVariant(const DATE_STRUCT* valptr, const wxString& name = wxEmptyString);
    wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString);
    wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString);
#endif
    bool operator== (const wxDateTime& value) const;
    bool operator!= (const wxDateTime& value) const;
    void operator= (const wxDateTime& value) ;
#if wxUSE_ODBC
    void operator= (const DATE_STRUCT* value) ;
    void operator= (const TIME_STRUCT* value) ;
    void operator= (const TIMESTAMP_STRUCT* value) ;
#endif
    inline operator wxDateTime () const { return GetDateTime(); }
    wxDateTime GetDateTime() const;
#endif

    // wxString
    wxVariant(const wxString& val, const wxString& name = wxEmptyString);
    wxVariant(const wxChar* val, const wxString& name = wxEmptyString); // Necessary or VC++ assumes bool!
    bool operator== (const wxString& value) const;
    bool operator!= (const wxString& value) const;
    void operator= (const wxString& value) ;
    void operator= (const wxChar* value) ; // Necessary or VC++ assumes bool!
    inline operator wxString () const {  return MakeString(); }
    wxString GetString() const;

    // wxChar
    wxVariant(wxChar val, const wxString& name = wxEmptyString);
    bool operator== (wxChar value) const;
    bool operator!= (wxChar value) const;
    void operator= (wxChar value) ;
    inline operator wxChar () const { return GetChar(); }
    wxChar GetChar() const ;

    // wxArrayString
    wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString);
    bool operator== (const wxArrayString& value) const;
    bool operator!= (const wxArrayString& value) const;
    void operator= (const wxArrayString& value);
    inline operator wxArrayString () const { return GetArrayString(); }
    wxArrayString GetArrayString() const;

    // void*
    wxVariant(void* ptr, const wxString& name = wxEmptyString);
    bool operator== (void* value) const;
    bool operator!= (void* value) const;
    void operator= (void* value);
    inline operator void* () const {  return GetVoidPtr(); }
    void* GetVoidPtr() const;

    // wxObject*
    wxVariant(wxObject* ptr, const wxString& name = wxEmptyString);
    bool operator== (wxObject* value) const;
    bool operator!= (wxObject* value) const;
    void operator= (wxObject* value);
    wxObject* GetWxObjectPtr() const;


#if WXWIN_COMPATIBILITY_2_4
    wxDEPRECATED( wxVariant(const wxStringList& val, const wxString& name = wxEmptyString) );
    wxDEPRECATED( bool operator== (const wxStringList& value) const );
    wxDEPRECATED( bool operator!= (const wxStringList& value) const );
    wxDEPRECATED( void operator= (const wxStringList& value) );
    wxDEPRECATED( wxStringList& GetStringList() const );
#endif

    // ------------------------------
    // list operations
    // ------------------------------

    wxVariant(const wxList& val, const wxString& name = wxEmptyString); // List of variants
    bool operator== (const wxList& value) const;
    bool operator!= (const wxList& value) const;
    void operator= (const wxList& value) ;
    // Treat a list variant as an array
    wxVariant operator[] (size_t idx) const;
    wxVariant& operator[] (size_t idx) ;
    wxList& GetList() const ;

    // Return the number of elements in a list
    size_t GetCount() const;

    // Make empty list
    void NullList();

    // Append to list
    void Append(const wxVariant& value);

    // Insert at front of list
    void Insert(const wxVariant& value);

    // Returns true if the variant is a member of the list
    bool Member(const wxVariant& value) const;

    // Deletes the nth element of the list
    bool Delete(size_t item);

    // Clear list
    void ClearList();

public:
    // Type conversion
    bool Convert(long* value) const;
    bool Convert(bool* value) const;
    bool Convert(double* value) const;
    bool Convert(wxString* value) const;
    bool Convert(wxChar* value) const;
#if wxUSE_DATETIME
    bool Convert(wxDateTime* value) const;
#endif // wxUSE_DATETIME

// Attributes
protected:
    wxVariantData*  m_data;
    wxString        m_name;

private:
    DECLARE_DYNAMIC_CLASS(wxVariant)
};

/* Fake macro parameter value */
#ifdef EMPTY_PARAMETER_VALUE
    #undef EMPTY_PARAMETER_VALUE
#endif
#define EMPTY_PARAMETER_VALUE

#define DECLARE_VARIANT_OBJECT(classname) \
    DECLARE_VARIANT_OBJECT_EXPORTED(classname,EMPTY_PARAMETER_VALUE)

#define DECLARE_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
expdecl classname& operator << ( classname &object, const wxVariant &variant ); \
expdecl wxVariant& operator << ( wxVariant &variant, const classname &object );

#define IMPLEMENT_VARIANT_OBJECT(classname) \
    IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,EMPTY_PARAMETER_VALUE)

#define IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
class classname##VariantData: public wxVariantData \
{ \
public:\
    classname##VariantData() {} \
    classname##VariantData( const classname &value ) { m_value = value; } \
\
    classname &GetValue() { return m_value; } \
\
    virtual bool Eq(wxVariantData& data) const; \
\
    virtual wxString GetType() const; \
    virtual wxClassInfo* GetValueClassInfo(); \
\
protected:\
    classname m_value; \
\
private: \
    DECLARE_CLASS(classname##VariantData) \
};\
\
IMPLEMENT_CLASS(classname##VariantData, wxVariantData)\
\
wxString classname##VariantData::GetType() const\
{\
    return m_value.GetClassInfo()->GetClassName();\
}\
\
wxClassInfo* classname##VariantData::GetValueClassInfo()\
{\
    return m_value.GetClassInfo();\
}\
\
expdecl classname& operator << ( classname &value, const wxVariant &variant )\
{\
    wxASSERT( wxIsKindOf( variant.GetData(), classname##VariantData ) );\
    \
    classname##VariantData *data = (classname##VariantData*) variant.GetData();\
    value = data->GetValue();\
    return value;\
}\
\
expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\
{\
    classname##VariantData *data = new classname##VariantData( value );\
    variant.SetData( data );\
    return variant;\
}

// implements a wxVariantData-derived class using for the Eq() method the operator==
// which must have been provided by "classname"
#define IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
\
bool classname##VariantData::Eq(wxVariantData& data) const \
{\
    wxASSERT( wxIsKindOf((&data), classname##VariantData) );\
\
    classname##VariantData & otherData = (classname##VariantData &) data;\
\
    return otherData.m_value == m_value;\
}\


// implements a wxVariantData-derived class using for the Eq() method a shallow
// comparison (through wxObject::IsRefTo function)
#define IMPLEMENT_VARIANT_OBJECT_EXPORTED_SHALLOWCMP(classname,expdecl) \
IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
\
bool classname##VariantData::Eq(wxVariantData& data) const \
{\
    wxASSERT( wxIsKindOf((&data), classname##VariantData) );\
\
    classname##VariantData & otherData = (classname##VariantData &) data;\
\
    return (otherData.m_value.IsRefTo(&m_value));\
}\


// Since we want type safety wxVariant we need to fetch and dynamic_cast
// in a seemingly safe way so the compiler can check, so we define
// a dynamic_cast /wxDynamicCast analogue.

#define wxGetVariantCast(var,classname) \
    ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
                  var.GetWxObjectPtr() : NULL));

extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;

#endif // wxUSE_VARIANT

#endif // _WX_VARIANT_H_
Commit	Line	Data
8cb50e4b	1	/////////////////////////////////////////////////////////////////////////////
43f06cfd	2	// Name: wx/variant.h
8cb50e4b JS	3	// Purpose: wxVariant class, container for any type
	4	// Author: Julian Smart
	5	// Modified by:
	6	// Created: 10/09/98
	7	// RCS-ID: $Id$
99d80019	8	// Copyright: (c) Julian Smart
65571936	9	// Licence: wxWindows licence
8cb50e4b JS	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_VARIANT_H_
	13	#define _WX_VARIANT_H_
	14
8cb50e4b	15	#include "wx/defs.h"
d5dc103f VZ	16
	17	#if wxUSE_VARIANT
	18
8cb50e4b JS	19	#include "wx/object.h"
8cb50e4b JS	20	#include "wx/string.h"
4c3ebca9	21	#include "wx/arrstr.h"
8cb50e4b JS	22	#include "wx/list.h"
8cb50e4b JS	23
e2b87f38 VZ	24	#if wxUSE_DATETIME
	25	#include "wx/datetime.h"
	26	#endif // wxUSE_DATETIME
edca7a82 GT	27
	28	#if wxUSE_ODBC
	29	#include "wx/db.h" // will #include sqltypes.h
	30	#endif //ODBC
	31
65f19af1	32	#include "wx/iosfwrap.h"
8cb50e4b JS	33
	34	/*
	35	* wxVariantData stores the actual data in a wxVariant object,
	36	* to allow it to store any type of data.
	37	* Derive from this to provide custom data handling.
	38	*
2562c823 RR	39	* NB: To prevent addition of extra vtbl pointer to wxVariantData,
	40	* we don't multiple-inherit from wxObjectRefData. Instead,
	41	* we simply replicate the wxObject ref-counting scheme.
	42	*
	43	* NB: When you construct a wxVariantData, it will have refcount
	44	* of one. Refcount will not be further increased when
	45	* it is passed to wxVariant. This simulates old common
	46	* scenario where wxVariant took ownership of wxVariantData
	47	* passed to it.
	48	* If you create wxVariantData for other reasons than passing
	49	* it to wxVariant, technically you are not required to call
	50	* DecRef() before deleting it.
	51	*
8cb50e4b JS	52	* TODO: in order to replace wxPropertyValue, we would need
	53	* to consider adding constructors that take pointers to C++ variables,
	54	* or removing that functionality from the wxProperty library.
	55	* Essentially wxPropertyValue takes on some of the wxValidator functionality
	56	* by storing pointers and not just actual values, allowing update of C++ data
	57	* to be handled automatically. Perhaps there's another way of doing this without
	58	* overloading wxVariant with unnecessary functionality.
	59	*/
	60
bddd7a8d	61	class WXDLLIMPEXP_BASE wxVariantData: public wxObject
8cb50e4b	62	{
2562c823	63	friend class wxVariant;
8cb50e4b	64	public:
2562c823 RR	65	wxVariantData()
	66	: wxObject(), m_count(1)
	67	{ }
8cb50e4b	68
2562c823	69	// Override these to provide common functionality
8cb50e4b	70	virtual bool Eq(wxVariantData& data) const = 0;
07502d73	71
38830220	72	#if wxUSE_STD_IOSTREAM
07502d73	73	virtual bool Write(wxSTD ostream& WXUNUSED(str)) const { return false; }
38830220	74	#endif
07502d73	75	virtual bool Write(wxString& WXUNUSED(str)) const { return false; }
38830220	76	#if wxUSE_STD_IOSTREAM
07502d73	77	virtual bool Read(wxSTD istream& WXUNUSED(str)) { return false; }
38830220	78	#endif
07502d73	79	virtual bool Read(wxString& WXUNUSED(str)) { return false; }
8cb50e4b JS	80	// What type is it? Return a string name.
8cb50e4b JS	81	virtual wxString GetType() const = 0;
cf6ae290 RG	82	// If it based on wxObject return the ClassInfo.
cf6ae290 RG	83	virtual wxClassInfo* GetValueClassInfo() { return NULL; }
2562c823 RR	84
	85	void IncRef() { m_count++; }
	86	void DecRef()
	87	{
	88	if ( --m_count == 0 )
	89	delete this;
	90	}
	91
	92	int GetRefCount() const { return m_count; }
	93
	94	protected:
	95	// Protected dtor should make some incompatible code
	96	// break more louder. That is, they should do data->DecRef()
	97	// instead of delete data.
	98	virtual ~wxVariantData() { }
	99
	100	private:
	101	int m_count;
07502d73	102
2562c823 RR	103	private:
2562c823 RR	104	DECLARE_ABSTRACT_CLASS(wxVariantData)
8cb50e4b JS	105	};
	106
	107	/*
	108	* wxVariant can store any kind of data, but has some basic types
	109	* built in.
8cb50e4b JS	110	*/
8cb50e4b JS	111
bddd7a8d	112	class WXDLLIMPEXP_BASE wxVariant: public wxObject
8cb50e4b	113	{
8cb50e4b	114	public:
8cb50e4b	115	wxVariant();
07502d73	116
8cb50e4b	117	wxVariant(const wxVariant& variant);
2562c823	118	wxVariant(wxVariantData* data, const wxString& name = wxEmptyString);
d3c7fc99	119	virtual ~wxVariant();
8cb50e4b	120
2562c823	121	// generic assignment
8cb50e4b JS	122	void operator= (const wxVariant& variant);
	123
	124	// Assignment using data, e.g.
	125	// myVariant = new wxStringVariantData("hello");
	126	void operator= (wxVariantData* variantData);
07502d73	127
8cb50e4b JS	128	bool operator== (const wxVariant& variant) const;
	129	bool operator!= (const wxVariant& variant) const;
	130
2562c823 RR	131	// Sets/gets name
	132	inline void SetName(const wxString& name) { m_name = name; }
	133	inline const wxString& GetName() const { return m_name; }
	134
	135	// Tests whether there is data
07502d73	136	bool IsNull() const;
2562c823 RR	137
	138	// For compatibility with wxWidgets <= 2.6, this doesn't increase
	139	// reference count.
	140	wxVariantData* GetData() const { return m_data; }
	141	void SetData(wxVariantData* data) ;
	142
	143	// make a 'clone' of the object
	144	void Ref(const wxVariant& clone);
	145
	146	// destroy a reference
	147	void UnRef();
	148
	149	// Make NULL (i.e. delete the data)
	150	void MakeNull();
07502d73	151
2562c823 RR	152	// Delete data and name
2562c823 RR	153	void Clear();
07502d73	154
2562c823 RR	155	// Returns a string representing the type of the variant,
	156	// e.g. "string", "bool", "stringlist", "list", "double", "long"
	157	wxString GetType() const;
	158
	159	bool IsType(const wxString& type) const;
	160	bool IsValueKindOf(const wxClassInfo* type) const;
	161
07502d73	162	// write contents to a string (e.g. for debugging)
2562c823	163	wxString MakeString() const;
07502d73	164
2562c823 RR	165	// double
2562c823 RR	166	wxVariant(double val, const wxString& name = wxEmptyString);
8cb50e4b JS	167	bool operator== (double value) const;
	168	bool operator!= (double value) const;
	169	void operator= (double value) ;
2562c823 RR	170	inline operator double () const { return GetDouble(); }
	171	inline double GetReal() const { return GetDouble(); }
	172	double GetDouble() const;
07502d73	173
2562c823 RR	174	// long
	175	wxVariant(long val, const wxString& name = wxEmptyString);
	176	wxVariant(int val, const wxString& name = wxEmptyString);
	177	wxVariant(short val, const wxString& name = wxEmptyString);
8cb50e4b JS	178	bool operator== (long value) const;
	179	bool operator!= (long value) const;
	180	void operator= (long value) ;
2562c823 RR	181	inline operator long () const { return GetLong(); }
	182	inline long GetInteger() const { return GetLong(); }
	183	long GetLong() const;
07502d73 WS	184
07502d73 WS	185	// bool
57493f9f	186	#ifdef HAVE_BOOL
2562c823	187	wxVariant(bool val, const wxString& name = wxEmptyString);
8cb50e4b JS	188	bool operator== (bool value) const;
	189	bool operator!= (bool value) const;
	190	void operator= (bool value) ;
2562c823 RR	191	inline operator bool () const { return GetBool(); }
	192	bool GetBool() const ;
	193	#endif
	194
	195	// wxDateTime
	196	#if wxUSE_DATETIME
07502d73	197	wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString);
2562c823 RR	198	#if wxUSE_ODBC
	199	wxVariant(const DATE_STRUCT* valptr, const wxString& name = wxEmptyString);
	200	wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString);
	201	wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString);
	202	#endif
	203	bool operator== (const wxDateTime& value) const;
	204	bool operator!= (const wxDateTime& value) const;
	205	void operator= (const wxDateTime& value) ;
	206	#if wxUSE_ODBC
	207	void operator= (const DATE_STRUCT* value) ;
	208	void operator= (const TIME_STRUCT* value) ;
	209	void operator= (const TIMESTAMP_STRUCT* value) ;
	210	#endif
	211	inline operator wxDateTime () const { return GetDateTime(); }
	212	wxDateTime GetDateTime() const;
57493f9f	213	#endif
2562c823 RR	214
	215	// wxString
	216	wxVariant(const wxString& val, const wxString& name = wxEmptyString);
	217	wxVariant(const wxChar* val, const wxString& name = wxEmptyString); // Necessary or VC++ assumes bool!
8cb50e4b JS	218	bool operator== (const wxString& value) const;
	219	bool operator!= (const wxString& value) const;
	220	void operator= (const wxString& value) ;
2ed57eb7	221	void operator= (const wxChar* value) ; // Necessary or VC++ assumes bool!
2562c823 RR	222	inline operator wxString () const { return MakeString(); }
	223	wxString GetString() const;
	224
71520754 RR	225	// wxChar
	226	wxVariant(wxChar val, const wxString& name = wxEmptyString);
	227	bool operator== (wxChar value) const;
	228	bool operator!= (wxChar value) const;
	229	void operator= (wxChar value) ;
	230	inline operator wxChar () const { return GetChar(); }
	231	wxChar GetChar() const ;
07502d73	232
2562c823 RR	233	// wxArrayString
	234	wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString);
	235	bool operator== (const wxArrayString& value) const;
	236	bool operator!= (const wxArrayString& value) const;
	237	void operator= (const wxArrayString& value);
	238	inline operator wxArrayString () const { return GetArrayString(); }
	239	wxArrayString GetArrayString() const;
	240
	241	// void*
	242	wxVariant(void* ptr, const wxString& name = wxEmptyString);
	243	bool operator== (void* value) const;
	244	bool operator!= (void* value) const;
	245	void operator= (void* value);
	246	inline operator void* () const { return GetVoidPtr(); }
	247	void* GetVoidPtr() const;
	248
	249	// wxObject*
	250	wxVariant(wxObject* ptr, const wxString& name = wxEmptyString);
	251	bool operator== (wxObject* value) const;
	252	bool operator!= (wxObject* value) const;
	253	void operator= (wxObject* value);
	254	wxObject* GetWxObjectPtr() const;
	255
	256
2c3a1064	257	#if WXWIN_COMPATIBILITY_2_4
2562c823	258	wxDEPRECATED( wxVariant(const wxStringList& val, const wxString& name = wxEmptyString) );
2c3a1064 RN	259	wxDEPRECATED( bool operator== (const wxStringList& value) const );
	260	wxDEPRECATED( bool operator!= (const wxStringList& value) const );
	261	wxDEPRECATED( void operator= (const wxStringList& value) );
2562c823	262	wxDEPRECATED( wxStringList& GetStringList() const );
2c3a1064	263	#endif
2562c823 RR	264
	265	// ------------------------------
	266	// list operations
	267	// ------------------------------
	268
	269	wxVariant(const wxList& val, const wxString& name = wxEmptyString); // List of variants
8cb50e4b JS	270	bool operator== (const wxList& value) const;
	271	bool operator!= (const wxList& value) const;
	272	void operator= (const wxList& value) ;
8cb50e4b JS	273	// Treat a list variant as an array
	274	wxVariant operator[] (size_t idx) const;
	275	wxVariant& operator[] (size_t idx) ;
2562c823	276	wxList& GetList() const ;
8cb50e4b JS	277
8cb50e4b JS	278	// Return the number of elements in a list
43f06cfd	279	size_t GetCount() const;
07502d73	280
8cb50e4b JS	281	// Make empty list
	282	void NullList();
	283
	284	// Append to list
	285	void Append(const wxVariant& value);
	286
	287	// Insert at front of list
	288	void Insert(const wxVariant& value);
	289
cab1a605	290	// Returns true if the variant is a member of the list
8cb50e4b JS	291	bool Member(const wxVariant& value) const;
	292
	293	// Deletes the nth element of the list
43f06cfd	294	bool Delete(size_t item);
8cb50e4b JS	295
	296	// Clear list
	297	void ClearList();
	298
9708db20	299	public:
2562c823	300	// Type conversion
8cb50e4b JS	301	bool Convert(long* value) const;
	302	bool Convert(bool* value) const;
	303	bool Convert(double* value) const;
	304	bool Convert(wxString* value) const;
38f82bf6	305	bool Convert(wxChar* value) const;
e2b87f38	306	#if wxUSE_DATETIME
edca7a82	307	bool Convert(wxDateTime* value) const;
e2b87f38	308	#endif // wxUSE_DATETIME
8cb50e4b JS	309
	310	// Attributes
	311	protected:
	312	wxVariantData* m_data;
a0a302dc	313	wxString m_name;
07502d73	314
2562c823 RR	315	private:
2562c823 RR	316	DECLARE_DYNAMIC_CLASS(wxVariant)
8cb50e4b JS	317	};
8cb50e4b JS	318
6f5d7825 RR	319	/* Fake macro parameter value */
	320	#ifdef EMPTY_PARAMETER_VALUE
	321	#undef EMPTY_PARAMETER_VALUE
	322	#endif
07502d73	323	#define EMPTY_PARAMETER_VALUE
3f90a399 RR	324
3f90a399 RR	325	#define DECLARE_VARIANT_OBJECT(classname) \
6f5d7825	326	DECLARE_VARIANT_OBJECT_EXPORTED(classname,EMPTY_PARAMETER_VALUE)
07502d73	327
6f5d7825	328	#define DECLARE_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
39a48551 VZ	329	expdecl classname& operator << ( classname &object, const wxVariant &variant ); \
39a48551 VZ	330	expdecl wxVariant& operator << ( wxVariant &variant, const classname &object );
3f90a399 RR	331
3f90a399 RR	332	#define IMPLEMENT_VARIANT_OBJECT(classname) \
6f5d7825 RR	333	IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,EMPTY_PARAMETER_VALUE)
6f5d7825 RR	334
55ccdb93	335	#define IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
3f90a399 RR	336	class classname##VariantData: public wxVariantData \
	337	{ \
	338	public:\
	339	classname##VariantData() {} \
	340	classname##VariantData( const classname &value ) { m_value = value; } \
	341	\
	342	classname &GetValue() { return m_value; } \
	343	\
	344	virtual bool Eq(wxVariantData& data) const; \
	345	\
	346	virtual wxString GetType() const; \
	347	virtual wxClassInfo* GetValueClassInfo(); \
	348	\
	349	protected:\
	350	classname m_value; \
	351	\
	352	private: \
	353	DECLARE_CLASS(classname##VariantData) \
	354	};\
	355	\
	356	IMPLEMENT_CLASS(classname##VariantData, wxVariantData)\
	357	\
3f90a399 RR	358	wxString classname##VariantData::GetType() const\
	359	{\
	360	return m_value.GetClassInfo()->GetClassName();\
	361	}\
	362	\
	363	wxClassInfo* classname##VariantData::GetValueClassInfo()\
	364	{\
	365	return m_value.GetClassInfo();\
	366	}\
	367	\
39a48551	368	expdecl classname& operator << ( classname &value, const wxVariant &variant )\
3f90a399 RR	369	{\
	370	wxASSERT( wxIsKindOf( variant.GetData(), classname##VariantData ) );\
	371	\
	372	classname##VariantData data = (classname##VariantData) variant.GetData();\
	373	value = data->GetValue();\
	374	return value;\
	375	}\
	376	\
39a48551	377	expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\
3f90a399 RR	378	{\
	379	classname##VariantData *data = new classname##VariantData( value );\
	380	variant.SetData( data );\
	381	return variant;\
	382	}
	383
55ccdb93 VZ	384	// implements a wxVariantData-derived class using for the Eq() method the operator==
	385	// which must have been provided by "classname"
	386	#define IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
	387	IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
	388	\
	389	bool classname##VariantData::Eq(wxVariantData& data) const \
	390	{\
	391	wxASSERT( wxIsKindOf((&data), classname##VariantData) );\
	392	\
	393	classname##VariantData & otherData = (classname##VariantData &) data;\
	394	\
	395	return otherData.m_value == m_value;\
	396	}\
	397
	398
	399	// implements a wxVariantData-derived class using for the Eq() method a shallow
	400	// comparison (through wxObject::IsRefTo function)
	401	#define IMPLEMENT_VARIANT_OBJECT_EXPORTED_SHALLOWCMP(classname,expdecl) \
	402	IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
	403	\
	404	bool classname##VariantData::Eq(wxVariantData& data) const \
	405	{\
	406	wxASSERT( wxIsKindOf((&data), classname##VariantData) );\
	407	\
	408	classname##VariantData & otherData = (classname##VariantData &) data;\
	409	\
	410	return (otherData.m_value.IsRefTo(&m_value));\
	411	}\
	412
	413
3f90a399 RR	414	// Since we want type safety wxVariant we need to fetch and dynamic_cast
	415	// in a seemingly safe way so the compiler can check, so we define
	416	// a dynamic_cast /wxDynamicCast analogue.
cf6ae290 RG	417
cf6ae290 RG	418	#define wxGetVariantCast(var,classname) \
cab1a605 WS	419	((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
cab1a605 WS	420	var.GetWxObjectPtr() : NULL));
cf6ae290	421
bddd7a8d	422	extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;
a0a302dc	423
d5dc103f VZ	424	#endif // wxUSE_VARIANT
	425
	426	#endif // _WX_VARIANT_H_