]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/artprov.h
remove unneeded includes from mac/carbon/private.h
[wxWidgets.git] / include / wx / artprov.h
index bae82969f3942323cd53944bcef1c176007163bb..c2b9d98bdd8c83dcdd47a228926a24d1b8a32107 100644 (file)
 #ifndef _WX_ARTPROV_H_
 #define _WX_ARTPROV_H_
 
 #ifndef _WX_ARTPROV_H_
 #define _WX_ARTPROV_H_
 
-#ifdef __GNUG__
-#pragma interface "artprov.h"
-#endif
-
 #include "wx/string.h"
 #include "wx/bitmap.h"
 #include "wx/icon.h"
 
 class WXDLLEXPORT wxArtProvidersList;
 class WXDLLEXPORT wxArtProviderCache;
 #include "wx/string.h"
 #include "wx/bitmap.h"
 #include "wx/icon.h"
 
 class WXDLLEXPORT wxArtProvidersList;
 class WXDLLEXPORT wxArtProviderCache;
+class wxArtProviderModule;
 
 // ----------------------------------------------------------------------------
 // Types
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // Types
 // ----------------------------------------------------------------------------
 
-typedef wxString wxArtDomain;
+typedef wxString wxArtClient;
 typedef wxString wxArtID;
 
 typedef wxString wxArtID;
 
+#define wxART_MAKE_CLIENT_ID_FROM_STR(id)  (id + _T("_C"))
+#define wxART_MAKE_CLIENT_ID(id)           _T(#id) _T("_C")
+#define wxART_MAKE_ART_ID_FROM_STR(id)     (id)
+#define wxART_MAKE_ART_ID(id)              _T(#id)
+
+// ----------------------------------------------------------------------------
+// Art clients
+// ----------------------------------------------------------------------------
+
+#define wxART_TOOLBAR              wxART_MAKE_CLIENT_ID(wxART_TOOLBAR)
+#define wxART_MENU                 wxART_MAKE_CLIENT_ID(wxART_MENU)
+#define wxART_FRAME_ICON           wxART_MAKE_CLIENT_ID(wxART_FRAME_ICON)
+
+#define wxART_CMN_DIALOG           wxART_MAKE_CLIENT_ID(wxART_CMN_DIALOG)
+#define wxART_HELP_BROWSER         wxART_MAKE_CLIENT_ID(wxART_HELP_BROWSER)
+#define wxART_MESSAGE_BOX          wxART_MAKE_CLIENT_ID(wxART_MESSAGE_BOX)
+#define wxART_BUTTON               wxART_MAKE_CLIENT_ID(wxART_BUTTON)
+
+#define wxART_OTHER                wxART_MAKE_CLIENT_ID(wxART_OTHER)
+
+// ----------------------------------------------------------------------------
+// Art IDs
+// ----------------------------------------------------------------------------
+
+#define wxART_ADD_BOOKMARK         wxART_MAKE_ART_ID(wxART_ADD_BOOKMARK)
+#define wxART_DEL_BOOKMARK         wxART_MAKE_ART_ID(wxART_DEL_BOOKMARK)
+#define wxART_HELP_SIDE_PANEL      wxART_MAKE_ART_ID(wxART_HELP_SIDE_PANEL)
+#define wxART_HELP_SETTINGS        wxART_MAKE_ART_ID(wxART_HELP_SETTINGS)
+#define wxART_HELP_BOOK            wxART_MAKE_ART_ID(wxART_HELP_BOOK)
+#define wxART_HELP_FOLDER          wxART_MAKE_ART_ID(wxART_HELP_FOLDER)
+#define wxART_HELP_PAGE            wxART_MAKE_ART_ID(wxART_HELP_PAGE)
+#define wxART_GO_BACK              wxART_MAKE_ART_ID(wxART_GO_BACK)
+#define wxART_GO_FORWARD           wxART_MAKE_ART_ID(wxART_GO_FORWARD)
+#define wxART_GO_UP                wxART_MAKE_ART_ID(wxART_GO_UP)
+#define wxART_GO_DOWN              wxART_MAKE_ART_ID(wxART_GO_DOWN)
+#define wxART_GO_TO_PARENT         wxART_MAKE_ART_ID(wxART_GO_TO_PARENT)
+#define wxART_GO_HOME              wxART_MAKE_ART_ID(wxART_GO_HOME)
+#define wxART_FILE_OPEN            wxART_MAKE_ART_ID(wxART_FILE_OPEN)
+#define wxART_FILE_SAVE            wxART_MAKE_ART_ID(wxART_FILE_SAVE)
+#define wxART_FILE_SAVE_AS         wxART_MAKE_ART_ID(wxART_FILE_SAVE_AS)
+#define wxART_PRINT                wxART_MAKE_ART_ID(wxART_PRINT)
+#define wxART_HELP                 wxART_MAKE_ART_ID(wxART_HELP)
+#define wxART_TIP                  wxART_MAKE_ART_ID(wxART_TIP)
+#define wxART_REPORT_VIEW          wxART_MAKE_ART_ID(wxART_REPORT_VIEW)
+#define wxART_LIST_VIEW            wxART_MAKE_ART_ID(wxART_LIST_VIEW)
+#define wxART_NEW_DIR              wxART_MAKE_ART_ID(wxART_NEW_DIR)
+#define wxART_HARDDISK             wxART_MAKE_ART_ID(wxART_HARDDISK)
+#define wxART_FLOPPY               wxART_MAKE_ART_ID(wxART_FLOPPY)
+#define wxART_CDROM                wxART_MAKE_ART_ID(wxART_CDROM)
+#define wxART_REMOVABLE            wxART_MAKE_ART_ID(wxART_REMOVABLE)
+#define wxART_FOLDER               wxART_MAKE_ART_ID(wxART_FOLDER)
+#define wxART_FOLDER_OPEN          wxART_MAKE_ART_ID(wxART_FOLDER_OPEN)
+#define wxART_GO_DIR_UP            wxART_MAKE_ART_ID(wxART_GO_DIR_UP)
+#define wxART_EXECUTABLE_FILE      wxART_MAKE_ART_ID(wxART_EXECUTABLE_FILE)
+#define wxART_NORMAL_FILE          wxART_MAKE_ART_ID(wxART_NORMAL_FILE)
+#define wxART_TICK_MARK            wxART_MAKE_ART_ID(wxART_TICK_MARK)
+#define wxART_CROSS_MARK           wxART_MAKE_ART_ID(wxART_CROSS_MARK)
+#define wxART_ERROR                wxART_MAKE_ART_ID(wxART_ERROR)
+#define wxART_QUESTION             wxART_MAKE_ART_ID(wxART_QUESTION)
+#define wxART_WARNING              wxART_MAKE_ART_ID(wxART_WARNING)
+#define wxART_INFORMATION          wxART_MAKE_ART_ID(wxART_INFORMATION)
+#define wxART_MISSING_IMAGE        wxART_MAKE_ART_ID(wxART_MISSING_IMAGE)
+
+#define wxART_COPY                 wxART_MAKE_ART_ID(wxART_COPY)
+#define wxART_CUT                  wxART_MAKE_ART_ID(wxART_CUT)
+#define wxART_PASTE                wxART_MAKE_ART_ID(wxART_PASTE)
+#define wxART_DELETE               wxART_MAKE_ART_ID(wxART_DELETE)
+#define wxART_NEW                  wxART_MAKE_ART_ID(wxART_NEW)
+
+#define wxART_UNDO                 wxART_MAKE_ART_ID(wxART_UNDO)
+#define wxART_REDO                 wxART_MAKE_ART_ID(wxART_REDO)
+
+#define wxART_QUIT                 wxART_MAKE_ART_ID(wxART_QUIT)
+
+#define wxART_FIND                 wxART_MAKE_ART_ID(wxART_FIND)
+#define wxART_FIND_AND_REPLACE     wxART_MAKE_ART_ID(wxART_FIND_AND_REPLACE)
+
+
 // ----------------------------------------------------------------------------
 // wxArtProvider class
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxArtProvider class
 // ----------------------------------------------------------------------------
@@ -46,31 +121,44 @@ public:
     // Remove provider. The provider must have been added previously!
     // The provider is _not_ deleted.
     static bool RemoveProvider(wxArtProvider *provider);
     // Remove provider. The provider must have been added previously!
     // The provider is _not_ deleted.
     static bool RemoveProvider(wxArtProvider *provider);
-    
+
     // Query the providers for bitmap with given ID and return it. Return
     // wxNullBitmap if no provider provides it.
     // Query the providers for bitmap with given ID and return it. Return
     // wxNullBitmap if no provider provides it.
