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_FILE_SAVE            wxART_MAKE_ART_ID(wxART_FILE_SAVE)
  73 #define wxART_FILE_SAVE_AS         wxART_MAKE_ART_ID(wxART_FILE_SAVE_AS)
  74 #define wxART_PRINT                wxART_MAKE_ART_ID(wxART_PRINT)
  75 #define wxART_HELP                 wxART_MAKE_ART_ID(wxART_HELP)
  76 #define wxART_TIP                  wxART_MAKE_ART_ID(wxART_TIP)
  77 #define wxART_REPORT_VIEW          wxART_MAKE_ART_ID(wxART_REPORT_VIEW)
  78 #define wxART_LIST_VIEW            wxART_MAKE_ART_ID(wxART_LIST_VIEW)
  79 #define wxART_NEW_DIR              wxART_MAKE_ART_ID(wxART_NEW_DIR)
  80 #define wxART_HARDDISK             wxART_MAKE_ART_ID(wxART_HARDDISK)
  81 #define wxART_FLOPPY               wxART_MAKE_ART_ID(wxART_FLOPPY)
  82 #define wxART_CDROM                wxART_MAKE_ART_ID(wxART_CDROM)
  83 #define wxART_REMOVABLE            wxART_MAKE_ART_ID(wxART_REMOVABLE)
  84 #define wxART_FOLDER               wxART_MAKE_ART_ID(wxART_FOLDER)
  85 #define wxART_FOLDER_OPEN          wxART_MAKE_ART_ID(wxART_FOLDER_OPEN)
  86 #define wxART_GO_DIR_UP            wxART_MAKE_ART_ID(wxART_GO_DIR_UP)
  87 #define wxART_EXECUTABLE_FILE      wxART_MAKE_ART_ID(wxART_EXECUTABLE_FILE)
  88 #define wxART_NORMAL_FILE          wxART_MAKE_ART_ID(wxART_NORMAL_FILE)
  89 #define wxART_TICK_MARK            wxART_MAKE_ART_ID(wxART_TICK_MARK)
  90 #define wxART_CROSS_MARK           wxART_MAKE_ART_ID(wxART_CROSS_MARK)
  91 #define wxART_ERROR                wxART_MAKE_ART_ID(wxART_ERROR)
  92 #define wxART_QUESTION             wxART_MAKE_ART_ID(wxART_QUESTION)
  93 #define wxART_WARNING              wxART_MAKE_ART_ID(wxART_WARNING)
  94 #define wxART_INFORMATION          wxART_MAKE_ART_ID(wxART_INFORMATION)
  95 #define wxART_MISSING_IMAGE        wxART_MAKE_ART_ID(wxART_MISSING_IMAGE)
  96
  97 #define wxART_COPY                 wxART_MAKE_ART_ID(wxART_COPY)
  98 #define wxART_CUT                  wxART_MAKE_ART_ID(wxART_CUT)
  99 #define wxART_PASTE                wxART_MAKE_ART_ID(wxART_PASTE)
 100 #define wxART_DELETE               wxART_MAKE_ART_ID(wxART_DELETE)
 101 #define wxART_NEW                  wxART_MAKE_ART_ID(wxART_NEW)
 102
 103 #define wxART_UNDO                 wxART_MAKE_ART_ID(wxART_UNDO)
 104 #define wxART_REDO                 wxART_MAKE_ART_ID(wxART_REDO)
 105
 106 #define wxART_QUIT                 wxART_MAKE_ART_ID(wxART_QUIT)
 107
 108 #define wxART_FIND                 wxART_MAKE_ART_ID(wxART_FIND)
 109 #define wxART_FIND_AND_REPLACE     wxART_MAKE_ART_ID(wxART_FIND_AND_REPLACE)
 110
 111
 112 // ----------------------------------------------------------------------------
 113 // wxArtProvider class
 114 // ----------------------------------------------------------------------------
 115
 116 class WXDLLEXPORT wxArtProvider : public wxObject
 117 {
 118 public:
 119     // Add new provider to the top of providers stack.
 120     static void PushProvider(wxArtProvider *provider);
 121
 122     // Remove latest added provider and delete it.
 123     static bool PopProvider();
 124
 125     // Remove provider. The provider must have been added previously!
 126     // The provider is _not_ deleted.
 127     static bool RemoveProvider(wxArtProvider *provider);
 128
 129     // Query the providers for bitmap with given ID and return it. Return
 130     // wxNullBitmap if no provider provides it.
 131     static wxBitmap GetBitmap(const wxArtID& id,
 132                               const wxArtClient& client = wxART_OTHER,
 133                               const wxSize& size = wxDefaultSize);
 134
 135     // Query the providers for icon with given ID and return it. Return
 136     // wxNullIcon if no provider provides it.
 137     static wxIcon GetIcon(const wxArtID& id,
 138                           const wxArtClient& client = wxART_OTHER,
 139                           const wxSize& size = wxDefaultSize);
 140
 141     // Get the size hint of an icon from a specific wxArtClient, queries
 142     // the topmost provider if platform_dependent = false
 143     static wxSize GetSizeHint(const wxArtClient& client, bool platform_dependent = false);
 144
 145 protected:
 146     friend class wxArtProviderModule;
 147     // Initializes default provider
 148     static void InitStdProvider();
 149     // Initializes platform's native provider, if available (e.g. GTK2)
 150     static void InitNativeProvider();
 151     // Destroy caches & all providers
 152     static void CleanUpProviders();
 153
 154     // Get the default size of an icon for a specific client
 155     virtual wxSize DoGetSizeHint(const wxArtClient& client)
 156     {
 157         return GetSizeHint(client, true);
 158     }
 159
 160     // Derived classes must override this method to create requested
 161     // art resource. This method is called only once per instance's
 162     // lifetime for each requested wxArtID.
 163     virtual wxBitmap CreateBitmap(const wxArtID& WXUNUSED(id),
 164                                   const wxArtClient& WXUNUSED(client),
 165                                   const wxSize& WXUNUSED(size)) = 0;
 166
 167 private:
 168     // list of providers:
 169     static wxArtProvidersList *sm_providers;
 170     // art resources cache (so that CreateXXX is not called that often):
 171     static wxArtProviderCache *sm_cache;
 172
 173     DECLARE_ABSTRACT_CLASS(wxArtProvider)
 174 };
 175
 176
 177 #endif // _WX_ARTPROV_H_