1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxArtProvider class
4 // Author: Vaclav Slavik
8 // Copyright: (c) Vaclav Slavik
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_ARTPROV_H_
13 #define _WX_ARTPROV_H_
15 #include "wx/string.h"
16 #include "wx/bitmap.h"
19 class WXDLLEXPORT wxArtProvidersList
;
20 class WXDLLEXPORT wxArtProviderCache
;
21 class wxArtProviderModule
;
23 // ----------------------------------------------------------------------------
25 // ----------------------------------------------------------------------------
27 typedef wxString wxArtClient
;
28 typedef wxString wxArtID
;
30 #define wxART_MAKE_CLIENT_ID_FROM_STR(id) (id + _T("_C"))
31 #define wxART_MAKE_CLIENT_ID(id) _T(#id) _T("_C")
32 #define wxART_MAKE_ART_ID_FROM_STR(id) (id)
33 #define wxART_MAKE_ART_ID(id) _T(#id)
35 // ----------------------------------------------------------------------------
37 // ----------------------------------------------------------------------------
39 #define wxART_TOOLBAR wxART_MAKE_CLIENT_ID(wxART_TOOLBAR)
40 #define wxART_MENU wxART_MAKE_CLIENT_ID(wxART_MENU)
41 #define wxART_FRAME_ICON wxART_MAKE_CLIENT_ID(wxART_FRAME_ICON)
43 #define wxART_CMN_DIALOG wxART_MAKE_CLIENT_ID(wxART_CMN_DIALOG)
44 #define wxART_HELP_BROWSER wxART_MAKE_CLIENT_ID(wxART_HELP_BROWSER)
45 #define wxART_MESSAGE_BOX wxART_MAKE_CLIENT_ID(wxART_MESSAGE_BOX)
46 #define wxART_BUTTON wxART_MAKE_CLIENT_ID(wxART_BUTTON)
48 #define wxART_OTHER wxART_MAKE_CLIENT_ID(wxART_OTHER)
50 // ----------------------------------------------------------------------------
52 // ----------------------------------------------------------------------------
54 #define wxART_ADD_BOOKMARK wxART_MAKE_ART_ID(wxART_ADD_BOOKMARK)
55 #define wxART_DEL_BOOKMARK wxART_MAKE_ART_ID(wxART_DEL_BOOKMARK)
56 #define wxART_HELP_SIDE_PANEL wxART_MAKE_ART_ID(wxART_HELP_SIDE_PANEL)
57 #define wxART_HELP_SETTINGS wxART_MAKE_ART_ID(wxART_HELP_SETTINGS)
58 #define wxART_HELP_BOOK wxART_MAKE_ART_ID(wxART_HELP_BOOK)
59 #define wxART_HELP_FOLDER wxART_MAKE_ART_ID(wxART_HELP_FOLDER)
60 #define wxART_HELP_PAGE wxART_MAKE_ART_ID(wxART_HELP_PAGE)
61 #define wxART_GO_BACK wxART_MAKE_ART_ID(wxART_GO_BACK)
62 #define wxART_GO_FORWARD wxART_MAKE_ART_ID(wxART_GO_FORWARD)
63 #define wxART_GO_UP wxART_MAKE_ART_ID(wxART_GO_UP)
64 #define wxART_GO_DOWN wxART_MAKE_ART_ID(wxART_GO_DOWN)
65 #define wxART_GO_TO_PARENT wxART_MAKE_ART_ID(wxART_GO_TO_PARENT)
66 #define wxART_GO_HOME wxART_MAKE_ART_ID(wxART_GO_HOME)
67 #define wxART_FILE_OPEN wxART_MAKE_ART_ID(wxART_FILE_OPEN)
68 #define wxART_FILE_SAVE wxART_MAKE_ART_ID(wxART_FILE_SAVE)
69 #define wxART_FILE_SAVE_AS wxART_MAKE_ART_ID(wxART_FILE_SAVE_AS)
70 #define wxART_PRINT wxART_MAKE_ART_ID(wxART_PRINT)
71 #define wxART_HELP wxART_MAKE_ART_ID(wxART_HELP)
72 #define wxART_TIP wxART_MAKE_ART_ID(wxART_TIP)
73 #define wxART_REPORT_VIEW wxART_MAKE_ART_ID(wxART_REPORT_VIEW)
74 #define wxART_LIST_VIEW wxART_MAKE_ART_ID(wxART_LIST_VIEW)
75 #define wxART_NEW_DIR wxART_MAKE_ART_ID(wxART_NEW_DIR)
76 #define wxART_HARDDISK wxART_MAKE_ART_ID(wxART_HARDDISK)
77 #define wxART_FLOPPY wxART_MAKE_ART_ID(wxART_FLOPPY)
78 #define wxART_CDROM wxART_MAKE_ART_ID(wxART_CDROM)
79 #define wxART_REMOVABLE wxART_MAKE_ART_ID(wxART_REMOVABLE)
80 #define wxART_FOLDER wxART_MAKE_ART_ID(wxART_FOLDER)
81 #define wxART_FOLDER_OPEN wxART_MAKE_ART_ID(wxART_FOLDER_OPEN)
82 #define wxART_GO_DIR_UP wxART_MAKE_ART_ID(wxART_GO_DIR_UP)
83 #define wxART_EXECUTABLE_FILE wxART_MAKE_ART_ID(wxART_EXECUTABLE_FILE)
84 #define wxART_NORMAL_FILE wxART_MAKE_ART_ID(wxART_NORMAL_FILE)
85 #define wxART_TICK_MARK wxART_MAKE_ART_ID(wxART_TICK_MARK)
86 #define wxART_CROSS_MARK wxART_MAKE_ART_ID(wxART_CROSS_MARK)
87 #define wxART_ERROR wxART_MAKE_ART_ID(wxART_ERROR)
88 #define wxART_QUESTION wxART_MAKE_ART_ID(wxART_QUESTION)
89 #define wxART_WARNING wxART_MAKE_ART_ID(wxART_WARNING)
90 #define wxART_INFORMATION wxART_MAKE_ART_ID(wxART_INFORMATION)
91 #define wxART_MISSING_IMAGE wxART_MAKE_ART_ID(wxART_MISSING_IMAGE)
93 #define wxART_COPY wxART_MAKE_ART_ID(wxART_COPY)
94 #define wxART_CUT wxART_MAKE_ART_ID(wxART_CUT)
95 #define wxART_PASTE wxART_MAKE_ART_ID(wxART_PASTE)
96 #define wxART_DELETE wxART_MAKE_ART_ID(wxART_DELETE)
97 #define wxART_NEW wxART_MAKE_ART_ID(wxART_NEW)
99 #define wxART_UNDO wxART_MAKE_ART_ID(wxART_UNDO)
100 #define wxART_REDO wxART_MAKE_ART_ID(wxART_REDO)
102 #define wxART_QUIT wxART_MAKE_ART_ID(wxART_QUIT)
104 #define wxART_FIND wxART_MAKE_ART_ID(wxART_FIND)
105 #define wxART_FIND_AND_REPLACE wxART_MAKE_ART_ID(wxART_FIND_AND_REPLACE)
108 // ----------------------------------------------------------------------------
109 // wxArtProvider class
110 // ----------------------------------------------------------------------------
112 class WXDLLEXPORT wxArtProvider
: public wxObject
115 // Add new provider to the top of providers stack (i.e. the provider will
116 // be querier first of all).
117 static void PushProvider(wxArtProvider
*provider
);
119 // Add new provider to the bottom of providers stack (i.e. the provider
120 // will be queried as the last one).
121 static void InsertProvider(wxArtProvider
*provider
);
123 // Remove latest added provider and delete it.
124 static bool PopProvider();
126 // Remove provider. The provider must have been added previously!
127 // The provider is _not_ deleted.
128 static bool RemoveProvider(wxArtProvider
*provider
);
130 // Query the providers for bitmap with given ID and return it. Return
131 // wxNullBitmap if no provider provides it.
132 static wxBitmap
GetBitmap(const wxArtID
& id
,
133 const wxArtClient
& client
= wxART_OTHER
,
134 const wxSize
& size
= wxDefaultSize
);
136 // Query the providers for icon with given ID and return it. Return
137 // wxNullIcon if no provider provides it.
138 static wxIcon
GetIcon(const wxArtID
& id
,
139 const wxArtClient
& client
= wxART_OTHER
,
140 const wxSize
& size
= wxDefaultSize
);
142 // Get the size hint of an icon from a specific wxArtClient, queries
143 // the topmost provider if platform_dependent = false
144 static wxSize
GetSizeHint(const wxArtClient
& client
, bool platform_dependent
= false);
147 friend class wxArtProviderModule
;
148 // Initializes default provider
149 static void InitStdProvider();
150 // Initializes platform's native provider, if available (e.g. GTK2)
151 static void InitNativeProvider();
152 // Destroy caches & all providers
153 static void CleanUpProviders();
155 // Get the default size of an icon for a specific client
156 virtual wxSize
DoGetSizeHint(const wxArtClient
& client
)
158 return GetSizeHint(client
, true);
161 // Derived classes must override this method to create requested
162 // art resource. This method is called only once per instance's
163 // lifetime for each requested wxArtID.
164 virtual wxBitmap
CreateBitmap(const wxArtID
& WXUNUSED(id
),
165 const wxArtClient
& WXUNUSED(client
),
166 const wxSize
& WXUNUSED(size
)) = 0;
169 static void InitProvidersList();
172 // list of providers:
173 static wxArtProvidersList
*sm_providers
;
174 // art resources cache (so that CreateXXX is not called that often):
175 static wxArtProviderCache
*sm_cache
;
177 DECLARE_ABSTRACT_CLASS(wxArtProvider
)
181 #endif // _WX_ARTPROV_H_