Add RunScript and implement on all backends. Document and add a very simple unit...

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

diff --git a/include/wx/artprov.h b/include/wx/artprov.h
index e49c3b36d59aee5caf8dc20ca85d6424e8377eba..7eef3973c4266c2fd1a0d479e6d086ea1ccbccfb 100644 (file)
--- a/include/wx/artprov.h
+++ b/include/wx/artprov.h
@@ -28,10 +28,10 @@ class wxArtProviderModule;
 typedef wxString wxArtClient;
 typedef wxString wxArtID;
 
 typedef wxString wxArtClient;
 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_CLIENT_ID_FROM_STR(id)  ((id) + "_C")
+#define wxART_MAKE_CLIENT_ID(id)           (#id "_C")

 #define wxART_MAKE_ART_ID_FROM_STR(id)     (id)
 #define wxART_MAKE_ART_ID_FROM_STR(id)     (id)

-#define wxART_MAKE_ART_ID(id)              _T(#id)
+#define wxART_MAKE_ART_ID(id)              (#id)

 
 // ----------------------------------------------------------------------------
 // Art clients
 
 // ----------------------------------------------------------------------------
 // Art clients


@@ -66,6 +66,8 @@ typedef wxString wxArtID;
 #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_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_GOTO_FIRST           wxART_MAKE_ART_ID(wxART_GOTO_FIRST)
+#define wxART_GOTO_LAST            wxART_MAKE_ART_ID(wxART_GOTO_LAST)

 #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_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)


@@ -101,6 +103,10 @@ typedef wxString wxArtID;
 #define wxART_UNDO                 wxART_MAKE_ART_ID(wxART_UNDO)
 #define wxART_REDO                 wxART_MAKE_ART_ID(wxART_REDO)
 
 #define wxART_UNDO                 wxART_MAKE_ART_ID(wxART_UNDO)
 #define wxART_REDO                 wxART_MAKE_ART_ID(wxART_REDO)
 

+#define wxART_PLUS                 wxART_MAKE_ART_ID(wxART_PLUS)
+#define wxART_MINUS                wxART_MAKE_ART_ID(wxART_MINUS)
+
+#define wxART_CLOSE                wxART_MAKE_ART_ID(wxART_CLOSE)

 #define wxART_QUIT                 wxART_MAKE_ART_ID(wxART_QUIT)
 
 #define wxART_FIND                 wxART_MAKE_ART_ID(wxART_FIND)
 #define wxART_QUIT                 wxART_MAKE_ART_ID(wxART_QUIT)
 
 #define wxART_FIND                 wxART_MAKE_ART_ID(wxART_FIND)


@@ -111,12 +117,14 @@ typedef wxString wxArtID;
 // wxArtProvider class
 // ----------------------------------------------------------------------------
 
 // wxArtProvider class
 // ----------------------------------------------------------------------------
 

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

 {
 public:
     // Dtor removes the provider from providers stack if it's still on it
     virtual ~wxArtProvider();
 
 {
 public:
     // Dtor removes the provider from providers stack if it's still on it
     virtual ~wxArtProvider();
 

+    // Does this platform implement native icons theme?
+    static bool HasNativeProvider();

 
     // Add new provider to the top of providers stack (i.e. the provider will
     // be queried first of all).
 
     // Add new provider to the top of providers stack (i.e. the provider will
     // be queried first of all).


@@ -124,7 +132,12 @@ public:
 
     // Add new provider to the bottom of providers stack (i.e. the provider
     // will be queried as the last one).
 
     // 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);
+    static void PushBack(wxArtProvider *provider);
+
+#if WXWIN_COMPATIBILITY_2_8
+    // use PushBack(), it's the same thing
+    static wxDEPRECATED( void Insert(wxArtProvider *provider) );
+#endif

 
     // Remove latest added provider and delete it.
     static bool Pop();
 
     // Remove latest added provider and delete it.
     static bool Pop();


@@ -148,36 +161,54 @@ public:
                           const wxArtClient& client = wxART_OTHER,
                           const wxSize& size = wxDefaultSize);
 
                           const wxArtClient& client = wxART_OTHER,
                           const wxSize& size = wxDefaultSize);
 

+    // Helper used by GetMessageBoxIcon(): return the art id corresponding to
+    // the standard wxICON_INFORMATION/WARNING/ERROR/QUESTION flags (only one
+    // can be set)
+    static wxArtID GetMessageBoxIconId(int flags);
+

     // Helper used by several generic classes: return the icon corresponding to
     // the standard wxICON_INFORMATION/WARNING/ERROR/QUESTION flags (only one
     // can be set)
     // 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);
+    static wxIcon GetMessageBoxIcon(int flags)
+    {
+        return GetIcon(GetMessageBoxIconId(flags), wxART_MESSAGE_BOX);
+    }

 
     // 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);
 
 
     // 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);
 

+    // Gets native size for given 'client' or wxDefaultSize if it doesn't
+    // have native equivalent
+    static wxSize GetNativeSizeHint(const wxArtClient& client);
+

     // 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
     // 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() );
+    static wxDEPRECATED( void PushProvider(wxArtProvider *provider) );
+    static wxDEPRECATED( void InsertProvider(wxArtProvider *provider) );
+    static wxDEPRECATED( 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
 
     // 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) );
+    static wxDEPRECATED( bool RemoveProvider(wxArtProvider *provider) );

 #endif // WXWIN_COMPATIBILITY_2_6
 
 protected:
     friend class wxArtProviderModule;
 #endif // WXWIN_COMPATIBILITY_2_6
 
 protected:
     friend class wxArtProviderModule;

+#if wxUSE_ARTPROVIDER_STD

     // Initializes default provider
     static void InitStdProvider();
     // Initializes default provider
     static void InitStdProvider();

+#endif // wxUSE_ARTPROVIDER_STD
+    // Initializes Tango-based icon provider
+#if wxUSE_ARTPROVIDER_TANGO
+    static void InitTangoProvider();
+#endif // wxUSE_ARTPROVIDER_TANGO

     // Initializes platform's native provider, if available (e.g. GTK2)
     static void InitNativeProvider();
     // Destroy caches & all providers
     // Initializes platform's native provider, if available (e.g. GTK2)
     static void InitNativeProvider();
     // Destroy caches & all providers


@@ -194,7 +225,10 @@ protected:
     // only once per instance's lifetime for each requested wxArtID.
     virtual wxBitmap CreateBitmap(const wxArtID& WXUNUSED(id),
                                   const wxArtClient& WXUNUSED(client),
     // 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)) { return wxNullBitmap; }
+                                  const wxSize& WXUNUSED(size))
+    {
+        return wxNullBitmap;
+    }

 
     virtual wxIconBundle CreateIconBundle(const wxArtID& WXUNUSED(id),
                                           const wxArtClient& WXUNUSED(client))
 
     virtual wxIconBundle CreateIconBundle(const wxArtID& WXUNUSED(id),
                                           const wxArtClient& WXUNUSED(client))


@@ -204,6 +238,8 @@ protected:
 
 private:
     static void CommonAddingProvider();
 
 private:
     static void CommonAddingProvider();

+    static wxIconBundle DoGetIconBundle(const wxArtID& id,
+                                        const wxArtClient& client);

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


@@ -215,4 +251,12 @@ private:
 };
 
 
 };
 
 

+#if !defined(__WXUNIVERSAL__) && \
+    ((defined(__WXGTK__) && defined(__WXGTK20__)) || defined(__WXMSW__) || \
+     defined(__WXMAC__))
+  // *some* (partial) native implementation of wxArtProvider exists; this is
+  // not the same as wxArtProvider::HasNativeProvider()!
+  #define wxHAS_NATIVE_ART_PROVIDER_IMPL
+#endif
+

 #endif // _WX_ARTPROV_H_
 #endif // _WX_ARTPROV_H_