]> git.saurik.com Git - wxWidgets.git/blame - src/common/artprov.cpp
surround deprecated wxImage methods in WXWIN_COMPATIBILITY_2_2
[wxWidgets.git] / src / common / artprov.cpp
CommitLineData
2aca4a98
VS
1/////////////////////////////////////////////////////////////////////////////
2// Name: artprov.cpp
3// Purpose: wxArtProvider class
4// Author: Vaclav Slavik
5// Modified by:
6// Created: 18/03/2002
7// RCS-ID: $Id$
8// Copyright: (c) Vaclav Slavik
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12// ---------------------------------------------------------------------------
13// headers
14// ---------------------------------------------------------------------------
15
16#ifdef __GNUG__
17 #pragma implementation "artprov.h"
18#endif
19
20// For compilers that support precompilation, includes "wx.h".
21#include "wx/wxprec.h"
22
23#if defined(__BORLANDC__)
24 #pragma hdrstop
25#endif
26
27#ifndef WX_PRECOMP
28 #include "wx/log.h"
29 #include "wx/list.h"
30#endif
31
32#include "wx/artprov.h"
33#include "wx/hashmap.h"
34#include "wx/module.h"
3242feb1 35#include "wx/image.h"
2aca4a98 36
e5f4aeb6
JS
37// For the purposes of forcing this module to link
38extern char g_ArtProviderModule;
2aca4a98
VS
39
40// ===========================================================================
41// implementation
42// ===========================================================================
43
44#include "wx/listimpl.cpp"
45WX_DECLARE_LIST(wxArtProvider, wxArtProvidersList);
46WX_DEFINE_LIST(wxArtProvidersList);
47
48// ----------------------------------------------------------------------------
49// Cache class - stores already requested bitmaps
50// ----------------------------------------------------------------------------
51
52WX_DECLARE_STRING_HASH_MAP(wxBitmap, wxArtProviderBitmapsHash);
53
54class WXDLLEXPORT wxArtProviderCache
55{
56public:
57 bool GetBitmap(const wxString& full_id, wxBitmap* bmp);
58 void PutBitmap(const wxString& full_id, const wxBitmap& bmp)
59 { m_bitmapsHash[full_id] = bmp; }
60
61 void Clear();
62
57b0987b
VS
63 static wxString ConstructHashID(const wxArtID& id,
64 const wxArtClient& client,
2aca4a98
VS
65 const wxSize& size);
66
67private:
68 wxArtProviderBitmapsHash m_bitmapsHash;
69};
70
71bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp)
72{
73 wxArtProviderBitmapsHash::iterator entry = m_bitmapsHash.find(full_id);
74 if ( entry == m_bitmapsHash.end() )
75 {
76 return FALSE;
77 }
78 else
79 {
80 *bmp = entry->second;
81 return TRUE;
82 }
83}
84
85void wxArtProviderCache::Clear()
86{
e5f4aeb6
JS
87 // Hack to make the default provider link
88 // with the application
89 g_ArtProviderModule = 0;
2aca4a98
VS
90 m_bitmapsHash.clear();
91}
92
93/*static*/ wxString wxArtProviderCache::ConstructHashID(
57b0987b
VS
94 const wxArtID& id, const wxArtClient& client,
95 const wxSize& size)
2aca4a98
VS
96{
97 wxString str;
57b0987b 98 str.Printf(wxT("%s-%s-%i-%i"), id.c_str(), client.c_str(), size.x, size.y);
2aca4a98
VS
99 return str;
100}
101
102
103// ----------------------------------------------------------------------------
104// wxArtProvider class
105// ----------------------------------------------------------------------------
106
107IMPLEMENT_ABSTRACT_CLASS(wxArtProvider, wxObject)
108
109wxArtProvidersList *wxArtProvider::sm_providers = NULL;
110wxArtProviderCache *wxArtProvider::sm_cache = NULL;
111
112/*static*/ void wxArtProvider::PushProvider(wxArtProvider *provider)
113{
114 if ( !sm_providers )
115 {
116 sm_providers = new wxArtProvidersList;
117 sm_providers->DeleteContents(TRUE);
118 sm_cache = new wxArtProviderCache;
119 }
120
121 sm_providers->Insert(provider);
122}
123
124/*static*/ bool wxArtProvider::PopProvider()
125{
126 wxCHECK_MSG( sm_providers, FALSE, _T("no wxArtProvider exists") );
127 wxCHECK_MSG( sm_providers->GetCount() > 0, FALSE, _T("wxArtProviders stack is empty") );
128
129 sm_providers->DeleteNode(sm_providers->GetFirst());
130 sm_cache->Clear();
131 return TRUE;
132}
133
134/*static*/ bool wxArtProvider::RemoveProvider(wxArtProvider *provider)
135{
136 wxCHECK_MSG( sm_providers, FALSE, _T("no wxArtProvider exists") );
137
138 if ( sm_providers->DeleteObject(provider) )
139 {
140 sm_cache->Clear();
141 return TRUE;
142 }
143
144 return FALSE;
145}
146
147/*static*/ void wxArtProvider::CleanUpProviders()
148{
149 wxDELETE(sm_providers);
150 wxDELETE(sm_cache);
151}
152
57b0987b
VS
153/*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtID& id,
154 const wxArtClient& client,
2aca4a98
VS
155 const wxSize& size)
156{
57b0987b
VS
157 // safety-check against writing client,id,size instead of id,client,size:
158 wxASSERT_MSG( client.Last() == _T('C'), _T("invalid 'client' parameter") );
159
2aca4a98
VS
160 wxCHECK_MSG( sm_providers, wxNullBitmap, _T("no wxArtProvider exists") );
161
57b0987b 162 wxString hashId = wxArtProviderCache::ConstructHashID(id, client, size);
2aca4a98
VS
163
164 wxBitmap bmp;
165 if ( !sm_cache->GetBitmap(hashId, &bmp) )
166 {
167 for (wxArtProvidersList::Node *node = sm_providers->GetFirst();
168 node; node = node->GetNext())
169 {
57b0987b 170 bmp = node->GetData()->CreateBitmap(id, client, size);
2aca4a98 171 if ( bmp.Ok() )
3242feb1
VS
172 {
173 if ( size != wxDefaultSize &&
174 (bmp.GetWidth() != size.x || bmp.GetHeight() != size.y) )
175 {
176 wxImage img = bmp.ConvertToImage();
177 img.Rescale(size.x, size.y);
178 bmp = wxBitmap(img);
179 }
2aca4a98 180 break;
3242feb1 181 }
2aca4a98 182 }
3242feb1 183
2aca4a98
VS
184 sm_cache->PutBitmap(hashId, bmp);
185 }
186
187 return bmp;
188}
189
57b0987b
VS
190/*static*/ wxIcon wxArtProvider::GetIcon(const wxArtID& id,
191 const wxArtClient& client,
2aca4a98
VS
192 const wxSize& size)
193{
194 wxCHECK_MSG( sm_providers, wxNullIcon, _T("no wxArtProvider exists") );
195
57b0987b 196 wxBitmap bmp = GetBitmap(id, client, size);
2aca4a98
VS
197 if ( bmp.Ok() )
198 {
199 wxIcon icon;
200 icon.CopyFromBitmap(bmp);
201 return icon;
202 }
203 else
204 {
205 return wxNullIcon;
206 }
207}
208
209
210
211class wxArtProviderModule: public wxModule
212{
213public:
214 bool OnInit() { return TRUE; }
215 void OnExit() { wxArtProvider::CleanUpProviders(); }
216
217 DECLARE_DYNAMIC_CLASS(wxArtProviderModule)
218};
219
220IMPLEMENT_DYNAMIC_CLASS(wxArtProviderModule, wxModule)