.\" This is a wxWidgets manpage page generated from the XML docs .TH wxArtProvider 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation" .SH NAME wxArtProvider \- .SH DESCRIPTION wxArtProvider class is used to customize the look of wxWidgets application. When wxWidgets needs to display an icon or a bitmap (e.g. in the standard file dialog), it does not use a hard-coded resource but asks wxArtProvider for it instead. This way users can plug in their own wxArtProvider class and easily replace standard art with their own version. All that is needed is to derive a class from wxArtProvider, override its CreateBitmap method and register the provider with wxArtProvider::PushProvider : class MyProvider : public wxArtProvider { protected: wxBitmap CreateBitmap(const wxArtID& id, const wxArtClient& client, const wxSize size) { ... } }; ... wxArtProvider::PushProvider(new MyProvider); There's another way of taking advantage of this class: you can use it in your code and use platform native icons as provided by wxArtProvider::GetBitmap or wxArtProvider::GetIcon (NB: this is not yet really possible as of wxWidgets 2.3.3, the set of wxArtProvider bitmaps is too small). Identifying art resources Every bitmap is known to wxArtProvider under an unique ID that is used by when requesting a resource from it. The ID is represented by wxArtID type and can have one of these predefined values (you can see bitmaps represented by these constants in the artprov sample): wxART_ADD_BOOKMARK wxART_DEL_BOOKMARK wxART_HELP_SIDE_PANEL wxART_HELP_SETTINGS wxART_HELP_BOOK wxART_HELP_FOLDER wxART_HELP_PAGE wxART_GO_BACK wxART_GO_FORWARD wxART_GO_UP wxART_GO_DOWN wxART_GO_TO_PARENT wxART_GO_HOME wxART_FILE_OPEN wxART_PRINT wxART_HELP wxART_TIP wxART_REPORT_VIEW wxART_LIST_VIEW wxART_NEW_DIR wxART_FOLDER wxART_GO_DIR_UP wxART_EXECUTABLE_FILE wxART_NORMAL_FILE wxART_TICK_MARK wxART_CROSS_MARK wxART_ERROR wxART_QUESTION wxART_WARNING wxART_INFORMATION wxART_MISSING_IMAGE Additionally, any string recognized by custom art providers registered using PushProvider may be used. GTK+ Note When running under GTK+ 2, GTK+ stock item IDs (e.g. "gtk-cdrom" ) may be used as well. Additionally, if wxGTK was compiled against GTK+ >= 2.4, then it is also possible to load icons from current icon theme by specifying their name (without extension and directory components). Icon themes recognized by GTK+ follow the http://freedesktop.org/Standards/icon-theme-spec . Note that themes are not guaranteed to contain all icons, so wxArtProvider may return wxNullBitmap or wxNullIcon . Default theme is typically installed in /usr/share/icons/hicolor . Clients Client is the entity that calls wxArtProvider's GetBitmap or GetIcon function. It is represented by wxClientID type and can have one of these values: wxART_TOOLBAR wxART_MENU wxART_BUTTON wxART_FRAME_ICON wxART_CMN_DIALOG wxART_HELP_BROWSER wxART_MESSAGE_BOX wxART_OTHER (used for all requests that don't fit into any of the categories above) Client ID servers as a hint to wxArtProvider that is supposed to help it to choose the best looking bitmap. For example it is often desirable to use slightly different icons in menus and toolbars even though they represent the same action (e.g. wx_ART_FILE_OPEN ). Remember that this is really only a hint for wxArtProvider -- it is common that wxArtProvider::GetBitmap returns identical bitmap for different client values! .SH "PARENTS" wxObject .SH "INCLUDE FILES" wx/artprov.h .SH MEMBERS .SS wxBitmap CreateBitmap (const wxArtID& idconst wxArtClient& clientconst wxSize& size) Derived art provider classes must override this method to create requested art resource. Note that returned bitmaps are cached by wxArtProvider and it is therefore not necessary to optimize CreateBitmap for speed (e.g. you may create wxBitmap objects from XPMs here). .SS static wxBitmap GetBitmap (const wxArtID& idconst wxArtClient& client = wxART_OTHERconst wxSize& size = wxDefaultSize) Query registered providers for bitmap with given ID. .SS static wxIcon GetIcon (const wxArtID& idconst wxArtClient& client = wxART_OTHERconst wxSize& size = wxDefaultSize) Same as wxArtProvider::GetBitmap , but return a wxIcon object (or wxNullIcon on failure). .SS static wxSize GetSizeHint (const wxArtClient& clientbool platform_default = false) Returns a suitable size hint for the given wxArtClient . If platform_default is true, return a size based on the current platform, otherwise return the size from the topmost wxArtProvider. wxDefaultSize may be returned if the client doesn't have a specified size, like wxART_OTHER for example. .SS static bool PopProvider () Remove latest added provider and delete it. .SS static void PushProvider (wxArtProvider* provider) Register new art provider (add it to the top of providers stack). .SS static bool RemoveProvider (wxArtProvider* provider) Remove a provider from the stack. The provider must have been added previously and is not deleted. .SH "SEE ALSO" wxObject See the artprov sample for an example of wxArtProvider usage. .SH "AUTHORS" Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.