Change GetC to return an int so that it can return wxEOF on error.

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

diff --git a/include/wx/artprov.h b/include/wx/artprov.h
index daa2e428f79888991c0d4dd363dd7bf972cd006b..61cb8c518d6c6d2b63bbf53fba955e1311cebf1b 100644 (file)
--- a/include/wx/artprov.h
+++ b/include/wx/artprov.h
@@ -12,10 +12,6 @@
 #ifndef _WX_ARTPROV_H_
 #define _WX_ARTPROV_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "artprov.h"
-#endif
-
 #include "wx/string.h"
 #include "wx/bitmap.h"
 #include "wx/icon.h"
@@ -116,15 +112,27 @@ typedef wxString wxArtID;
 class WXDLLEXPORT wxArtProvider : public wxObject
 {
 public:
-    // Add new provider to the top of providers stack.
-    static void PushProvider(wxArtProvider *provider);
+    // Dtor removes the provider from providers stack if it's still on it
+    virtual ~wxArtProvider();
+
+
+    // Add new provider to the top of providers stack (i.e. the provider will
+    // be queried first of all).
+    static void Push(wxArtProvider *provider);
+
+    // Add new provider to the bottom of providers stack (i.e. the provider
+    // will be queried as the last one).
+    static void Insert(wxArtProvider *provider);
 
     // Remove latest added provider and delete it.
-    static bool PopProvider();
+    static bool Pop();
+
+    // Remove provider from providers stack but don't delete it.
+    static bool Remove(wxArtProvider *provider);
+
+    // Delete the given provider and remove it from the providers stack.
+    static bool Delete(wxArtProvider *provider);
 
-    // Remove provider. The provider must have been added previously!
-    // The provider is _not_ deleted.
-    static bool RemoveProvider(wxArtProvider *provider);
 
     // Query the providers for bitmap with given ID and return it. Return
     // wxNullBitmap if no provider provides it.
@@ -142,6 +150,18 @@ public:
     // the topmost provider if platform_dependent = false
     static wxSize GetSizeHint(const wxArtClient& client, bool platform_dependent = false);
 
+#if WXWIN_COMPATIBILITY_2_6
+    // use the corresponding methods without redundant "Provider" suffix
+    wxDEPRECATED( static void PushProvider(wxArtProvider *provider) );
+    wxDEPRECATED( static void InsertProvider(wxArtProvider *provider) );
+    wxDEPRECATED( static bool PopProvider() );
+
+    // use Delete() if this is what you really need, or just delete the
+    // provider pointer, do not use Remove() as it does not delete the pointer
+    // unlike RemoveProvider() which does
+    wxDEPRECATED( static bool RemoveProvider(wxArtProvider *provider) );
+#endif // WXWIN_COMPATIBILITY_2_6
+
 protected:
     friend class wxArtProviderModule;
     // Initializes default provider
@@ -156,7 +176,7 @@ protected:
     {
         return GetSizeHint(client, true);
     }
-                             
+
     // Derived classes must override this method to create requested
     // art resource. This method is called only once per instance's
     // lifetime for each requested wxArtID.
@@ -164,6 +184,9 @@ protected:
                                   const wxArtClient& WXUNUSED(client),
                                   const wxSize& WXUNUSED(size)) = 0;
 
+private:
+    static void CommonAddingProvider();
+
 private:
     // list of providers:
     static wxArtProvidersList *sm_providers;