]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/artprov.cpp
bump subrelease number
[wxWidgets.git] / src / common / artprov.cpp
index 52b8b8ab989ef6eb236368edc9b1ce4d2080a71b..dd5cdb4bd5a4c43e2c2086325d9043d5f8fb3ab0 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        artprov.cpp
+// Name:        src/common/artprov.cpp
 // Purpose:     wxArtProvider class
 // Author:      Vaclav Slavik
 // Modified by:
 // headers
 // ---------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "artprov.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
     #pragma hdrstop
 #endif
 
+#include "wx/artprov.h"
+
 #ifndef WX_PRECOMP
-    #include "wx/log.h"
     #include "wx/list.h"
-#endif
-
-#include "wx/artprov.h"
-#include "wx/hashmap.h"
-#include "wx/module.h"
-#if wxUSE_IMAGE
-#include "wx/image.h"
+    #include "wx/log.h"
+    #include "wx/hashmap.h"
+    #include "wx/image.h"
+    #include "wx/module.h"
 #endif
 
 // ===========================================================================
@@ -42,7 +36,7 @@
 
 #include "wx/listimpl.cpp"
 WX_DECLARE_LIST(wxArtProvider, wxArtProvidersList);
-WX_DEFINE_LIST(wxArtProvidersList);
+WX_DEFINE_LIST(wxArtProvidersList)
 
 // ----------------------------------------------------------------------------
 // Cache class - stores already requested bitmaps
@@ -96,16 +90,29 @@ void wxArtProviderCache::Clear()
 }
 
 
-// ----------------------------------------------------------------------------
+// ============================================================================
 // wxArtProvider class
-// ----------------------------------------------------------------------------
+// ============================================================================
 
 IMPLEMENT_ABSTRACT_CLASS(wxArtProvider, wxObject)
 
 wxArtProvidersList *wxArtProvider::sm_providers = NULL;
 wxArtProviderCache *wxArtProvider::sm_cache = NULL;
 
-/*static*/ void wxArtProvider::PushProvider(wxArtProvider *provider)
+// ----------------------------------------------------------------------------
+// wxArtProvider ctors/dtor
+// ----------------------------------------------------------------------------
+
+wxArtProvider::~wxArtProvider()
+{
+    Remove(this);
+}
+
+// ----------------------------------------------------------------------------
+// wxArtProvider operations on provider stack
+// ----------------------------------------------------------------------------
+
+/*static*/ void wxArtProvider::CommonAddingProvider()
 {
     if ( !sm_providers )
     {
@@ -113,28 +120,37 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL;
         sm_cache = new wxArtProviderCache;
     }
 
-    sm_providers->Insert(provider);
     sm_cache->Clear();
 }
 
-/*static*/ bool wxArtProvider::PopProvider()
+/*static*/ void wxArtProvider::Push(wxArtProvider *provider)
+{
+    CommonAddingProvider();
+    sm_providers->Insert(provider);
+}
+
+/*static*/ void wxArtProvider::Insert(wxArtProvider *provider)
+{
+    CommonAddingProvider();
+    sm_providers->Append(provider);
+}
+
+/*static*/ bool wxArtProvider::Pop()
 {
     wxCHECK_MSG( sm_providers, false, _T("no wxArtProvider exists") );
-    wxCHECK_MSG( sm_providers->GetCount() > 0, false, _T("wxArtProviders stack is empty") );
+    wxCHECK_MSG( !sm_providers->empty(), false, _T("wxArtProviders stack is empty") );
 
     delete sm_providers->GetFirst()->GetData();
-    sm_providers->Erase(sm_providers->GetFirst());
     sm_cache->Clear();
     return true;
 }
 
-/*static*/ bool wxArtProvider::RemoveProvider(wxArtProvider *provider)
+/*static*/ bool wxArtProvider::Remove(wxArtProvider *provider)
 {
     wxCHECK_MSG( sm_providers, false, _T("no wxArtProvider exists") );
 
     if ( sm_providers->DeleteObject(provider) )
     {
-        delete provider;
         sm_cache->Clear();
         return true;
     }
@@ -142,25 +158,43 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL;
     return false;
 }
 
+/*static*/ bool wxArtProvider::Delete(wxArtProvider *provider)
+{
+    // provider will remove itself from the stack in its dtor
+    delete provider;
+
+    return true;
+}
+
 /*static*/ void wxArtProvider::CleanUpProviders()
 {
-    WX_CLEAR_LIST(wxArtProvidersList, *sm_providers);
-    wxDELETE(sm_providers);
-    wxDELETE(sm_cache);
+    if ( sm_providers )
+    {
+        while ( !sm_providers->empty() )
+            delete *sm_providers->begin();
+
+        delete sm_providers;
+        sm_providers = NULL;
+
+        delete sm_cache;
+        sm_cache = NULL;
+    }
 }
 
