]> git.saurik.com Git - wxWidgets.git/blob - include/wx/artprov.h
More parameter variable names fixed to make them more readable by replacing abbreviat...
[wxWidgets.git] / include / wx / artprov.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: artprov.h
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 #ifndef _WX_ARTPROV_H_
13 #define _WX_ARTPROV_H_
14
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "artprov.h"
17 #endif
18
19 #include "wx/string.h"
20 #include "wx/bitmap.h"
21 #include "wx/icon.h"
22
23 class WXDLLEXPORT wxArtProvidersList;
24 class WXDLLEXPORT wxArtProviderCache;
25 class wxArtProviderModule;
26
27 // ----------------------------------------------------------------------------
28 // Types
29 // ----------------------------------------------------------------------------
30
31 typedef wxString wxArtClient;
32 typedef wxString wxArtID;
33
34 #define wxART_MAKE_CLIENT_ID_FROM_STR(id) (id + _T("_C"))
35 #define wxART_MAKE_CLIENT_ID(id) _T(#id) _T("_C")
36 #define wxART_MAKE_ART_ID_FROM_STR(id) (id)
37 #define wxART_MAKE_ART_ID(id) _T(#id)
38
39 // ----------------------------------------------------------------------------
40 // Art clients
41 // ----------------------------------------------------------------------------
42
43 #define wxART_TOOLBAR wxART_MAKE_CLIENT_ID(wxART_TOOLBAR)
44 #define wxART_MENU wxART_MAKE_CLIENT_ID(wxART_MENU)
45 #define wxART_FRAME_ICON wxART_MAKE_CLIENT_ID(wxART_FRAME_ICON)
46
47 #define wxART_CMN_DIALOG wxART_MAKE_CLIENT_ID(wxART_CMN_DIALOG)
48 #define wxART_HELP_BROWSER wxART_MAKE_CLIENT_ID(wxART_HELP_BROWSER)
49 #define wxART_MESSAGE_BOX wxART_MAKE_CLIENT_ID(wxART_MESSAGE_BOX)
50 #define wxART_BUTTON wxART_MAKE_CLIENT_ID(wxART_BUTTON)
51
52 #define wxART_OTHER wxART_MAKE_CLIENT_ID(wxART_OTHER)
53
54 // ----------------------------------------------------------------------------
55 // Art IDs
56 // ----------------------------------------------------------------------------
57
58 #define wxART_ADD_BOOKMARK wxART_MAKE_ART_ID(wxART_ADD_BOOKMARK)
59 #define wxART_DEL_BOOKMARK wxART_MAKE_ART_ID(wxART_DEL_BOOKMARK)
60 #define wxART_HELP_SIDE_PANEL wxART_MAKE_ART_ID(wxART_HELP_SIDE_PANEL)
61 #define wxART_HELP_SETTINGS wxART_MAKE_ART_ID(wxART_HELP_SETTINGS)
62 #define wxART_HELP_BOOK wxART_MAKE_ART_ID(wxART_HELP_BOOK)
63 #define wxART_HELP_FOLDER wxART_MAKE_ART_ID(wxART_HELP_FOLDER)
64 #define wxART_HELP_PAGE wxART_MAKE_ART_ID(wxART_HELP_PAGE)
65 #define wxART_GO_BACK wxART_MAKE_ART_ID(wxART_GO_BACK)
66 #define wxART_GO_FORWARD wxART_MAKE_ART_ID(wxART_GO_FORWARD)
67 #define wxART_GO_UP wxART_MAKE_ART_ID(wxART_GO_UP)
68 #define wxART_GO_DOWN wxART_MAKE_ART_ID(wxART_GO_DOWN)
69 #define wxART_GO_TO_PARENT wxART_MAKE_ART_ID(wxART_GO_TO_PARENT)
70 #define wxART_GO_HOME wxART_MAKE_ART_ID(wxART_GO_HOME)
71 #define wxART_FILE_OPEN wxART_MAKE_ART_ID(wxART_FILE_OPEN)
72 #define wxART_PRINT wxART_MAKE_ART_ID(wxART_PRINT)
73 #define wxART_HELP wxART_MAKE_ART_ID(wxART_HELP)
74 #define wxART_TIP wxART_MAKE_ART_ID(wxART_TIP)
75 #define wxART_REPORT_VIEW wxART_MAKE_ART_ID(wxART_REPORT_VIEW)
76 #define wxART_LIST_VIEW wxART_MAKE_ART_ID(wxART_LIST_VIEW)
77 #define wxART_NEW_DIR wxART_MAKE_ART_ID(wxART_NEW_DIR)
78 #define wxART_HARDDISK wxART_MAKE_ART_ID(wxART_HARDDISK)
79 #define wxART_FLOPPY wxART_MAKE_ART_ID(wxART_FLOPPY)
80 #define wxART_CDROM wxART_MAKE_ART_ID(wxART_CDROM)
81 #define wxART_REMOVABLE wxART_MAKE_ART_ID(wxART_REMOVABLE)
82 #define wxART_FOLDER wxART_MAKE_ART_ID(wxART_FOLDER)
83 #define wxART_FOLDER_OPEN wxART_MAKE_ART_ID(wxART_FOLDER_OPEN)
84 #define wxART_GO_DIR_UP wxART_MAKE_ART_ID(wxART_GO_DIR_UP)
85 #define wxART_EXECUTABLE_FILE wxART_MAKE_ART_ID(wxART_EXECUTABLE_FILE)
86 #define wxART_NORMAL_FILE wxART_MAKE_ART_ID(wxART_NORMAL_FILE)
87 #define wxART_TICK_MARK wxART_MAKE_ART_ID(wxART_TICK_MARK)
88 #define wxART_CROSS_MARK wxART_MAKE_ART_ID(wxART_CROSS_MARK)
89 #define wxART_ERROR wxART_MAKE_ART_ID(wxART_ERROR)
90 #define wxART_QUESTION wxART_MAKE_ART_ID(wxART_QUESTION)
91 #define wxART_WARNING wxART_MAKE_ART_ID(wxART_WARNING)
92 #define wxART_INFORMATION wxART_MAKE_ART_ID(wxART_INFORMATION)
93 #define wxART_MISSING_IMAGE wxART_MAKE_ART_ID(wxART_MISSING_IMAGE)
94
95 // ----------------------------------------------------------------------------
96 // wxArtProvider class
97 // ----------------------------------------------------------------------------
98
99 class WXDLLEXPORT wxArtProvider : public wxObject
100 {
101 public:
102 // Add new provider to the top of providers stack.
103 static void PushProvider(wxArtProvider *provider);
104
105 // Remove latest added provider and delete it.
106 static bool PopProvider();
107
108 // Remove provider. The provider must have been added previously!
109 // The provider is _not_ deleted.
110 static bool RemoveProvider(wxArtProvider *provider);
111
112 // Query the providers for bitmap with given ID and return it. Return
113 // wxNullBitmap if no provider provides it.
114 static wxBitmap GetBitmap(const wxArtID& id,
115 const wxArtClient& client = wxART_OTHER,
116 const wxSize& size = wxDefaultSize);
117
118 // Query the providers for icon with given ID and return it. Return
119 // wxNullIcon if no provider provides it.
120 static wxIcon GetIcon(const wxArtID& id,
121 const wxArtClient& client = wxART_OTHER,
122 const wxSize& size = wxDefaultSize);
123
124 protected:
125 friend class wxArtProviderModule;
126 // Initializes default provider
127 static void InitStdProvider();
128 // Initializes platform's native provider, if available (e.g. GTK2)
129 static void InitNativeProvider();
130 // Destroy caches & all providers
131 static void CleanUpProviders();
132
133 // Derived classes must override this method to create requested
134 // art resource. This method is called only once per instance's
135 // lifetime for each requested wxArtID.
136 virtual wxBitmap CreateBitmap(const wxArtID& WXUNUSED(id),
137 const wxArtClient& WXUNUSED(client),
138 const wxSize& WXUNUSED(size)) = 0;
139
140 private:
141 // list of providers:
142 static wxArtProvidersList *sm_providers;
143 // art resources cache (so that CreateXXX is not called that often):
144 static wxArtProviderCache *sm_cache;
145
146 DECLARE_ABSTRACT_CLASS(wxArtProvider)
147 };
148
149
150 #endif // _WX_ARTPROV_H_