Rename wxGetFileType to wxGetFileKind

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

diff --git a/include/wx/variant.h b/include/wx/variant.h
index fc517d71750e0e7accb1658bbec0c7b65d2b3947..527d0826309c0927c824f5e69c413f7ae29ce015 100644 (file)
--- a/include/wx/variant.h
+++ b/include/wx/variant.h
@@ -6,7 +6,7 @@
 // Created:     10/09/98
 // RCS-ID:      $Id$
 // Copyright:   (c)
 // Created:     10/09/98
 // RCS-ID:      $Id$
 // Copyright:   (c)

-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_VARIANT_H_
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_VARIANT_H_


@@ -52,7 +52,7 @@ DECLARE_ABSTRACT_CLASS(wxVariantData)
 public:
 
 // Construction & destruction
 public:
 
 // Construction & destruction

-    wxVariantData() {};
+    wxVariantData() {}

 
 // Override these to provide common functionality
     // Copy to data
 
 // Override these to provide common functionality
     // Copy to data


@@ -95,12 +95,13 @@ 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(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(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
     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
 #if wxUSE_DATETIME
     wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); // Date
 #endif // wxUSE_DATETIME


@@ -110,8 +111,7 @@ public:
     wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
     wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
 #endif
     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();
 
     wxVariant(const wxVariant& variant);
     ~wxVariant();
 


@@ -119,7 +119,6 @@ public:
     // Assignment
     void operator= (const wxVariant& variant);
 
     // 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;
 #if wxUSE_DATETIME
     bool operator== (const wxDateTime& value) const;
     bool operator!= (const wxDateTime& value) const;


@@ -134,7 +133,6 @@ public:
     void operator= (const TIME_STRUCT* value) ;
     void operator= (const TIMESTAMP_STRUCT* value) ;
 #endif
     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");
 
     // Assignment using data, e.g.
     // myVariant = new wxStringVariantData("hello");


@@ -161,9 +159,11 @@ public:
     bool operator!= (const wxString& value) const;
     void operator= (const wxString& value) ;
     void operator= (const wxChar* value) ; // Necessary or VC++ assumes bool!
     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) ;
     bool operator== (const wxList& value) const;
     bool operator!= (const wxList& value) const;
     void operator= (const wxList& value) ;


@@ -188,11 +188,9 @@ public:
     // No implicit conversion to wxObject, as that would really
     //  confuse people between conversion to our contained data
     //  and downcasting to see our base type.
     // 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
 #if wxUSE_DATETIME
     inline operator wxDateTime () const { return GetDateTime(); }
 #endif // wxUSE_DATETIME

-//TODO: End of Need to document

 
 // Accessors
     // Sets/gets name
 
 // Accessors
     // Sets/gets name


@@ -224,16 +222,15 @@ public:
     bool GetBool() const ;
     wxString GetString() const ;
     wxList& GetList() 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()  ;
     void* GetVoidPtr() const ;
     wxObject* GetWxObjectPtr()  ;

-//TODO: Need to document

 #if wxUSE_DATETIME
     wxDateTime GetDateTime() const ;
 #endif // wxUSE_DATETIME
     wxArrayString GetArrayString() const;
 #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)
 
 // Operations
     // Make NULL (i.e. delete the data)


@@ -248,7 +245,7 @@ public:
     // Insert at front of list
     void Insert(const wxVariant& value);
 
     // 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 Member(const wxVariant& value) const;
 
     // Deletes the nth element of the list


@@ -265,11 +262,9 @@ public:
     bool Convert(double* value) const;
     bool Convert(wxString* value) const;
     bool Convert(char* value) const;
     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
 #if wxUSE_DATETIME
     bool Convert(wxDateTime* value) const;
 #endif // wxUSE_DATETIME

-//TODO: End of Need to document

 
 // Attributes
 protected:
 
 // Attributes
 protected:


@@ -278,12 +273,12 @@ protected:
 };
 
 //Since we want type safety wxVariant we need to fetch and dynamic_cast
 };
 
 //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) \
 //a dynamic_cast /wxDynamicCast analogue.
 
 #define wxGetVariantCast(var,classname) \

-       ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
-                     var.GetWxObjectPtr() : NULL));
+    ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
+                  var.GetWxObjectPtr() : NULL));

 
 extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;
 
 
 extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;