+// ----------------------------------------------------------------------------
+// wxArtProvider: retrieving bitmaps/icons
+// ----------------------------------------------------------------------------
+
 /*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtID& id,
                                              const wxArtClient& client,
-                                             const wxSize& reqSize)
+                                             const wxSize& size)
 {
     // safety-check against writing client,id,size instead of id,client,size:
     wxASSERT_MSG( client.Last() == _T('C'), _T("invalid 'client' parameter") );
 
     wxCHECK_MSG( sm_providers, wxNullBitmap, _T("no wxArtProvider exists") );
 
-    wxSize bestSize = (reqSize != wxDefaultSize) ? reqSize : GetSize(client);
-
-    wxString hashId = wxArtProviderCache::ConstructHashID(id, client, bestSize);
+    wxString hashId = wxArtProviderCache::ConstructHashID(id, client, size);
 
     wxBitmap bmp;
     if ( !sm_cache->GetBitmap(hashId, &bmp) )
@@ -168,25 +202,15 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL;
         for (wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();
              node; node = node->GetNext())
         {
-            bmp = node->GetData()->CreateBitmap(id, client, bestSize);
+            bmp = node->GetData()->CreateBitmap(id, client, size);
             if ( bmp.Ok() )
             {
-#if wxUSE_IMAGE
-                int bmp_w = bmp.GetWidth();
-                int bmp_h = bmp.GetHeight();
-                // want default size but it's smaller, paste into transparent image
-                if ((reqSize == wxDefaultSize) &&
-                    (bmp_h < bestSize.x) && (bmp_w < bestSize.y))
-                {
-                     wxPoint offset((bestSize.x - bmp_w)/2, (bestSize.y - bmp_h)/2);
-                     wxImage img = bmp.ConvertToImage();
-                     img.Resize(bestSize, offset);
-                     bmp = wxBitmap(img);
-                }
-                else if ( (bmp_w != bestSize.x) || (bmp_h != bestSize.y) )
+#if wxUSE_IMAGE && (!defined(__WXMSW__) || wxUSE_WXDIB)
+                if ( size != wxDefaultSize &&
+                     (bmp.GetWidth() != size.x || bmp.GetHeight() != size.y) )
                 {
                     wxImage img = bmp.ConvertToImage();
-                    img.Rescale(bestSize.x, bestSize.y);
+                    img.Rescale(size.x, size.y);
                     bmp = wxBitmap(img);
                 }
 #endif
@@ -216,41 +240,83 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL;
 }
 
 #if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)
-    #include <gtk/gtk.h>
+    #include "wx/gtk/private.h"
     extern GtkIconSize wxArtClientToIconSize(const wxArtClient& client);
-#endif // __WXGTK__
+#endif // defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)
 
-/*static*/ wxSize wxArtProvider::GetSize(const wxArtClient& client,
+/*static*/ wxSize wxArtProvider::GetSizeHint(const wxArtClient& client,
                                          bool platform_dependent)
 {
     if (!platform_dependent)
     {
         wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();
         if (node)
-            return node->GetData()->DoGetSize(client);
+            return node->GetData()->DoGetSizeHint(client);
+    }
 
         // else return platform dependent size
-    }
 
 #if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)
+    // Gtk has specific sizes for each client, see artgtk.cpp
     GtkIconSize gtk_size = wxArtClientToIconSize(client);
+    // no size hints for this client
+    if (gtk_size == GTK_ICON_SIZE_INVALID)
+        return wxDefaultSize;
     gint width, height;
     gtk_icon_size_lookup( gtk_size, &width, &height);
     return wxSize(width, height);
 #else // !GTK+ 2
+    // NB: These size hints may have to be adjusted per platform
     if (client == wxART_TOOLBAR)
-        return wxSize(32, 32);
+        return wxSize(16, 15);
     else if (client == wxART_MENU)
         return wxSize(16, 15);
+    else if (client == wxART_FRAME_ICON)
+        return wxSize(16, 15);
     else if (client == wxART_CMN_DIALOG || client == wxART_MESSAGE_BOX)
         return wxSize(32, 32);
+    else if (client == wxART_HELP_BROWSER)
+        return wxSize(16, 15);
     else if (client == wxART_BUTTON)
         return wxSize(16, 15);
-    else
-        return wxSize(16, 15); // this is arbitrary
+    else // wxART_OTHER or perhaps a user's client, no specified size
+        return wxDefaultSize;
 #endif // GTK+ 2/else
 }
 
+// ----------------------------------------------------------------------------
+// deprecated wxArtProvider methods
+// ----------------------------------------------------------------------------
+
+#if WXWIN_COMPATIBILITY_2_6
+
+/* static */ void wxArtProvider::PushProvider(wxArtProvider *provider)
+{
+    Push(provider);
+}
+
+/* static */ void wxArtProvider::InsertProvider(wxArtProvider *provider)
+{
+    Insert(provider);
+}
+
+/* static */ bool wxArtProvider::PopProvider()
+{
+    return Pop();
+}
+
+/* static */ bool wxArtProvider::RemoveProvider(wxArtProvider *provider)
+{
+    // RemoveProvider() used to delete the provider being removed so this is
+    // not a typo, we must call Delete() and not Remove() here
+    return Delete(provider);
+}
+
+#endif // WXWIN_COMPATIBILITY_2_6
+
+// ============================================================================
+// wxArtProviderModule
+// ============================================================================
 
 class wxArtProviderModule: public wxModule
 {