added wxAuiNotebook and wxAuiTabArt to classes.tex and category.tex

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

diff --git a/include/wx/variant.h b/include/wx/variant.h
index 848c0a0261011aa72c782a9b590a9a29f3d3bff6..ff6fc93a4311c943f91e3d574bc84812debaf10b 100644 (file)
--- a/include/wx/variant.h
+++ b/include/wx/variant.h
@@ -20,6 +20,7 @@
 #include "wx/string.h"
 #include "wx/arrstr.h"
 #include "wx/list.h"
 #include "wx/string.h"
 #include "wx/arrstr.h"
 #include "wx/list.h"

+#include "wx/cpp.h"

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


@@ -68,15 +69,15 @@ public:
 
     // Override these to provide common functionality
     virtual bool Eq(wxVariantData& data) const = 0;
 
     // Override these to provide common functionality
     virtual bool Eq(wxVariantData& data) const = 0;

-    
+

 #if wxUSE_STD_IOSTREAM
 #if wxUSE_STD_IOSTREAM

-    virtual bool Write(wxSTD ostream& str) const { return false; }
+    virtual bool Write(wxSTD ostream& WXUNUSED(str)) const { return false; }

 #endif
 #endif

-    virtual bool Write(wxString& str) const { return false; }
+    virtual bool Write(wxString& WXUNUSED(str)) const { return false; }

 #if wxUSE_STD_IOSTREAM
 #if wxUSE_STD_IOSTREAM

-    virtual bool Read(wxSTD istream& str) { return false; }
+    virtual bool Read(wxSTD istream& WXUNUSED(str)) { return false; }

 #endif
 #endif

-    virtual bool Read(wxString& str) { return false; }
+    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.
     // What type is it? Return a string name.
     virtual wxString GetType() const = 0;
     // If it based on wxObject return the ClassInfo.


@@ -99,7 +100,7 @@ protected:
 
 private:
     int     m_count;
 
 private:
     int     m_count;

-    
+

 private:
     DECLARE_ABSTRACT_CLASS(wxVariantData)
 };
 private:
     DECLARE_ABSTRACT_CLASS(wxVariantData)
 };


@@ -113,7 +114,7 @@ class WXDLLIMPEXP_BASE wxVariant: public wxObject
 {
 public:
     wxVariant();
 {
 public:
     wxVariant();

-    
+

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


@@ -124,7 +125,7 @@ public:
     // Assignment using data, e.g.
     // myVariant = new wxStringVariantData("hello");
     void operator= (wxVariantData* variantData);
     // 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;
 
     bool operator== (const wxVariant& variant) const;
     bool operator!= (const wxVariant& variant) const;
 


@@ -133,7 +134,7 @@ public:
     inline const wxString& GetName() const { return m_name; }
 
     // Tests whether there is data
     inline const wxString& GetName() const { return m_name; }
 
     // Tests whether there is data

-    bool IsNull() const; 
+    bool IsNull() const;

 
     // For compatibility with wxWidgets <= 2.6, this doesn't increase
     // reference count.
 
     // For compatibility with wxWidgets <= 2.6, this doesn't increase
     // reference count.


@@ -148,10 +149,10 @@ public:
 
     // Make NULL (i.e. delete the data)
     void MakeNull();
 
     // Make NULL (i.e. delete the data)
     void MakeNull();

-    
+

     // Delete data and name
     void Clear();
     // 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;
     // Returns a string representing the type of the variant,
     // e.g. "string", "bool", "stringlist", "list", "double", "long"
     wxString GetType() const;


@@ -159,9 +160,9 @@ public:
     bool IsType(const wxString& type) const;
     bool IsValueKindOf(const wxClassInfo* type) const;
 
     bool IsType(const wxString& type) const;
     bool IsValueKindOf(const wxClassInfo* type) const;
 

-    // write contents to a string (e.g. for debugging)    
+    // write contents to a string (e.g. for debugging)

     wxString MakeString() const;
     wxString MakeString() const;

-    
+

     // double
     wxVariant(double val, const wxString& name = wxEmptyString);
     bool operator== (double value) const;
     // double
     wxVariant(double val, const wxString& name = wxEmptyString);
     bool operator== (double value) const;


@@ -170,7 +171,7 @@ public:
     inline operator double () const {  return GetDouble(); }
     inline double GetReal() const { return GetDouble(); }
     double GetDouble() const;
     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);
     // long
     wxVariant(long val, const wxString& name = wxEmptyString);
     wxVariant(int val, const wxString& name = wxEmptyString);


@@ -181,8 +182,8 @@ public:
     inline operator long () const {  return GetLong(); }
     inline long GetInteger() const { return GetLong(); }
     long GetLong() const;
     inline operator long () const {  return GetLong(); }
     inline long GetInteger() const { return GetLong(); }
     long GetLong() const;

-    
-    // bool    
+
+    // bool

 #ifdef HAVE_BOOL
     wxVariant(bool val, const wxString& name = wxEmptyString);
     bool operator== (bool value) const;
 #ifdef HAVE_BOOL
     wxVariant(bool val, const wxString& name = wxEmptyString);
     bool operator== (bool value) const;


@@ -194,7 +195,7 @@ public:
 
     // wxDateTime
 #if wxUSE_DATETIME
 
     // wxDateTime
 #if wxUSE_DATETIME

-    wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); 
+    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);
 #if wxUSE_ODBC
     wxVariant(const DATE_STRUCT* valptr, const wxString& name = wxEmptyString);
     wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString);


