/////////////////////////////////////////////////////////////////////////////
-// Name: 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)
+// Copyright: (c) Julian Smart
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_VARIANT_H_
#define _WX_VARIANT_H_
-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "variant.h"
-#endif
-
#include "wx/defs.h"
#include "wx/object.h"
#include "wx/string.h"
+#include "wx/arrstr.h"
#include "wx/list.h"
-#if wxUSE_TIMEDATE
- #include "wx/time.h"
- #include "wx/date.h"
-#endif // time/date
-
-#include "wx/datetime.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/ioswrap.h"
+#include "wx/iosfwrap.h"
/*
* wxVariantData stores the actual data in a wxVariant object,
* overloading wxVariant with unnecessary functionality.
*/
-class WXDLLEXPORT wxVariantData: public wxObject
+class WXDLLIMPEXP_BASE wxVariantData: public wxObject
{
DECLARE_ABSTRACT_CLASS(wxVariantData)
public:
// Construction & destruction
- wxVariantData() {};
+ wxVariantData() {}
// Override these to provide common functionality
// Copy to data
virtual bool Read(wxString& str) = 0;
// 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; }
};
/*
* this class too much.
*/
-class WXDLLEXPORT wxVariant: public wxObject
+class WXDLLIMPEXP_BASE wxVariant: public wxObject
{
DECLARE_DYNAMIC_CLASS(wxVariant)
public:
wxVariant(char val, const wxString& name = wxEmptyString);
wxVariant(const wxString& val, const wxString& name = wxEmptyString);
wxVariant(const wxChar* val, const wxString& name = wxEmptyString); // Necessary or VC++ assumes bool!
- wxVariant(const wxStringList& val, const wxString& name = wxEmptyString);
- wxVariant(const wxList& val, const wxString& name = wxEmptyString); // List of variants
-// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
-#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
- wxVariant(const wxTime& val, const wxString& name = wxEmptyString); // Time
- wxVariant(const wxDate& val, const wxString& name = wxEmptyString); // Date
+#if WXWIN_COMPATIBILITY_2_4
+ wxDEPRECATED( wxVariant(const wxStringList& val, const wxString& name = wxEmptyString) );
#endif
+ wxVariant(const wxList& val, const wxString& name = wxEmptyString); // List of variants
wxVariant(void* ptr, const wxString& name = wxEmptyString); // void* (general purpose)
+ wxVariant(wxObject* ptr, const wxString& name = wxEmptyString); //wxObject
wxVariant(wxVariantData* data, const wxString& name = wxEmptyString); // User-defined data
-//TODO: Need to document
+#if wxUSE_DATETIME
wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); // Date
+#endif // wxUSE_DATETIME
wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString); // String array
#if wxUSE_ODBC
wxVariant(const DATE_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
#endif
-//TODO: End of Need to document
-
+
wxVariant(const wxVariant& variant);
- ~wxVariant();
+ virtual ~wxVariant();
// Generic operators
// Assignment
void operator= (const wxVariant& variant);
-//TODO: Need to document
+#if wxUSE_DATETIME
bool operator== (const wxDateTime& value) const;
bool operator!= (const wxDateTime& value) const;
void operator= (const wxDateTime& value) ;
+#endif // wxUSE_DATETIME
bool operator== (const wxArrayString& value) const;
bool operator!= (const wxArrayString& value) const;
void operator= (const TIME_STRUCT* value) ;
void operator= (const TIMESTAMP_STRUCT* value) ;
#endif
-//TODO: End of Need to document
// Assignment using data, e.g.
// myVariant = new wxStringVariantData("hello");
bool operator!= (const wxString& value) const;
void operator= (const wxString& value) ;
void operator= (const wxChar* value) ; // Necessary or VC++ assumes bool!
- bool operator== (const wxStringList& value) const;
- bool operator!= (const wxStringList& value) const;
- void operator= (const wxStringList& value) ;
+#if WXWIN_COMPATIBILITY_2_4
+ wxDEPRECATED( bool operator== (const wxStringList& value) const );
+ wxDEPRECATED( bool operator!= (const wxStringList& value) const );
+ wxDEPRECATED( void operator= (const wxStringList& value) );
+#endif
bool operator== (const wxList& value) const;
bool operator!= (const wxList& value) const;
void operator= (const wxList& value) ;
-// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
-#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
- bool operator== (const wxTime& value) const;
- bool operator!= (const wxTime& value) const;
- void operator= (const wxTime& value) ;
- bool operator== (const wxDate& value) const;
- bool operator!= (const wxDate& value) const;
- void operator= (const wxDate& value) ;
-#endif
bool operator== (void* value) const;
bool operator!= (void* value) const;
void operator= (void* value) ;
inline operator char () const { return GetChar(); }
inline operator long () const { return GetLong(); }
inline operator bool () const { return GetBool(); }
-// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
-#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
- inline operator wxTime () const { return GetTime(); }
- inline operator wxDate () const { return GetDate(); }
-#endif
inline operator void* () const { return GetVoidPtr(); }
-//TODO: Need to document
+ // No implicit conversion to wxObject, as that would really
+ // confuse people between conversion to our contained data
+ // and downcasting to see our base type.
+#if wxUSE_DATETIME
inline operator wxDateTime () const { return GetDateTime(); }
-//TODO: End of Need to document
+#endif // wxUSE_DATETIME
// Accessors
// Sets/gets name
wxString GetType() const;
bool IsType(const wxString& type) const;
+ bool IsValueKindOf(const wxClassInfo* type) const;
// Return the number of elements in a list
- int GetCount() const;
+ size_t GetCount() const;
// Value accessors
double GetReal() const ;
bool GetBool() const ;
wxString GetString() const ;
wxList& GetList() const ;
- wxStringList& GetStringList() const ;
-
-// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
-#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
- wxTime GetTime() const ;
- wxDate GetDate() const ;
+#if WXWIN_COMPATIBILITY_2_4
+ wxDEPRECATED( wxStringList& GetStringList() const );
#endif
void* GetVoidPtr() const ;
-//TODO: Need to document
+ wxObject* GetWxObjectPtr() ;
+#if wxUSE_DATETIME
wxDateTime GetDateTime() const ;
+#endif // wxUSE_DATETIME
wxArrayString GetArrayString() const;
-//TODO: End of Need to document
// Operations
// Make NULL (i.e. delete the data)
// Insert at front of list
void Insert(const wxVariant& value);
- // Returns TRUE if the variant is a member of the list
+ // 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(int item);
+ bool Delete(size_t item);
// Clear list
void ClearList();
bool Convert(double* value) const;
bool Convert(wxString* value) const;
bool Convert(char* value) const;
-// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
-#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
- bool Convert(wxTime* value) const;
- bool Convert(wxDate* value) const;
-#endif
-//TODO: Need to document
+#if wxUSE_DATETIME
bool Convert(wxDateTime* value) const;
-//TODO: End of Need to document
+#endif // wxUSE_DATETIME
// Attributes
protected:
wxString m_name;
};
-extern wxVariant WXDLLEXPORT wxNullVariant;
+//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
// _WX_VARIANT_H_
projects / wxWidgets.git / blobdiff