X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/abc736fd0eb6be85b0c091b078cebe96f5e4393f..57d3e26697255a5c5154b4a0dc26d6eab23ff871:/src/common/artprov.cpp diff --git a/src/common/artprov.cpp b/src/common/artprov.cpp index c0c91304cb..69c6928528 100644 --- 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: @@ -13,10 +13,6 @@ // 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" @@ -24,16 +20,14 @@ #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,13 +36,14 @@ #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); +WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxIconBundle, wxArtProviderIconBundlesHash); class WXDLLEXPORT wxArtProviderCache { @@ -57,14 +52,22 @@ public: 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); + static wxString ConstructHashID(const wxArtID& id, + const wxArtClient& client); + 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) @@ -81,31 +84,66 @@ bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp) } } +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; + return true; + } +} + void wxArtProviderCache::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 + wxT('-') + client; } -// ---------------------------------------------------------------------------- +/* static */ wxString +wxArtProviderCache::ConstructHashID(const wxArtID& id, + const wxArtClient& client, + const wxSize& size) +{ + return ConstructHashID(id, client) + wxT('-') + + wxString::Format(wxT("%d-%d"), size.x, size.y); +} + +// ============================================================================ // 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 +151,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) { - wxCHECK_MSG( sm_providers, false, _T("no wxArtProvider exists") ); - wxCHECK_MSG( sm_providers->GetCount() > 0, false, _T("wxArtProviders stack is empty") ); + CommonAddingProvider(); + sm_providers->Insert(provider); +} + +/*static*/ void wxArtProvider::PushBack(wxArtProvider *provider) +{ + CommonAddingProvider(); + sm_providers->Append(provider); +} + +/*static*/ bool wxArtProvider::Pop() +{ + wxCHECK_MSG( sm_providers, false, wxT("no wxArtProvider exists") ); + wxCHECK_MSG( !sm_providers->empty(), false, wxT("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") ); + wxCHECK_MSG( sm_providers, false, wxT("no wxArtProvider exists") ); if ( sm_providers->DeleteObject(provider) ) { - delete provider; sm_cache->Clear(); return true; } @@ -142,21 +189,38 @@ 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(); + + wxDELETE(sm_providers); + wxDELETE(sm_cache); + } } +// ---------------------------------------------------------------------------- +// wxArtProvider: retrieving bitmaps/icons +// ---------------------------------------------------------------------------- + /*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtID& id, const wxArtClient& client, 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") ); + wxASSERT_MSG( client.Last() == wxT('C'), wxT("invalid 'client' parameter") ); - wxCHECK_MSG( sm_providers, wxNullBitmap, _T("no wxArtProvider exists") ); + wxCHECK_MSG( sm_providers, wxNullBitmap, wxT("no wxArtProvider exists") ); wxString hashId = wxArtProviderCache::ConstructHashID(id, client, size); @@ -167,35 +231,100 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL; node; node = node->GetNext()) { bmp = node->GetData()->CreateBitmap(id, client, size); - if ( bmp.Ok() ) + if ( bmp.IsOk() ) + break; + } + + wxSize sizeNeeded = size; + if ( !bmp.IsOk() ) + { + // no bitmap created -- as a fallback, try if we can find desired + // icon in a bundle + wxIconBundle iconBundle = DoGetIconBundle(id, client); + if ( iconBundle.IsOk() ) { -#if wxUSE_IMAGE - if ( size != wxDefaultSize && - (bmp.GetWidth() != size.x || bmp.GetHeight() != size.y) ) + if ( sizeNeeded == wxDefaultSize ) + sizeNeeded = GetNativeSizeHint(client); + + wxIcon icon(iconBundle.GetIcon(sizeNeeded)); + if ( icon.IsOk() ) { - wxImage img = bmp.ConvertToImage(); - img.Rescale(size.x, size.y); - bmp = wxBitmap(img); + // this icon may be not of the correct size, it will be + // rescaled below in such case + bmp.CopyFromIcon(icon); } -#endif - break; } } + // if we didn't get the correct size, resize the bitmap +#if wxUSE_IMAGE && (!defined(__WXMSW__) || wxUSE_WXDIB) + if ( bmp.IsOk() && sizeNeeded != wxDefaultSize ) + { + if ( bmp.GetSize() != sizeNeeded ) + { + wxImage img = bmp.ConvertToImage(); + img.Rescale(sizeNeeded.x, sizeNeeded.y); + bmp = wxBitmap(img); + } + } +#endif // wxUSE_IMAGE + sm_cache->PutBitmap(hashId, bmp); } return bmp; } +/*static*/ +wxIconBundle wxArtProvider::GetIconBundle(const wxArtID& id, const wxArtClient& client) +{ + wxIconBundle iconbundle(DoGetIconBundle(id, client)); + + if ( iconbundle.IsOk() ) + { + return iconbundle; + } + else + { + // fall back to single-icon bundle + return wxIconBundle(GetIcon(id, client)); + } +} + +/*static*/ +wxIconBundle wxArtProvider::DoGetIconBundle(const wxArtID& id, const wxArtClient& client) +{ + // safety-check against writing client,id,size instead of id,client,size: + wxASSERT_MSG( client.Last() == wxT('C'), wxT("invalid 'client' parameter") ); + + wxCHECK_MSG( sm_providers, wxNullIconBundle, wxT("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") ); - wxBitmap bmp = GetBitmap(id, client, size); - if ( !bmp.Ok() ) + + if ( !bmp.IsOk() ) return wxNullIcon; wxIcon icon; @@ -203,10 +332,28 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL; return icon; } -#if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__) - #include "wx/gtk/private.h" - extern GtkIconSize wxArtClientToIconSize(const wxArtClient& client); -#endif // defined(__WXGTK20__) && !defined(__WXUNIVERSAL__) +/* static */ +wxArtID wxArtProvider::GetMessageBoxIconId(int flags) +{ + switch ( flags & wxICON_MASK ) + { + default: + wxFAIL_MSG(wxT("incorrect message box icon flags")); + // fall through + + case wxICON_ERROR: + return wxART_ERROR; + + case wxICON_INFORMATION: + return wxART_INFORMATION; + + case wxICON_WARNING: + return wxART_WARNING; + + case wxICON_QUESTION: + return wxART_QUESTION; + } +} /*static*/ wxSize wxArtProvider::GetSizeHint(const wxArtClient& client, bool platform_dependent) @@ -218,43 +365,87 @@ wxArtProviderCache *wxArtProvider::sm_cache = NULL; 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 + return GetNativeSizeHint(client); +} + +#ifndef wxHAS_NATIVE_ART_PROVIDER_IMPL +/*static*/ +wxSize wxArtProvider::GetNativeSizeHint(const wxArtClient& WXUNUSED(client)) +{ + // rather than returning some arbitrary value that doesn't make much + // sense (as 2.8 used to do), tell the caller that we don't have a clue: + return wxDefaultSize; +} + +/*static*/ +void wxArtProvider::InitNativeProvider() +{ +} +#endif // !wxHAS_NATIVE_ART_PROVIDER_IMPL + + +/* static */ +bool wxArtProvider::HasNativeProvider() +{ +#ifdef __WXGTK20__ + return true; +#else + return false; +#endif +} + +// ---------------------------------------------------------------------------- +// 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 + +#if WXWIN_COMPATIBILITY_2_8 +/* static */ void wxArtProvider::Insert(wxArtProvider *provider) +{ + PushBack(provider); } +#endif // WXWIN_COMPATIBILITY_2_8 +// ============================================================================ +// wxArtProviderModule +// ============================================================================ class wxArtProviderModule: public wxModule { public: bool OnInit() { +#if wxUSE_ARTPROVIDER_STD wxArtProvider::InitStdProvider(); +#endif // wxUSE_ARTPROVIDER_STD +#if wxUSE_ARTPROVIDER_TANGO + wxArtProvider::InitTangoProvider(); +#endif // wxUSE_ARTPROVIDER_TANGO wxArtProvider::InitNativeProvider(); return true; }