wxURL - doc cleanups, depreciated more methods, more source comments. wxURI - enclos...

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

diff --git a/include/wx/variant.h b/include/wx/variant.h
index 4ddfbc10fa986d183e2506d0c0305a26683ead8b..3d3ad32484754f65746414ec5ebadcfae46bcfb8 100644 (file)
--- a/include/wx/variant.h
+++ b/include/wx/variant.h
@@ -12,27 +12,25 @@
 #ifndef _WX_VARIANT_H_
 #define _WX_VARIANT_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #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,
@@ -48,13 +46,13 @@
  * 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
@@ -70,6 +68,8 @@ public:
     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; }
 };
 
 /*
@@ -80,7 +80,7 @@ public:
  * this class too much.
  */
 
-class WXDLLEXPORT wxVariant: public wxObject
+class WXDLLIMPEXP_BASE wxVariant: public wxObject
 {
 DECLARE_DYNAMIC_CLASS(wxVariant)
 public:
@@ -97,23 +97,19 @@ public:
     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
-#endif
     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();
 
@@ -121,10 +117,11 @@ public:
     // 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;
@@ -134,7 +131,6 @@ public:
     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");
@@ -167,15 +163,6 @@ public:
     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) ;
@@ -193,15 +180,13 @@ public:
     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
@@ -219,6 +204,7 @@ public:
     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;
@@ -234,16 +220,12 @@ public:
     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 ;
-#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)
@@ -258,7 +240,7 @@ public:
     // 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
@@ -275,14 +257,9 @@ public:
     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:
@@ -290,7 +267,15 @@ 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_