recognize hover bitmaps (patch 1758843)

[wxWidgets.git] / src / common / artprov.cpp

diff --git a/src/common/artprov.cpp b/src/common/artprov.cpp
index 64b87d781ee45ee1f587a34bc7b45e32828d5208..bd79bb96e346408085ae57efe60f22baa736a432 100644 (file)
--- a/src/common/artprov.cpp
+++ b/src/common/artprov.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        artprov.cpp
+// Name:        src/common/artprov.cpp

 // Purpose:     wxArtProvider class
 // Author:      Vaclav Slavik
 // Modified by:
 // Purpose:     wxArtProvider class
 // Author:      Vaclav Slavik
 // Modified by:


@@ -13,10 +13,6 @@
 // headers
 // ---------------------------------------------------------------------------
 
 // headers
 // ---------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "artprov.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -24,32 +20,30 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#include "wx/artprov.h"
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-    #include "wx/log.h"

     #include "wx/list.h"
     #include "wx/list.h"

+    #include "wx/log.h"
+    #include "wx/hashmap.h"
+    #include "wx/image.h"
+    #include "wx/module.h"

 #endif
 
 #endif
 

-#include "wx/artprov.h"
-#include "wx/hashmap.h"
-#include "wx/module.h"
-#include "wx/image.h"
-
-// For the purposes of forcing this module to link
-extern char g_ArtProviderModule;
-

 // ===========================================================================
 // implementation
 // ===========================================================================
 
 #include "wx/listimpl.cpp"
 WX_DECLARE_LIST(wxArtProvider, wxArtProvidersList);
 // ===========================================================================
 // implementation
 // ===========================================================================
 
 #include "wx/listimpl.cpp"
 WX_DECLARE_LIST(wxArtProvider, wxArtProvidersList);

-WX_DEFINE_LIST(wxArtProvidersList);
+WX_DEFINE_LIST(wxArtProvidersList)

 
 // ----------------------------------------------------------------------------
 // Cache class - stores already requested bitmaps
 // ----------------------------------------------------------------------------
 
 WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxBitmap, wxArtProviderBitmapsHash);
 
 // ----------------------------------------------------------------------------
 // Cache class - stores already requested bitmaps
 // ----------------------------------------------------------------------------
 
 WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxBitmap, wxArtProviderBitmapsHash);

+WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxIconBundle, wxArtProviderIconBundlesHash);

 
 class WXDLLEXPORT wxArtProviderCache
 {
 
 class WXDLLEXPORT wxArtProviderCache
 {


@@ -58,14 +52,22 @@ public:
     void PutBitmap(const wxString& full_id, const wxBitmap& bmp)
         { m_bitmapsHash[full_id] = bmp; }
 
     void PutBitmap(const wxString& full_id, const wxBitmap& bmp)
         { m_bitmapsHash[full_id] = bmp; }
 

+    bool GetIconBundle(const wxString& full_id, wxIconBundle* bmp);
+    void PutIconBundle(const wxString& full_id, const wxIconBundle& iconbundle)
+        { m_iconBundlesHash[full_id] = iconbundle; }
+

     void Clear();
 
     static wxString ConstructHashID(const wxArtID& id,
                                     const wxArtClient& client,
                                     const wxSize& size);
 
     void Clear();
 
     static wxString ConstructHashID(const wxArtID& id,
                                     const wxArtClient& client,
                                     const wxSize& size);
 

+    static wxString ConstructHashID(const wxArtID& id,
+                                    const wxArtClient& client);
+

 private:
 private:

-    wxArtProviderBitmapsHash m_bitmapsHash;
+    wxArtProviderBitmapsHash m_bitmapsHash;         // cache of wxBitmaps
+    wxArtProviderIconBundlesHash m_iconBundlesHash; // cache of wxIconBundles

 };
 
 bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp)
 };
 
 bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp)