@@ -229,7 +230,7 @@ public:
     void operator= (wxChar value) ;
     inline operator wxChar () const { return GetChar(); }
     wxChar GetChar() 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;
     // wxArrayString
     wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString);
     bool operator== (const wxArrayString& value) const;


@@ -277,7 +278,7 @@ public:
 
     // Return the number of elements in a list
     size_t GetCount() const;
 
     // Return the number of elements in a list
     size_t GetCount() const;

-    
+

     // Make empty list
     void NullList();
 
     // Make empty list
     void NullList();
 


@@ -311,28 +312,22 @@ public:
 protected:
     wxVariantData*  m_data;
     wxString        m_name;
 protected:
     wxVariantData*  m_data;
     wxString        m_name;

-    
+

 private:
     DECLARE_DYNAMIC_CLASS(wxVariant)
 };
 
 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) \
 #define DECLARE_VARIANT_OBJECT(classname) \

-    DECLARE_VARIANT_OBJECT_EXPORTED(classname,EMPTY_PARAMETER_VALUE)
-    
+    DECLARE_VARIANT_OBJECT_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
+

 #define DECLARE_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
 #define DECLARE_VARIANT_OBJECT_EXPORTED(classname,expdecl) \

-classname& expdecl operator << ( classname &object, const wxVariant &variant ); \
-wxVariant& expdecl operator << ( wxVariant &variant, const classname &object );
+expdecl classname& operator << ( classname &object, const wxVariant &variant ); \
+expdecl wxVariant& operator << ( wxVariant &variant, const classname &object );

 
 #define IMPLEMENT_VARIANT_OBJECT(classname) \
 
 #define IMPLEMENT_VARIANT_OBJECT(classname) \

-    IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,EMPTY_PARAMETER_VALUE)
+    IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)

 
 

-#define IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
+#define IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \

 class classname##VariantData: public wxVariantData \
 { \
 public:\
 class classname##VariantData: public wxVariantData \
 { \
 public:\


@@ -355,15 +350,6 @@ private: \
 \
 IMPLEMENT_CLASS(classname##VariantData, wxVariantData)\
 \
 \
 IMPLEMENT_CLASS(classname##VariantData, wxVariantData)\
 \

-bool classname##VariantData::Eq(wxVariantData& data) const \
-{\
-    wxASSERT( wxIsKindOf((&data), classname##VariantData) );\
-\
-    classname##VariantData & otherData = (classname##VariantData &) data;\
-\
-    return (otherData.m_value == m_value);\
-}\
-\

 wxString classname##VariantData::GetType() const\
 {\
     return m_value.GetClassInfo()->GetClassName();\
 wxString classname##VariantData::GetType() const\
 {\
     return m_value.GetClassInfo()->GetClassName();\


@@ -374,7 +360,7 @@ wxClassInfo* classname##VariantData::GetValueClassInfo()\
     return m_value.GetClassInfo();\
 }\
 \
     return m_value.GetClassInfo();\
 }\
 \

-classname& expdecl operator << ( classname &value, const wxVariant &variant )\
+expdecl classname& operator << ( classname &value, const wxVariant &variant )\

 {\
     wxASSERT( wxIsKindOf( variant.GetData(), classname##VariantData ) );\
     \
 {\
     wxASSERT( wxIsKindOf( variant.GetData(), classname##VariantData ) );\
     \


@@ -383,13 +369,45 @@ classname& expdecl operator << ( classname &value, const wxVariant &variant )\
     return value;\
 }\
 \
     return value;\
 }\
 \

-wxVariant& expdecl operator << ( wxVariant &variant, const classname &value )\
+expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\

 {\
     classname##VariantData *data = new classname##VariantData( value );\
     variant.SetData( data );\
     return variant;\
 }
 
 {\
     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,wxEMPTY_PARAMETER_VALUE 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::IsSameAs function)
+#define IMPLEMENT_VARIANT_OBJECT_SHALLOWCMP(classname) \
+    IMPLEMENT_VARIANT_OBJECT_EXPORTED_SHALLOWCMP(classname, wxEMPTY_PARAMETER_VALUE)
+#define IMPLEMENT_VARIANT_OBJECT_EXPORTED_SHALLOWCMP(classname,expdecl) \
+IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
+\
+bool classname##VariantData::Eq(wxVariantData& data) const \
+{\
+    wxASSERT( wxIsKindOf((&data), classname##VariantData) );\
+\
+    classname##VariantData & otherData = (classname##VariantData &) data;\
+\
+    return (otherData.m_value.IsSameAs(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.
 // 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.