///////////////////////////////////////////////////////////////////////////// // Name: artprov.h // Purpose: interface of wxArtProvider // Author: wxWidgets team // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** This type identifies the client of the art objects requested to wxArtProvider. */ typedef wxString wxArtClient; /** This type identifies a specific art object which can be requested to wxArtProvider. */ typedef wxString wxArtID; wxArtClient wxART_TOOLBAR; wxArtClient wxART_MENU; wxArtClient wxART_FRAME_ICON; wxArtClient wxART_CMN_DIALOG; wxArtClient wxART_HELP_BROWSER; wxArtClient wxART_MESSAGE_BOX; wxArtClient wxART_BUTTON; wxArtClient wxART_LIST; wxArtClient wxART_OTHER; wxArtID wxART_ADD_BOOKMARK; wxArtID wxART_DEL_BOOKMARK; wxArtID wxART_HELP_SIDE_PANEL; wxArtID wxART_HELP_SETTINGS; wxArtID wxART_HELP_BOOK; wxArtID wxART_HELP_FOLDER; wxArtID wxART_HELP_PAGE; wxArtID wxART_GO_BACK; wxArtID wxART_GO_FORWARD; wxArtID wxART_GO_UP; wxArtID wxART_GO_DOWN; wxArtID wxART_GO_TO_PARENT; wxArtID wxART_GO_HOME; wxArtID wxART_GOTO_FIRST; wxArtID wxART_GOTO_LAST; wxArtID wxART_FILE_OPEN; wxArtID wxART_FILE_SAVE; wxArtID wxART_FILE_SAVE_AS; wxArtID wxART_PRINT; wxArtID wxART_HELP; wxArtID wxART_TIP; wxArtID wxART_REPORT_VIEW; wxArtID wxART_LIST_VIEW; wxArtID wxART_NEW_DIR; wxArtID wxART_HARDDISK; wxArtID wxART_FLOPPY; wxArtID wxART_CDROM; wxArtID wxART_REMOVABLE; wxArtID wxART_FOLDER; wxArtID wxART_FOLDER_OPEN; wxArtID wxART_GO_DIR_UP; wxArtID wxART_EXECUTABLE_FILE; wxArtID wxART_NORMAL_FILE; wxArtID wxART_TICK_MARK; wxArtID wxART_CROSS_MARK; wxArtID wxART_ERROR; wxArtID wxART_QUESTION; wxArtID wxART_WARNING; wxArtID wxART_INFORMATION; wxArtID wxART_MISSING_IMAGE; wxArtID wxART_COPY; wxArtID wxART_CUT; wxArtID wxART_PASTE; wxArtID wxART_DELETE; wxArtID wxART_NEW; wxArtID wxART_UNDO; wxArtID wxART_REDO; wxArtID wxART_PLUS; wxArtID wxART_MINUS; wxArtID wxART_CLOSE; wxArtID wxART_QUIT; wxArtID wxART_FIND; wxArtID wxART_FIND_AND_REPLACE; /** @class wxArtProvider 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 either its wxArtProvider::CreateBitmap() and/or its wxArtProvider::CreateIconBundle() methods and register the provider with wxArtProvider::Push(): @code class MyProvider : public wxArtProvider { protected: wxBitmap CreateBitmap(const wxArtID& id, const wxArtClient& client, const wxSize size) // optionally override this one as well wxIconBundle CreateIconBundle(const wxArtID& id, const wxArtClient& client) { ... } }; ... wxArtProvider::Push(new MyProvider); @endcode If you need bitmap images (of the same artwork) that should be displayed at different sizes you should probably consider overriding wxArtProvider::CreateIconBundle and supplying icon bundles that contain different bitmap sizes. 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. @section artprovider_identify Identifying art resources Every bitmap and icon bundle are known to wxArtProvider under an unique ID that is used when requesting a resource from it. The ID is represented by the ::wxArtID type and can have one of these predefined values (you can see bitmaps represented by these constants in the @ref page_samples_artprov):
@li @c wxART_ERROR @li @c wxART_QUESTION @li @c wxART_WARNING @li @c wxART_INFORMATION @li @c wxART_ADD_BOOKMARK @li @c wxART_DEL_BOOKMARK @li @c wxART_HELP_SIDE_PANEL @li @c wxART_HELP_SETTINGS @li @c wxART_HELP_BOOK @li @c wxART_HELP_FOLDER @li @c wxART_HELP_PAGE @li @c wxART_GO_BACK @li @c wxART_GO_FORWARD @li @c wxART_GO_UP @li @c wxART_GO_DOWN @li @c wxART_GO_TO_PARENT @li @c wxART_GO_HOME @li @c wxART_GOTO_FIRST (since 2.9.2) | @li @c wxART_GOTO_LAST (since 2.9.2) @li @c wxART_PRINT @li @c wxART_HELP @li @c wxART_TIP @li @c wxART_REPORT_VIEW @li @c wxART_LIST_VIEW @li @c wxART_NEW_DIR @li @c wxART_FOLDER @li @c wxART_FOLDER_OPEN @li @c wxART_GO_DIR_UP @li @c wxART_EXECUTABLE_FILE @li @c wxART_NORMAL_FILE @li @c wxART_TICK_MARK @li @c wxART_CROSS_MARK @li @c wxART_MISSING_IMAGE @li @c wxART_NEW @li @c wxART_FILE_OPEN @li @c wxART_FILE_SAVE | @li @c wxART_FILE_SAVE_AS @li @c wxART_DELETE @li @c wxART_COPY @li @c wxART_CUT @li @c wxART_PASTE @li @c wxART_UNDO @li @c wxART_REDO @li @c wxART_PLUS (since 2.9.2) @li @c wxART_MINUS (since 2.9.2) @li @c wxART_CLOSE @li @c wxART_QUIT @li @c wxART_FIND @li @c wxART_FIND_AND_REPLACE @li @c wxART_HARDDISK @li @c wxART_FLOPPY @li @c wxART_CDROM @li @c wxART_REMOVABLE |