/////////////////////////////////////////////////////////////////////////////
-// Name: artprov.cpp
+// Name: src/common/artprov.cpp
// Purpose: wxArtProvider class
// Author: Vaclav Slavik
// Modified by:
// Created: 18/03/2002
// RCS-ID: $Id$
// Copyright: (c) Vaclav Slavik
-// Licence: wxWidgets licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ---------------------------------------------------------------------------
// 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"
+ #include "wx/log.h"
+ #include "wx/hashmap.h"
+ #include "wx/image.h"
+ #include "wx/module.h"
#endif
-#include "wx/artprov.h"
-#include "wx/hashmap.h"
-#include "wx/module.h"
-#if wxUSE_IMAGE
-#include "wx/image.h"
-#endif
-
-// For the purposes of forcing this module to link
-extern char g_ArtProviderModule;
-
// ===========================================================================
// 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);
+WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxIconBundle, wxArtProviderIconBundlesHash);
class WXDLLEXPORT wxArtProviderCache
{
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)
wxArtProviderBitmapsHash::iterator entry = m_bitmapsHash.find(full_id);
if ( entry == m_bitmapsHash.end() )
{
- return FALSE;
+ return false;
}
else
{
*bmp = entry->second;
- return TRUE;
+ 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;
+ return true;
}
}
void wxArtProviderCache::Clear()
{
- // Hack to make the default provider link
- // with the application
- g_ArtProviderModule = 0;
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 )
{
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::PushBack(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, 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;
+ 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;
+ 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()
{
- 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& 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);
{
bmp = node->GetData()->CreateBitmap(id, client, size);
if ( bmp.Ok() )
+ break;
+ }
+
+ wxSize sizeNeeded = size;
+ if ( !bmp.Ok() )
+ {
+ // 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;
return icon;
}
+/* 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)
+{
+ if (!platform_dependent)
+ {
+ wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst();
+ if (node)
+ return node->GetData()->DoGetSizeHint(client);
+ }
+
+ 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
{
bool OnInit()
{
wxArtProvider::InitStdProvider();
- return TRUE;
+ wxArtProvider::InitNativeProvider();
+ return true;
}
void OnExit()
{
projects / wxWidgets.git / blobdiff