@@ -73,84 +75,147 @@ bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp)
     wxArtProviderBitmapsHash::iterator entry = m_bitmapsHash.find(full_id);
     if ( entry == m_bitmapsHash.end() )
     {
     wxArtProviderBitmapsHash::iterator entry = m_bitmapsHash.find(full_id);
     if ( entry == m_bitmapsHash.end() )
     {

-        return FALSE;
+        return false;
+    }
+    else
+    {
+        *bmp = entry->second;
+        return true;
+    }
+}
+
+bool wxArtProviderCache::GetIconBundle(const wxString& full_id, wxIconBundle* bmp)
+{
+    wxArtProviderIconBundlesHash::iterator entry = m_iconBundlesHash.find(full_id);
+    if ( entry == m_iconBundlesHash.end() )
+    {
+        return false;

     }
     else
     {
         *bmp = entry->second;
     }
     else
     {
         *bmp = entry->second;

-        return TRUE;
+        return true;

     }
 }
 
 void wxArtProviderCache::Clear()
 {
     }
 }
 
 void wxArtProviderCache::Clear()
 {

-    // Hack to make the default provider link
-    // with the application
-    g_ArtProviderModule = 0;

     m_bitmapsHash.clear();
     m_bitmapsHash.clear();

+    m_iconBundlesHash.clear();

 }
 
 }
 

-/*static*/ wxString wxArtProviderCache::ConstructHashID(
-                                const wxArtID& id, const wxArtClient& client,
-                                const wxSize& size)
+/* static */ wxString
+wxArtProviderCache::ConstructHashID(const wxArtID& id,
+                                    const wxArtClient& client)

 {
 {

-    wxString str;
-    str.Printf(wxT("%s-%s-%i-%i"), id.c_str(), client.c_str(), size.x, size.y);
-    return str;
+    return id + _T('-') + client;

 }
 
 
 }
 
 

-// ----------------------------------------------------------------------------
+/* static */ wxString
+wxArtProviderCache::ConstructHashID(const wxArtID& id,
+                                    const wxArtClient& client,
+                                    const wxSize& size)
+{
+    return ConstructHashID(id, client) + _T('-') +
+            wxString::Format(_T("%d-%d"), size.x, size.y);
+}
+
+// ============================================================================

 // wxArtProvider class
 // wxArtProvider class

-// ----------------------------------------------------------------------------
+// ============================================================================

 
 IMPLEMENT_ABSTRACT_CLASS(wxArtProvider, wxObject)
 
 wxArtProvidersList *wxArtProvider::sm_providers = NULL;
 wxArtProviderCache *wxArtProvider::sm_cache = NULL;
 
 
 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 )
     {
         sm_providers = new wxArtProvidersList;
 {
     if ( !sm_providers )
     {
         sm_providers = new wxArtProvidersList;

-        sm_providers->DeleteContents(TRUE);

         sm_cache = new wxArtProviderCache;
     }
 
         sm_cache = new wxArtProviderCache;
     }
 

-    sm_providers->Insert(provider);

     sm_cache->Clear();
 }
 
     sm_cache->Clear();
 }
 

-/*static*/ bool wxArtProvider::PopProvider()
+/*static*/ void wxArtProvider::Push(wxArtProvider *provider)
+{
+    CommonAddingProvider();
+    sm_providers->Insert(provider);
+}
+
+/*static*/ void wxArtProvider::Insert(wxArtProvider *provider)

 {
 {

-    wxCHECK_MSG( sm_providers, FALSE, _T("no wxArtProvider exists") );
-    wxCHECK_MSG( sm_providers->GetCount() > 0, FALSE, _T("wxArtProviders stack is empty") );
+    CommonAddingProvider();
+    sm_providers->Append(provider);
+}

 
 

-    sm_providers->DeleteNode(sm_providers->GetFirst());
+/*static*/ bool wxArtProvider::Pop()
+{
+    wxCHECK_MSG( sm_providers, false, _T("no wxArtProvider exists") );
+    wxCHECK_MSG( !sm_providers->empty(), false, _T("wxArtProviders stack is empty") );
+
+    delete sm_providers->GetFirst()->GetData();

     sm_cache->Clear();
     sm_cache->Clear();

-    return TRUE;
+    return true;

 }
 
 }
 