-    static wxBitmap GetBitmap(const wxArtDomain& domain, const wxArtID& id,
+    static wxBitmap GetBitmap(const wxArtID& id,
+                              const wxArtClient& client = wxART_OTHER,
                               const wxSize& size = wxDefaultSize);
 
     // Query the providers for icon with given ID and return it. Return
     // wxNullIcon if no provider provides it.
                               const wxSize& size = wxDefaultSize);
 
     // Query the providers for icon with given ID and return it. Return
     // wxNullIcon if no provider provides it.
-    static wxIcon GetIcon(const wxArtDomain& domain, const wxArtID& id,
+    static wxIcon GetIcon(const wxArtID& id,
+                          const wxArtClient& client = wxART_OTHER,
                           const wxSize& size = wxDefaultSize);
 
                           const wxSize& size = wxDefaultSize);
 
+    // Get the size hint of an icon from a specific wxArtClient, queries 
+    // the topmost provider if platform_dependent = false
+    static wxSize GetSizeHint(const wxArtClient& client, bool platform_dependent = false);
+
+protected:
+    friend class wxArtProviderModule;
+    // Initializes default provider
+    static void InitStdProvider();
+    // Initializes platform's native provider, if available (e.g. GTK2)
+    static void InitNativeProvider();
     // Destroy caches & all providers
     static void CleanUpProviders();
 
     // Destroy caches & all providers
     static void CleanUpProviders();
 
-protected:
-    // Derived classes must override this method to create requested 
-    // art resource. This method is called only once per instance's
-    // lifetime for each requested wxArtID.
-    virtual wxBitmap CreateBitmap(const wxArtDomain& WXUNUSED(domain), 
-                                  const wxArtID& WXUNUSED(id),
-                                  const wxSize& WXUNUSED(size))
+    // Get the default size of an icon for a specific client
+    virtual wxSize DoGetSizeHint(const wxArtClient& client) 
     {
     {
-        wxFAIL_MSG(_T("pure virtual method wxArtProvider::CreateBitmap called!"));
-        return wxNullBitmap;
+        return GetSizeHint(client, true);
     }
     }
+                             
+    // Derived classes must override this method to create requested
+    // art resource. This method is called only once per instance's
+    // lifetime for each requested wxArtID.
+    virtual wxBitmap CreateBitmap(const wxArtID& WXUNUSED(id),
+                                  const wxArtClient& WXUNUSED(client),
+                                  const wxSize& WXUNUSED(size)) = 0;
 
 private:
     // list of providers:
 
 private:
     // list of providers:
@@ -82,38 +170,4 @@ private:
 };
 
 
 };
 
 
-// ----------------------------------------------------------------------------
-// Art pieces identifiers
-// ----------------------------------------------------------------------------
-
-// This is comprehensive list of art identifiers recognized by wxWindows. The
-// identifiers follow two-levels scheme where a piece of art is described by
-// its domain (file dialog, HTML help toolbar etc.) and resource identifier
-// within the domain
-
-#define wxART_WXHTML                   _T("wxhtml")
-    #define wxART_ADD_BOOKMARK             _T("add_bookmark")
-    #define wxART_DEL_BOOKMARK             _T("del_bookmark")
-    #define wxART_NAVIG_PANEL              _T("navig_panel")
-    #define wxART_HELP_SETTINGS            _T("help_settings")
-    #define wxART_HELP_BOOK                _T("help_book")
-    #define wxART_HELP_FOLDER              _T("help_folder")
-    #define wxART_HELP_PAGE                _T("help_page")
-
-#define wxART_BROWSER_TOOLBAR          _T("browser_toolbar")
-    #define wxART_GO_BACK                  _T("go_back")
-    #define wxART_GO_FORWARD               _T("go_forward")
-    #define wxART_GO_UP                    _T("go_up")
-    #define wxART_GO_DOWN                  _T("go_down")
-    #define wxART_GO_TO_PARENT             _T("go_to_parent")
-
-#define wxART_TOOLBAR                  _T("toolbar")
-    #define wxART_FILE_OPEN                _T("file_open")
-    #define wxART_PRINT                    _T("print")
-
-#define wxART_FRAME_ICON               _T("frame_icon")
-    #define wxART_HELP                     _T("help")
-    
-    
-
 #endif // _WX_ARTPROV_H_
 #endif // _WX_ARTPROV_H_