]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: src/common/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 | // For compilers that support precompilation, includes "wx.h". | |
17 | #include "wx/wxprec.h" | |
18 | ||
19 | #if defined(__BORLANDC__) | |
20 | #pragma hdrstop | |
21 | #endif | |
22 | ||
23 | #include "wx/artprov.h" | |
24 | ||
25 | #ifndef WX_PRECOMP | |
26 | #include "wx/list.h" | |
27 | #include "wx/log.h" | |
28 | #include "wx/hashmap.h" | |
29 | #include "wx/image.h" | |
30 | #include "wx/module.h" | |
31 | #endif | |
32 | ||
33 | // =========================================================================== | |
34 | // implementation | |
35 | // =========================================================================== | |
36 | ||
37 | #include "wx/listimpl.cpp" | |
38 | WX_DECLARE_LIST(wxArtProvider, wxArtProvidersList); | |
39 | WX_DEFINE_LIST(wxArtProvidersList) | |
40 | ||
41 | // ---------------------------------------------------------------------------- | |
42 | // Cache class - stores already requested bitmaps | |
43 | // ---------------------------------------------------------------------------- | |
44 | ||
45 | WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxBitmap, wxArtProviderBitmapsHash); | |
46 | WX_DECLARE_EXPORTED_STRING_HASH_MAP(wxIconBundle, wxArtProviderIconBundlesHash); | |
47 | ||
48 | class WXDLLEXPORT wxArtProviderCache | |
49 | { | |
50 | public: | |
51 | bool GetBitmap(const wxString& full_id, wxBitmap* bmp); | |
52 | void PutBitmap(const wxString& full_id, const wxBitmap& bmp) | |
53 | { m_bitmapsHash[full_id] = bmp; } | |
54 | ||
55 | bool GetIconBundle(const wxString& full_id, wxIconBundle* bmp); | |
56 | void PutIconBundle(const wxString& full_id, const wxIconBundle& iconbundle) | |
57 | { m_iconBundlesHash[full_id] = iconbundle; } | |
58 | ||
59 | void Clear(); | |
60 | ||
61 | static wxString ConstructHashID(const wxArtID& id, | |
62 | const wxArtClient& client, | |
63 | const wxSize& size); | |
64 | ||
65 | static wxString ConstructHashID(const wxArtID& id, | |
66 | const wxArtClient& client); | |
67 | ||
68 | private: | |
69 | wxArtProviderBitmapsHash m_bitmapsHash; // cache of wxBitmaps | |
70 | wxArtProviderIconBundlesHash m_iconBundlesHash; // cache of wxIconBundles | |
71 | }; | |
72 | ||
73 | bool wxArtProviderCache::GetBitmap(const wxString& full_id, wxBitmap* bmp) | |
74 | { | |
75 | wxArtProviderBitmapsHash::iterator entry = m_bitmapsHash.find(full_id); | |
76 | if ( entry == m_bitmapsHash.end() ) | |
77 | { | |
78 | return false; | |
79 | } | |
80 | else | |
81 | { | |
82 | *bmp = entry->second; | |
83 | return true; | |
84 | } | |
85 | } | |
86 | ||
87 | bool wxArtProviderCache::GetIconBundle(const wxString& full_id, wxIconBundle* bmp) | |
88 | { | |
89 | wxArtProviderIconBundlesHash::iterator entry = m_iconBundlesHash.find(full_id); | |
90 | if ( entry == m_iconBundlesHash.end() ) | |
91 | { | |
92 | return false; | |
93 | } | |
94 | else | |
95 | { | |
96 | *bmp = entry->second; | |
97 | return true; | |
98 | } | |
99 | } | |
100 | ||
101 | void wxArtProviderCache::Clear() | |
102 | { | |
103 | m_bitmapsHash.clear(); | |
104 | m_iconBundlesHash.clear(); | |
105 | } | |
106 | ||
107 | /* static */ wxString | |
108 | wxArtProviderCache::ConstructHashID(const wxArtID& id, | |
109 | const wxArtClient& client) | |
110 | { | |
111 | return id + wxT('-') + client; | |
112 | } | |
113 | ||
114 | ||
115 | /* static */ wxString | |
116 | wxArtProviderCache::ConstructHashID(const wxArtID& id, | |
117 | const wxArtClient& client, | |
118 | const wxSize& size) | |
119 | { | |
120 | return ConstructHashID(id, client) + wxT('-') + | |
121 | wxString::Format(wxT("%d-%d"), size.x, size.y); | |
122 | } | |
123 | ||
124 | // ============================================================================ | |
125 | // wxArtProvider class | |
126 | // ============================================================================ | |
127 | ||
128 | IMPLEMENT_ABSTRACT_CLASS(wxArtProvider, wxObject) | |
129 | ||
130 | wxArtProvidersList *wxArtProvider::sm_providers = NULL; | |
131 | wxArtProviderCache *wxArtProvider::sm_cache = NULL; | |
132 | ||
133 | // ---------------------------------------------------------------------------- | |
134 | // wxArtProvider ctors/dtor | |
135 | // ---------------------------------------------------------------------------- | |
136 | ||
137 | wxArtProvider::~wxArtProvider() | |
138 | { | |
139 | Remove(this); | |
140 | } | |
141 | ||
142 | // ---------------------------------------------------------------------------- | |
143 | // wxArtProvider operations on provider stack | |
144 | // ---------------------------------------------------------------------------- | |
145 | ||
146 | /*static*/ void wxArtProvider::CommonAddingProvider() | |
147 | { | |
148 | if ( !sm_providers ) | |
149 | { | |
150 | sm_providers = new wxArtProvidersList; | |
151 | sm_cache = new wxArtProviderCache; | |
152 | } | |
153 | ||
154 | sm_cache->Clear(); | |
155 | } | |
156 | ||
157 | /*static*/ void wxArtProvider::Push(wxArtProvider *provider) | |
158 | { | |
159 | CommonAddingProvider(); | |
160 | sm_providers->Insert(provider); | |
161 | } | |
162 | ||
163 | /*static*/ void wxArtProvider::PushBack(wxArtProvider *provider) | |
164 | { | |
165 | CommonAddingProvider(); | |
166 | sm_providers->Append(provider); | |
167 | } | |
168 | ||
169 | /*static*/ bool wxArtProvider::Pop() | |
170 | { | |
171 | wxCHECK_MSG( sm_providers, false, wxT("no wxArtProvider exists") ); | |
172 | wxCHECK_MSG( !sm_providers->empty(), false, wxT("wxArtProviders stack is empty") ); | |
173 | ||
174 | delete sm_providers->GetFirst()->GetData(); | |
175 | sm_cache->Clear(); | |
176 | return true; | |
177 | } | |
178 | ||
179 | /*static*/ bool wxArtProvider::Remove(wxArtProvider *provider) | |
180 | { | |
181 | wxCHECK_MSG( sm_providers, false, wxT("no wxArtProvider exists") ); | |
182 | ||
183 | if ( sm_providers->DeleteObject(provider) ) | |
184 | { | |
185 | sm_cache->Clear(); | |
186 | return true; | |
187 | } | |
188 | ||
189 | return false; | |
190 | } | |
191 | ||
192 | /*static*/ bool wxArtProvider::Delete(wxArtProvider *provider) | |
193 | { | |
194 | // provider will remove itself from the stack in its dtor | |
195 | delete provider; | |
196 | ||
197 | return true; | |
198 | } | |
199 | ||
200 | /*static*/ void wxArtProvider::CleanUpProviders() | |
201 | { | |
202 | if ( sm_providers ) | |
203 | { | |
204 | while ( !sm_providers->empty() ) | |
205 | delete *sm_providers->begin(); | |
206 | ||
207 | delete sm_providers; | |
208 | sm_providers = NULL; | |
209 | ||
210 | delete sm_cache; | |
211 | sm_cache = NULL; | |
212 | } | |
213 | } | |
214 | ||
215 | // ---------------------------------------------------------------------------- | |
216 | // wxArtProvider: retrieving bitmaps/icons | |
217 | // ---------------------------------------------------------------------------- | |
218 | ||
219 | /*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtID& id, | |
220 | const wxArtClient& client, | |
221 | const wxSize& size) | |
222 | { | |
223 | // safety-check against writing client,id,size instead of id,client,size: | |
224 | wxASSERT_MSG( client.Last() == wxT('C'), wxT("invalid 'client' parameter") ); | |
225 | ||
226 | wxCHECK_MSG( sm_providers, wxNullBitmap, wxT("no wxArtProvider exists") ); | |
227 | ||
228 | wxString hashId = wxArtProviderCache::ConstructHashID(id, client, size); | |
229 | ||
230 | wxBitmap bmp; | |
231 | if ( !sm_cache->GetBitmap(hashId, &bmp) ) | |
232 | { | |
233 | for (wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst(); | |
234 | node; node = node->GetNext()) | |
235 | { | |
236 | bmp = node->GetData()->CreateBitmap(id, client, size); | |
237 | if ( bmp.Ok() ) | |
238 | break; | |
239 | } | |
240 | ||
241 | wxSize sizeNeeded = size; | |
242 | if ( !bmp.Ok() ) | |
243 | { | |
244 | // no bitmap created -- as a fallback, try if we can find desired | |
245 | // icon in a bundle | |
246 | wxIconBundle iconBundle = DoGetIconBundle(id, client); | |
247 | if ( iconBundle.IsOk() ) | |
248 | { | |
249 | if ( sizeNeeded == wxDefaultSize ) | |
250 | sizeNeeded = GetNativeSizeHint(client); | |
251 | ||
252 | wxIcon icon(iconBundle.GetIcon(sizeNeeded)); | |
253 | if ( icon.IsOk() ) | |
254 | { | |
255 | // this icon may be not of the correct size, it will be | |
256 | // rescaled below in such case | |
257 | bmp.CopyFromIcon(icon); | |
258 | } | |
259 | } | |
260 | } | |
261 | ||
262 | // if we didn't get the correct size, resize the bitmap | |
263 | #if wxUSE_IMAGE && (!defined(__WXMSW__) || wxUSE_WXDIB) | |
264 | if ( bmp.IsOk() && sizeNeeded != wxDefaultSize ) | |
265 | { | |
266 | if ( bmp.GetSize() != sizeNeeded ) | |
267 | { | |
268 | wxImage img = bmp.ConvertToImage(); | |
269 | img.Rescale(sizeNeeded.x, sizeNeeded.y); | |
270 | bmp = wxBitmap(img); | |
271 | } | |
272 | } | |
273 | #endif // wxUSE_IMAGE | |
274 | ||
275 | sm_cache->PutBitmap(hashId, bmp); | |
276 | } | |
277 | ||
278 | return bmp; | |
279 | } | |
280 | ||
281 | /*static*/ | |
282 | wxIconBundle wxArtProvider::GetIconBundle(const wxArtID& id, const wxArtClient& client) | |
283 | { | |
284 | wxIconBundle iconbundle(DoGetIconBundle(id, client)); | |
285 | ||
286 | if ( iconbundle.IsOk() ) | |
287 | { | |
288 | return iconbundle; | |
289 | } | |
290 | else | |
291 | { | |
292 | // fall back to single-icon bundle | |
293 | return wxIconBundle(GetIcon(id, client)); | |
294 | } | |
295 | } | |
296 | ||
297 | /*static*/ | |
298 | wxIconBundle wxArtProvider::DoGetIconBundle(const wxArtID& id, const wxArtClient& client) | |
299 | { | |
300 | // safety-check against writing client,id,size instead of id,client,size: | |
301 | wxASSERT_MSG( client.Last() == wxT('C'), wxT("invalid 'client' parameter") ); | |
302 | ||
303 | wxCHECK_MSG( sm_providers, wxNullIconBundle, wxT("no wxArtProvider exists") ); | |
304 | ||
305 | wxString hashId = wxArtProviderCache::ConstructHashID(id, client); | |
306 | ||
307 | wxIconBundle iconbundle; | |
308 | if ( !sm_cache->GetIconBundle(hashId, &iconbundle) ) | |
309 | { | |
310 | for (wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst(); | |
311 | node; node = node->GetNext()) | |
312 | { | |
313 | iconbundle = node->GetData()->CreateIconBundle(id, client); | |
314 | if ( iconbundle.IsOk() ) | |
315 | break; | |
316 | } | |
317 | ||
318 | sm_cache->PutIconBundle(hashId, iconbundle); | |
319 | } | |
320 | ||
321 | return iconbundle; | |
322 | } | |
323 | ||
324 | /*static*/ wxIcon wxArtProvider::GetIcon(const wxArtID& id, | |
325 | const wxArtClient& client, | |
326 | const wxSize& size) | |
327 | { | |
328 | wxBitmap bmp = GetBitmap(id, client, size); | |
329 | ||
330 | if ( !bmp.IsOk() ) | |
331 | return wxNullIcon; | |
332 | ||
333 | wxIcon icon; | |
334 | icon.CopyFromBitmap(bmp); | |
335 | return icon; | |
336 | } | |
337 | ||
338 | /* static */ | |
339 | wxArtID wxArtProvider::GetMessageBoxIconId(int flags) | |
340 | { | |
341 | switch ( flags & wxICON_MASK ) | |
342 | { | |
343 | default: | |
344 | wxFAIL_MSG(wxT("incorrect message box icon flags")); | |
345 | // fall through | |
346 | ||
347 | case wxICON_ERROR: | |
348 | return wxART_ERROR; | |
349 | ||
350 | case wxICON_INFORMATION: | |
351 | return wxART_INFORMATION; | |
352 | ||
353 | case wxICON_WARNING: | |
354 | return wxART_WARNING; | |
355 | ||
356 | case wxICON_QUESTION: | |
357 | return wxART_QUESTION; | |
358 | } | |
359 | } | |
360 | ||
361 | /*static*/ wxSize wxArtProvider::GetSizeHint(const wxArtClient& client, | |
362 | bool platform_dependent) | |
363 | { | |
364 | if (!platform_dependent) | |
365 | { | |
366 | wxArtProvidersList::compatibility_iterator node = sm_providers->GetFirst(); | |
367 | if (node) | |
368 | return node->GetData()->DoGetSizeHint(client); | |
369 | } | |
370 | ||
371 | return GetNativeSizeHint(client); | |
372 | } | |
373 | ||
374 | #ifndef wxHAS_NATIVE_ART_PROVIDER_IMPL | |
375 | /*static*/ | |
376 | wxSize wxArtProvider::GetNativeSizeHint(const wxArtClient& WXUNUSED(client)) | |
377 | { | |
378 | // rather than returning some arbitrary value that doesn't make much | |
379 | // sense (as 2.8 used to do), tell the caller that we don't have a clue: | |
380 | return wxDefaultSize; | |
381 | } | |
382 | ||
383 | /*static*/ | |
384 | void wxArtProvider::InitNativeProvider() | |
385 | { | |
386 | } | |
387 | #endif // !wxHAS_NATIVE_ART_PROVIDER_IMPL | |
388 | ||
389 | ||
390 | /* static */ | |
391 | bool wxArtProvider::HasNativeProvider() | |
392 | { | |
393 | #ifdef __WXGTK20__ | |
394 | return true; | |
395 | #else | |
396 | return false; | |
397 | #endif | |
398 | } | |
399 | ||
400 | // ---------------------------------------------------------------------------- | |
401 | // deprecated wxArtProvider methods | |
402 | // ---------------------------------------------------------------------------- | |
403 | ||
404 | #if WXWIN_COMPATIBILITY_2_6 | |
405 | ||
406 | /* static */ void wxArtProvider::PushProvider(wxArtProvider *provider) | |
407 | { | |
408 | Push(provider); | |
409 | } | |
410 | ||
411 | /* static */ void wxArtProvider::InsertProvider(wxArtProvider *provider) | |
412 | { | |
413 | Insert(provider); | |
414 | } | |
415 | ||
416 | /* static */ bool wxArtProvider::PopProvider() | |
417 | { | |
418 | return Pop(); | |
419 | } | |
420 | ||
421 | /* static */ bool wxArtProvider::RemoveProvider(wxArtProvider *provider) | |
422 | { | |
423 | // RemoveProvider() used to delete the provider being removed so this is | |
424 | // not a typo, we must call Delete() and not Remove() here | |
425 | return Delete(provider); | |
426 | } | |
427 | ||
428 | #endif // WXWIN_COMPATIBILITY_2_6 | |
429 | ||
430 | #if WXWIN_COMPATIBILITY_2_8 | |
431 | /* static */ void wxArtProvider::Insert(wxArtProvider *provider) | |
432 | { | |
433 | PushBack(provider); | |
434 | } | |
435 | #endif // WXWIN_COMPATIBILITY_2_8 | |
436 | ||
437 | // ============================================================================ | |
438 | // wxArtProviderModule | |
439 | // ============================================================================ | |
440 | ||
441 | class wxArtProviderModule: public wxModule | |
442 | { | |
443 | public: | |
444 | bool OnInit() | |
445 | { | |
446 | wxArtProvider::InitStdProvider(); | |
447 | wxArtProvider::InitNativeProvider(); | |
448 | return true; | |
449 | } | |
450 | void OnExit() | |
451 | { | |
452 | wxArtProvider::CleanUpProviders(); | |
453 | } | |
454 | ||
455 | DECLARE_DYNAMIC_CLASS(wxArtProviderModule) | |
456 | }; | |
457 | ||
458 | IMPLEMENT_DYNAMIC_CLASS(wxArtProviderModule, wxModule) |