-/*static*/ bool wxArtProvider::RemoveProvider(wxArtProvider *provider)
+/*static*/ bool wxArtProvider::Remove(wxArtProvider *provider)

 {
 {

-    wxCHECK_MSG( sm_providers, FALSE, _T("no wxArtProvider exists") );
+    wxCHECK_MSG( sm_providers, false, _T("no wxArtProvider exists") );

 
     if ( sm_providers->DeleteObject(provider) )
     {
         sm_cache->Clear();
 
     if ( sm_providers->DeleteObject(provider) )
     {
         sm_cache->Clear();

-        return TRUE;
+        return true;

     }
 
     }
 

-    return FALSE;
+    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()
 {
 }
 
 /*static*/ void wxArtProvider::CleanUpProviders()
 {

-    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& size)
 /*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtID& id,
                                              const wxArtClient& client,
                                              const wxSize& size)


@@ -165,12 +230,13 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL;
     wxBitmap bmp;
     if ( !sm_cache->GetBitmap(hashId, &bmp) )
     {
     wxBitmap bmp;
     if ( !sm_cache->GetBitmap(hashId, &bmp) )
     {

-        for (wxArtProvidersList::Node *node = sm_providers->GetFirst();
+        for (wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();

              node; node = node->GetNext())
         {
             bmp = node->GetData()->CreateBitmap(id, client, size);
             if ( bmp.Ok() )
             {
              node; node = node->GetNext())
         {
             bmp = node->GetData()->CreateBitmap(id, client, size);
             if ( bmp.Ok() )
             {

+#if wxUSE_IMAGE && (!defined(__WXMSW__) || wxUSE_WXDIB)

                 if ( size != wxDefaultSize &&
                      (bmp.GetWidth() != size.x || bmp.GetHeight() != size.y) )
                 {
                 if ( size != wxDefaultSize &&
                      (bmp.GetWidth() != size.x || bmp.GetHeight() != size.y) )
                 {


@@ -178,22 +244,56 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL;
                     img.Rescale(size.x, size.y);
                     bmp = wxBitmap(img);
                 }
                     img.Rescale(size.x, size.y);
                     bmp = wxBitmap(img);
                 }

+#endif

                 break;
             }
                 break;
             }

+            // We could try the IconBundles here and convert what we find
+            // to a bitmap.

         }
         }

-

         sm_cache->PutBitmap(hashId, bmp);
         sm_cache->PutBitmap(hashId, bmp);

-    }
+        }

 
     return bmp;
 }
 
 
     return bmp;
 }
 

+/*static*/ wxIconBundle wxArtProvider::GetIconBundle(const wxArtID& id, const wxArtClient& client)
+{
+    // 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, wxNullIconBundle, _T("no wxArtProvider exists") );
+
+    wxString hashId = wxArtProviderCache::ConstructHashID(id, client);
+
+    wxIconBundle iconbundle;
+    if ( !sm_cache->GetIconBundle(hashId, &iconbundle) )
+    {
+        for (wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();
+             node; node = node->GetNext())
+        {
+            iconbundle = node->GetData()->CreateIconBundle(id, client);
+            if ( iconbundle.IsOk() )
+                break;
+        }
+
+        sm_cache->PutIconBundle(hashId, iconbundle);
+    }
+
+    return iconbundle;
+}
+

 /*static*/ wxIcon wxArtProvider::GetIcon(const wxArtID& id,
                                          const wxArtClient& client,
                                          const wxSize& size)
 {
     wxCHECK_MSG( sm_providers, wxNullIcon, _T("no wxArtProvider exists") );
 
 /*static*/ wxIcon wxArtProvider::GetIcon(const wxArtID& id,
                                          const wxArtClient& client,
                                          const wxSize& size)
 {
     wxCHECK_MSG( sm_providers, wxNullIcon, _T("no wxArtProvider exists") );
 

+    // First look for an appropriate icon bundle - this will give us the best icon
+    wxIconBundle iconBundle = GetIconBundle(id, client);
+    if ( iconBundle.IsOk() )
+        return iconBundle.GetIcon(size);
+
+    // If there is no icon bundle then look for a bitmap

     wxBitmap bmp = GetBitmap(id, client, size);
     if ( !bmp.Ok() )
         return wxNullIcon;
     wxBitmap bmp = GetBitmap(id, client, size);
     if ( !bmp.Ok() )
         return wxNullIcon;


@@ -203,12 +303,98 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL;
     return icon;
 }
 
     return icon;
 }
 

+#if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)
+    #include "wx/gtk/private.h"
+    extern GtkIconSize wxArtClientToIconSize(const wxArtClient& client);
+#endif // defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)
+
+/*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()->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(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 // 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
 {
 public:
 
 class wxArtProviderModule: public wxModule
 {
 public:

-    bool OnInit() { return TRUE; }
-    void OnExit() { wxArtProvider::CleanUpProviders(); }
+    bool OnInit()
+    {
+        wxArtProvider::InitStdProvider();
+        wxArtProvider::InitNativeProvider();
+        return true;
+    }
+    void OnExit()
+    {
+        wxArtProvider::CleanUpProviders();
+    }

 
     DECLARE_DYNAMIC_CLASS(wxArtProviderModule)
 };
 
     DECLARE_DYNAMIC_CLASS(wxArtProviderModule)
 };