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 license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     This type identifies the client of the art objects requested to wxArtProvider.
  11 */
  12 typedef wxString wxArtClient;
  13
  14 /**
  15     This type identifies a specific art object which can be requested to wxArtProvider.
  16 */
  17 typedef 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 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     </td><td>
  83      @li wxART_GO_DOWN
  84      @li wxART_GO_TO_PARENT
  85      @li wxART_GO_HOME
  86      @li wxART_PRINT
  87      @li wxART_HELP
  88      @li wxART_TIP
  89      @li wxART_REPORT_VIEW
  90      @li wxART_LIST_VIEW
  91      @li wxART_NEW_DIR
  92      @li wxART_FOLDER
  93      @li wxART_FOLDER_OPEN
  94      @li wxART_GO_DIR_UP
  95      @li wxART_EXECUTABLE_FILE
  96      @li wxART_NORMAL_FILE
  97      @li wxART_TICK_MARK
  98      @li wxART_CROSS_MARK
  99     </td><td>
 100      @li wxART_MISSING_IMAGE
 101      @li wxART_NEW
 102      @li wxART_FILE_OPEN
 103      @li wxART_FILE_SAVE
 104      @li wxART_FILE_SAVE_AS
 105      @li wxART_DELETE
 106      @li wxART_COPY
 107      @li wxART_CUT
 108      @li wxART_PASTE
 109      @li wxART_UNDO
 110      @li wxART_REDO
 111      @li wxART_QUIT
 112      @li wxART_FIND
 113      @li wxART_FIND_AND_REPLACE
 114      @li wxART_HARDDISK
 115      @li wxART_FLOPPY
 116      @li wxART_CDROM
 117      @li wxART_REMOVABLE
 118     </td></tr>
 119     </table>
 120
 121     Additionally, any string recognized by custom art providers registered using
 122     wxArtProvider::Push may be used.
 123
 124     @note
 125     When running under GTK+ 2, GTK+ stock item IDs (e.g. @c "gtk-cdrom") may be used
 126     as well:
 127     @code
 128         #ifdef __WXGTK__
 129         wxBitmap bmp = wxArtProvider::GetBitmap("gtk-cdrom", wxART_MENU);
 130         #endif
 131     @endcode
 132     Additionally, if wxGTK was compiled against GTK+ >= 2.4, then it is also
 133     possible to load icons from current icon theme by specifying their name (without
 134     extension and directory components).
 135     Icon themes recognized by GTK+ follow the freedesktop.org Icon Themes specification
 136     (see http://freedesktop.org/Standards/icon-theme-spec).
 137     Note that themes are not guaranteed to contain all icons, so wxArtProvider may
 138     return ::wxNullBitmap or ::wxNullIcon.
 139     The default theme is typically installed in @c /usr/share/icons/hicolor.
 140
 141
 142     @section artprovider_clients Clients
 143
 144     The @e client is the entity that calls wxArtProvider's GetBitmap() or GetIcon() function.
 145     It is represented by wxClientID type and can have one of these values:
 146
 147     @li wxART_TOOLBAR
 148     @li wxART_MENU
 149     @li wxART_BUTTON
 150     @li wxART_FRAME_ICON
 151     @li wxART_CMN_DIALOG
 152     @li wxART_HELP_BROWSER
 153     @li wxART_MESSAGE_BOX
 154     @li wxART_OTHER (used for all requests that don't fit into any of the
 155         categories above)
 156
 157     Client ID serve as a hint to wxArtProvider that is supposed to help it to
 158     choose the best looking bitmap. For example it is often desirable to use
 159     slightly different icons in menus and toolbars even though they represent
 160     the same action (e.g. wxART_FILE_OPEN). Remember that this is really only a
 161     hint for wxArtProvider -- it is common that wxArtProvider::GetBitmap returns
 162     identical bitmap for different client values!
 163
 164     @library{wxcore}
 165     @category{misc,data}
 166
 167     @see the @ref page_samples_artprov for an example of wxArtProvider usage.
 168 */
 169 class wxArtProvider : public wxObject
 170 {
 171 public:
 172     /**
 173         The destructor automatically removes the provider from the provider stack used
 174         by GetBitmap().
 175     */
 176     virtual ~wxArtProvider();
 177
 178     /**
 179         Delete the given @a provider.
 180     */
 181     static bool Delete(wxArtProvider* provider);
 182
 183     /**
 184         Query registered providers for bitmap with given ID.
 185
 186         @param id
 187             wxArtID unique identifier of the bitmap.
 188         @param client
 189             wxArtClient identifier of the client (i.e. who is asking for the bitmap).
 190         @param size
 191             Size of the returned bitmap or wxDefaultSize if size doesn't matter.
 192
 193         @return The bitmap if one of registered providers recognizes the ID or
 194                 wxNullBitmap otherwise.
 195     */
 196     static wxBitmap GetBitmap(const wxArtID& id,
 197                               const wxArtClient& client = wxART_OTHER,
 198                               const wxSize& size = wxDefaultSize);
 199
 200     /**
 201         Same as wxArtProvider::GetBitmap, but return a wxIcon object
 202         (or ::wxNullIcon on failure).
 203     */
 204     static wxIcon GetIcon(const wxArtID& id,
 205                           const wxArtClient& client = wxART_OTHER,
 206                           const wxSize& size = wxDefaultSize);
 207
 208     /**
 209         Returns native icon size for use specified by @a client hint.
 210
 211         If the platform has no commonly used default for this use or if
 212         @a client is not recognized, returns wxDefaultSize.
 213
 214         @note In some cases, a platform may have @em several appropriate
 215               native sizes (for example, wxART_FRAME_ICON for frame icons).
 216               In that case, this method returns only one of them, picked
 217               reasonably.
 218
 219         @since 2.9.0
 220      */
 221     static wxSize GetNativeSizeHint(const wxArtClient& client);
 222
 223     /**
 224         Returns a suitable size hint for the given @e wxArtClient.
 225
 226         If @a platform_default is @true, return a size based on the current
 227         platform using GetNativeSizeHint(), otherwise return the size from the
 228         topmost wxArtProvider. @e wxDefaultSize may be returned if the client
 229         doesn't have a specified size, like wxART_OTHER for example.
 230
 231         @see GetNativeSizeHint()
 232     */
 233     static wxSize GetSizeHint(const wxArtClient& client,
 234                               bool platform_default = false);
 235
 236     /**
 237         Query registered providers for icon bundle with given ID.
 238
 239         @param id
 240             wxArtID unique identifier of the icon bundle.
 241         @param client
 242             wxArtClient identifier of the client (i.e. who is asking for the icon
 243             bundle).
 244
 245         @return The icon bundle if one of registered providers recognizes the ID
 246                 or wxNullIconBundle otherwise.
 247     */
 248     static wxIconBundle GetIconBundle(const wxArtID& id,
 249                                       const wxArtClient& client = wxART_OTHER);
 250
 251     /**
 252         Returns true if the platform uses native icons provider that should
 253         take precedence over any customizations.
 254
 255         This is true for any platform that has user-customizable icon themes,
 256         currently only wxGTK.
 257
 258         A typical use for this method is to decide whether a custom art provider
 259         should be plugged in using Push() or PushBack().
 260
 261         @since 2.9.0
 262      */
 263     static bool HasNativeProvider();
 264
 265     /**
 266         @deprecated Use PushBack() instead.
 267     */
 268     static void Insert(wxArtProvider* provider);
 269
 270     /**
 271         Remove latest added provider and delete it.
 272     */
 273     static bool Pop();
 274
 275     /**
 276         Register new art provider and add it to the top of providers stack
 277         (i.e. it will be queried as the first provider).
 278
 279         @see PushBack()
 280     */
 281     static void Push(wxArtProvider* provider);
 282
 283     /**
 284         Register new art provider and add it to the bottom of providers stack.
 285         In other words, it will be queried as the last one, after all others,
 286         including the default provider.
 287
 288         @see Push()
 289
 290         @since 2.9.0
 291     */
 292     static void PushBack(wxArtProvider* provider);
 293
 294     /**
 295         Remove a provider from the stack if it is on it. The provider is not
 296         deleted, unlike when using Delete().
 297     */
 298     static bool Remove(wxArtProvider* provider);
 299
 300 protected:
 301
 302     /**
 303         Derived art provider classes must override this method to create requested art
 304         resource. Note that returned bitmaps are cached by wxArtProvider and it is
 305         therefore not necessary to optimize CreateBitmap() for speed (e.g. you may
 306         create wxBitmap objects from XPMs here).
 307
 308         @param id
 309             wxArtID unique identifier of the bitmap.
 310         @param client
 311             wxArtClient identifier of the client (i.e. who is asking for the bitmap).
 312             This only servers as a hint.
 313         @param size
 314             Preferred size of the bitmap. The function may return a bitmap of different
 315             dimensions, it will be automatically rescaled to meet client's request.
 316
 317         @note
 318         This is not part of wxArtProvider's public API, use wxArtProvider::GetBitmap
 319         or wxArtProvider::GetIconBundle or wxArtProvider::GetIcon to query wxArtProvider
 320         for a resource.
 321
 322         @see CreateIconBundle()
 323     */
 324     virtual wxBitmap CreateBitmap(const wxArtID& id,
 325                                   const wxArtClient& client,
 326                                   const wxSize& size);
 327
 328     /**
 329         This method is similar to CreateBitmap() but can be used when a bitmap
 330         (or an icon) exists in several sizes.
 331     */
 332     virtual wxIconBundle CreateIconBundle(const wxArtID& id,
 333                                           const wxArtClient& client);
 334 };
 335