interface/wx/artprov.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        artprov.h
   3 // Purpose:     interface of wxArtProvider
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     This type identifies the client of the art objects requested to wxArtProvider.
  11 */
  12 typedef class wxString wxArtClient;
  13
  14 /**
  15     This type identifies a specific art object which can be requested to wxArtProvider.
  16 */
  17 typedef class wxString wxArtID;
  18
  19
  20 /**
  21     @class wxArtProvider
  22
  23     wxArtProvider class is used to customize the look of wxWidgets application.
  24
  25     When wxWidgets needs to display an icon or a bitmap (e.g. in the standard file
  26     dialog), it does not use a hard-coded resource but asks wxArtProvider for it
  27     instead. This way users can plug in their own wxArtProvider class and easily
  28     replace standard art with their own version.
  29
  30     All that is needed is to derive a class from wxArtProvider, override either its
  31     wxArtProvider::CreateBitmap() and/or its wxArtProvider::CreateIconBundle() methods
  32     and register the provider with wxArtProvider::Push():
  33
  34     @code
  35       class MyProvider : public wxArtProvider
  36       {
  37       protected:
  38         wxBitmap CreateBitmap(const wxArtID& id,
  39                               const wxArtClient& client,
  40                               const wxSize size)
  41
  42         // optionally override this one as well
  43         wxIconBundle CreateIconBundle(const wxArtID& id,
  44                                       const wxArtClient& client)
  45         { ... }
  46       };
  47       ...
  48       wxArtProvider::Push(new MyProvider);
  49     @endcode
  50
  51     If you need bitmap images (of the same artwork) that should be displayed at
  52     different sizes you should probably consider overriding wxArtProvider::CreateIconBundle
  53     and supplying icon bundles that contain different bitmap sizes.
  54
  55     There's another way of taking advantage of this class: you can use it in your
  56     code and use platform native icons as provided by wxArtProvider::GetBitmap or
  57     wxArtProvider::GetIcon.
  58
  59     @section artprovider_identify Identifying art resources
  60
  61     Every bitmap and icon bundle are known to wxArtProvider under an unique ID that
  62     is used when requesting a resource from it. The ID is represented by the ::wxArtID type
  63     and can have one of these predefined values (you can see bitmaps represented by these
  64     constants in the @ref page_samples_artprov):
  65
  66     <table>
  67     <tr><td>
  68      @li wxART_ERROR
  69      @li wxART_QUESTION
  70      @li wxART_WARNING
  71      @li wxART_INFORMATION
  72      @li wxART_ADD_BOOKMARK
  73      @li wxART_DEL_BOOKMARK
  74      @li wxART_HELP_SIDE_PANEL
  75      @li wxART_HELP_SETTINGS
  76      @li wxART_HELP_BOOK
  77      @li wxART_HELP_FOLDER
  78      @li wxART_HELP_PAGE
  79      @li wxART_GO_BACK
  80      @li wxART_GO_FORWARD
  81      @li wxART_GO_UP
  82      @li wxART_GO_DOWN
  83      @li wxART_GO_TO_PARENT
  84      @li wxART_GO_HOME
  85      @li wxART_GOTO_FIRST (since 2.9.2)
  86      </td><td>
  87      @li wxART_GOTO_LAST (since 2.9.2)
  88      @li wxART_PRINT
  89      @li wxART_HELP
  90      @li wxART_TIP
  91      @li wxART_REPORT_VIEW
  92      @li wxART_LIST_VIEW
  93      @li wxART_NEW_DIR
  94      @li wxART_FOLDER
  95      @li wxART_FOLDER_OPEN
  96      @li wxART_GO_DIR_UP
  97      @li wxART_EXECUTABLE_FILE
  98      @li wxART_NORMAL_FILE
  99      @li wxART_TICK_MARK
 100      @li wxART_CROSS_MARK
 101      @li wxART_MISSING_IMAGE
 102      @li wxART_NEW
 103      @li wxART_FILE_OPEN
 104      @li wxART_FILE_SAVE
 105      </td><td>
 106      @li wxART_FILE_SAVE_AS
 107      @li wxART_DELETE
 108      @li wxART_COPY
 109      @li wxART_CUT
 110      @li wxART_PASTE
 111      @li wxART_UNDO
 112      @li wxART_REDO
 113      @li wxART_PLUS (since 2.9.2)
 114      @li wxART_MINUS (since 2.9.2)
 115      @li wxART_CLOSE
 116      @li wxART_QUIT
 117      @li wxART_FIND
 118      @li wxART_FIND_AND_REPLACE
 119      @li wxART_HARDDISK
 120      @li wxART_FLOPPY
 121      @li wxART_CDROM
 122      @li wxART_REMOVABLE
 123     </td></tr>
 124     </table>
 125
 126     Additionally, any string recognized by custom art providers registered using
 127     wxArtProvider::Push may be used.
 128
 129     @note
 130     When running under GTK+ 2, GTK+ stock item IDs (e.g. @c "gtk-cdrom") may be used
 131     as well:
 132     @code
 133     #ifdef __WXGTK__
 134         wxBitmap bmp = wxArtProvider::GetBitmap("gtk-cdrom", wxART_MENU);
 135     #endif
 136     @endcode
 137     For a list of the GTK+ stock items please refer to the
 138     <a href="http://library.gnome.org/devel/gtk/stable/gtk-Stock-Items.html">GTK+ documentation
 139     page</a>.
 140     It is also possible to load icons from the current icon theme by specifying their name
 141     (without extension and directory components).
 142     Icon themes recognized by GTK+ follow the freedesktop.org
 143     <a href="http://freedesktop.org/Standards/icon-theme-spec">Icon Themes specification</a>.
 144     Note that themes are not guaranteed to contain all icons, so wxArtProvider may
 145     return ::wxNullBitmap or ::wxNullIcon.
 146     The default theme is typically installed in @c /usr/share/icons/hicolor.
 147
 148
 149     @section artprovider_clients Clients
 150
 151     The @e client is the entity that calls wxArtProvider's GetBitmap() or GetIcon() function.
 152     It is represented by wxClientID type and can have one of these values:
 153
 154     @li wxART_TOOLBAR
 155     @li wxART_MENU
 156     @li wxART_BUTTON
 157     @li wxART_FRAME_ICON
 158     @li wxART_CMN_DIALOG
 159     @li wxART_HELP_BROWSER
 160     @li wxART_MESSAGE_BOX
 161     @li wxART_OTHER (used for all requests that don't fit into any of the
 162         categories above)
 163
 164     Client ID serve as a hint to wxArtProvider that is supposed to help it to
 165     choose the best looking bitmap. For example it is often desirable to use
 166     slightly different icons in menus and toolbars even though they represent
 167     the same action (e.g. wxART_FILE_OPEN). Remember that this is really only a
 168     hint for wxArtProvider -- it is common that wxArtProvider::GetBitmap returns
 169     identical bitmap for different client values!
 170
 171     @library{wxcore}
 172     @category{misc}
 173
 174     @see the @ref page_samples_artprov for an example of wxArtProvider usage.
 175 */
 176 class wxArtProvider : public wxObject
 177 {
 178 public:
 179     /**
 180         The destructor automatically removes the provider from the provider stack used
 181         by GetBitmap().
 182     */
 183     virtual ~wxArtProvider();
 184
 185     /**
 186         Delete the given @a provider.
 187     */
 188     static bool Delete(wxArtProvider* provider);
 189
 190     /**
 191         Query registered providers for bitmap with given ID.
 192
 193         @param id
 194             wxArtID unique identifier of the bitmap.
 195         @param client
 196             wxArtClient identifier of the client (i.e. who is asking for the bitmap).
 197         @param size
 198             Size of the returned bitmap or wxDefaultSize if size doesn't matter.
 199
 200         @return The bitmap if one of registered providers recognizes the ID or
 201                 wxNullBitmap otherwise.
 202     */
 203     static wxBitmap GetBitmap(const wxArtID& id,
 204                               const wxArtClient& client = wxART_OTHER,
 205                               const wxSize& size = wxDefaultSize);
 206
 207     /**
 208         Same as wxArtProvider::GetBitmap, but return a wxIcon object
 209         (or ::wxNullIcon on failure).
 210     */
 211     static wxIcon GetIcon(const wxArtID& id,
 212                           const wxArtClient& client = wxART_OTHER,
 213                           const wxSize& size = wxDefaultSize);
 214
 215     /**
 216         Returns native icon size for use specified by @a client hint.
 217
 218         If the platform has no commonly used default for this use or if
 219         @a client is not recognized, returns wxDefaultSize.
 220
 221         @note In some cases, a platform may have @em several appropriate
 222               native sizes (for example, wxART_FRAME_ICON for frame icons).
 223               In that case, this method returns only one of them, picked
 224               reasonably.
 225
 226         @since 2.9.0
 227      */
 228     static wxSize GetNativeSizeHint(const wxArtClient& client);
 229
 230     /**
 231         Returns a suitable size hint for the given @e wxArtClient.
 232
 233         If @a platform_default is @true, return a size based on the current
 234         platform using GetNativeSizeHint(), otherwise return the size from the
 235         topmost wxArtProvider. @e wxDefaultSize may be returned if the client
 236         doesn't have a specified size, like wxART_OTHER for example.
 237
 238         @see GetNativeSizeHint()
 239     */
 240     static wxSize GetSizeHint(const wxArtClient& client,
 241                               bool platform_default = false);
 242
 243     /**
 244         Query registered providers for icon bundle with given ID.
 245
 246         @param id
 247             wxArtID unique identifier of the icon bundle.
 248         @param client
 249             wxArtClient identifier of the client (i.e. who is asking for the icon
 250             bundle).
 251
 252         @return The icon bundle if one of registered providers recognizes the ID
 253                 or wxNullIconBundle otherwise.
 254     */
 255     static wxIconBundle GetIconBundle(const wxArtID& id,
 256                                       const wxArtClient& client = wxART_OTHER);
 257
 258     /**
 259         Returns true if the platform uses native icons provider that should
 260         take precedence over any customizations.
 261
 262         This is true for any platform that has user-customizable icon themes,
 263         currently only wxGTK.
 264
 265         A typical use for this method is to decide whether a custom art provider
 266         should be plugged in using Push() or PushBack().
 267
 268         @since 2.9.0
 269      */
 270     static bool HasNativeProvider();
 271
 272     /**
 273         @deprecated Use PushBack() instead.
 274     */
 275     static void Insert(wxArtProvider* provider);
 276
 277     /**
 278         Remove latest added provider and delete it.
 279     */
 280     static bool Pop();
 281
 282     /**
 283         Register new art provider and add it to the top of providers stack
 284         (i.e. it will be queried as the first provider).
 285
 286         @see PushBack()
 287     */
 288     static void Push(wxArtProvider* provider);
 289
 290     /**
 291         Register new art provider and add it to the bottom of providers stack.
 292         In other words, it will be queried as the last one, after all others,
 293         including the default provider.
 294
 295         @see Push()
 296
 297         @since 2.9.0
 298     */
 299     static void PushBack(wxArtProvider* provider);
 300
 301     /**
 302         Remove a provider from the stack if it is on it. The provider is not
 303         deleted, unlike when using Delete().
 304     */
 305     static bool Remove(wxArtProvider* provider);
 306
 307 protected:
 308
 309     /**
 310         Derived art provider classes must override this method to create requested art
 311         resource. Note that returned bitmaps are cached by wxArtProvider and it is
 312         therefore not necessary to optimize CreateBitmap() for speed (e.g. you may
 313         create wxBitmap objects from XPMs here).
 314
 315         @param id
 316             wxArtID unique identifier of the bitmap.
 317         @param client
 318             wxArtClient identifier of the client (i.e. who is asking for the bitmap).
 319             This only servers as a hint.
 320         @param size
 321             Preferred size of the bitmap. The function may return a bitmap of different
 322             dimensions, it will be automatically rescaled to meet client's request.
 323
 324         @note
 325         This is not part of wxArtProvider's public API, use wxArtProvider::GetBitmap
 326         or wxArtProvider::GetIconBundle or wxArtProvider::GetIcon to query wxArtProvider
 327         for a resource.
 328
 329         @see CreateIconBundle()
 330     */
 331     virtual wxBitmap CreateBitmap(const wxArtID& id,
 332                                   const wxArtClient& client,
 333                                   const wxSize& size);
 334
 335     /**
 336         This method is similar to CreateBitmap() but can be used when a bitmap
 337         (or an icon) exists in several sizes.
 338     */
 339     virtual wxIconBundle CreateIconBundle(const wxArtID& id,
 340                                           const wxArtClient& client);
 341 };
 342