/////////////////////////////////////////////////////////////////////////////
-// 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(NO_GCC_PRAGMA)
-#pragma interface "variant.h"
-#endif
-
#include "wx/defs.h"
#include "wx/object.h"
#include "wx/string.h"
public:
// Construction & destruction
- wxVariantData() {};
+ wxVariantData() {}
// Override these to provide common functionality
// Copy to data
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);
+#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(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 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 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) ;
// No implicit conversion to wxObject, as that would really
// confuse people between conversion to our contained data
// and downcasting to see our base type.
-//TODO: Need to document
#if wxUSE_DATETIME
inline operator wxDateTime () const { return GetDateTime(); }
#endif // wxUSE_DATETIME
-//TODO: End of Need to document
// Accessors
// Sets/gets name
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 ;
-
+#if WXWIN_COMPATIBILITY_2_4
+ wxDEPRECATED( wxStringList& GetStringList() const );
+#endif
void* GetVoidPtr() const ;
wxObject* GetWxObjectPtr() ;
-//TODO: Need to document
#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;
-//TODO: Need to document
#if wxUSE_DATETIME
bool Convert(wxDateTime* value) const;
#endif // wxUSE_DATETIME
-//TODO: End of Need to document
// Attributes
protected:
};
//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
+//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::sm_class##classname) ?\
- var.GetWxObjectPtr() : NULL));
+ ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
+ var.GetWxObjectPtr() : NULL));
extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;