use std::[w]string for wxString implementation unless wxUSE_STD_STRING==0 but even...

[wxWidgets.git] / include / wx / artprov.h

diff --git a/include/wx/artprov.h b/include/wx/artprov.h
index a8f59cb774d516cce2819bdfeacb1dbf838bd773..34f365a8e98aba52e70ccb450ef84c1a74e4f63c 100644 (file)
--- a/include/wx/artprov.h
+++ b/include/wx/artprov.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        artprov.h
+// Name:        wx/artprov.h

 // Purpose:     wxArtProvider class
 // Author:      Vaclav Slavik
 // Modified by:
 // Purpose:     wxArtProvider class
 // Author:      Vaclav Slavik
 // Modified by:


@@ -12,16 +12,13 @@
 #ifndef _WX_ARTPROV_H_
 #define _WX_ARTPROV_H_
 
 #ifndef _WX_ARTPROV_H_
 #define _WX_ARTPROV_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "artprov.h"
-#endif
-

 #include "wx/string.h"
 #include "wx/bitmap.h"
 #include "wx/icon.h"
 #include "wx/string.h"
 #include "wx/bitmap.h"
 #include "wx/icon.h"

+#include "wx/iconbndl.h"

 
 

-class WXDLLEXPORT wxArtProvidersList;
-class WXDLLEXPORT wxArtProviderCache;
+class WXDLLIMPEXP_FWD_CORE wxArtProvidersList;
+class WXDLLIMPEXP_FWD_CORE wxArtProviderCache;

 class wxArtProviderModule;
 
 // ----------------------------------------------------------------------------
 class wxArtProviderModule;
 
 // ----------------------------------------------------------------------------


@@ -31,7 +28,7 @@ class wxArtProviderModule;
 typedef wxString wxArtClient;
 typedef wxString wxArtID;
 
 typedef wxString wxArtClient;
 typedef wxString wxArtID;
 

-#define wxART_MAKE_CLIENT_ID_FROM_STR(id)  (wxString(id)+_T("_C"))
+#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)
 #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)


@@ -48,6 +45,7 @@ typedef wxString wxArtID;
 #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_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_LIST                 wxART_MAKE_CLIENT_ID(wxART_LIST)

 
 #define wxART_OTHER                wxART_MAKE_CLIENT_ID(wxART_OTHER)
 
 
 #define wxART_OTHER                wxART_MAKE_CLIENT_ID(wxART_OTHER)
 


@@ -69,13 +67,20 @@ typedef wxString wxArtID;
 #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_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_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               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_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)


@@ -87,22 +92,49 @@ typedef wxString wxArtID;
 #define wxART_INFORMATION          wxART_MAKE_ART_ID(wxART_INFORMATION)
 #define wxART_MISSING_IMAGE        wxART_MAKE_ART_ID(wxART_MISSING_IMAGE)
 
 #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
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxArtProvider : public wxObject
+class WXDLLIMPEXP_CORE wxArtProvider : public wxObject

 {
 public:
 {
 public:

-    // Add new provider to the top of providers stack.
-    static void PushProvider(wxArtProvider *provider);
+    // Dtor removes the provider from providers stack if it's still on it
+    virtual ~wxArtProvider();
+
+
+    // Add new provider to the top of providers stack (i.e. the provider will
+    // be queried first of all).
+    static void Push(wxArtProvider *provider);
+
+    // Add new provider to the bottom of providers stack (i.e. the provider
+    // will be queried as the last one).
+    static void Insert(wxArtProvider *provider);

 
     // Remove latest added provider and delete it.
 
     // Remove latest added provider and delete it.

-    static bool PopProvider();
+    static bool Pop();
+
+    // Remove provider from providers stack but don't delete it.
+    static bool Remove(wxArtProvider *provider);
+
+    // Delete the given provider and remove it from the providers stack.
+    static bool Delete(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.


@@ -116,6 +148,32 @@ public:
                           const wxArtClient& client = wxART_OTHER,
                           const wxSize& size = wxDefaultSize);
 
                           const wxArtClient& client = wxART_OTHER,
                           const wxSize& size = wxDefaultSize);
 

+    // Helper used by several generic classes: return the icon corresponding to
+    // the standard wxICON_INFORMATION/WARNING/ERROR/QUESTION flags (only one
+    // can be set)
+    static wxIcon GetMessageBoxIcon(int flags);
+
+    // Query the providers for iconbundle with given ID and return it. Return
+    // wxNullIconBundle if no provider provides it.
+    static wxIconBundle GetIconBundle(const wxArtID& id,
+                                      const wxArtClient& client = wxART_OTHER);
+
+    // 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);
+
+#if WXWIN_COMPATIBILITY_2_6
+    // use the corresponding methods without redundant "Provider" suffix
+    wxDEPRECATED( static void PushProvider(wxArtProvider *provider) );
+    wxDEPRECATED( static void InsertProvider(wxArtProvider *provider) );
+    wxDEPRECATED( static bool PopProvider() );
+
+    // use Delete() if this is what you really need, or just delete the
+    // provider pointer, do not use Remove() as it does not delete the pointer
+    // unlike RemoveProvider() which does
+    wxDEPRECATED( static bool RemoveProvider(wxArtProvider *provider) );
+#endif // WXWIN_COMPATIBILITY_2_6
+

 protected:
     friend class wxArtProviderModule;
     // Initializes default provider
 protected:
     friend class wxArtProviderModule;
     // Initializes default provider


@@ -125,12 +183,27 @@ protected:
     // Destroy caches & all providers
     static void CleanUpProviders();
 
     // Destroy caches & all providers
     static void CleanUpProviders();
 

-    // 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.
+    // Get the default size of an icon for a specific client
+    virtual wxSize DoGetSizeHint(const wxArtClient& client)
+    {
+        return GetSizeHint(client, true);
+    }
+
+    // Derived classes must override CreateBitmap or CreateIconBundle
+    // (or both) 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),
     virtual wxBitmap CreateBitmap(const wxArtID& WXUNUSED(id),
                                   const wxArtClient& WXUNUSED(client),

-                                  const wxSize& WXUNUSED(size)) = 0;
+                                  const wxSize& WXUNUSED(size)) { return wxNullBitmap; }
+
+    virtual wxIconBundle CreateIconBundle(const wxArtID& WXUNUSED(id),
+                                          const wxArtClient& WXUNUSED(client))
+    {
+        return wxNullIconBundle;
+    }
+
+private:
+    static void CommonAddingProvider();

 
 private:
     // list of providers:
 
 private:
     // list of providers: