Clarify documentation for wxPropertyGridEvent::GetProperty()

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

diff --git a/include/wx/artprov.h b/include/wx/artprov.h
index e98bd411828c7231062f18724be7110a489424b6..ba545c1b93e91cfac6ae4443af44c6160dd3b22a 100644 (file)
--- a/include/wx/artprov.h
+++ b/include/wx/artprov.h
@@ -17,8 +17,8 @@
 #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;
 
 // ----------------------------------------------------------------------------
@@ -28,10 +28,10 @@ class wxArtProviderModule;
 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 + wxT("_C"))
+#define wxART_MAKE_CLIENT_ID(id)           wxT(#id) wxT("_C")
 #define wxART_MAKE_ART_ID_FROM_STR(id)     (id)
-#define wxART_MAKE_ART_ID(id)              _T(#id)
+#define wxART_MAKE_ART_ID(id)              wxT(#id)
 
 // ----------------------------------------------------------------------------
 // Art clients
@@ -101,6 +101,7 @@ typedef wxString wxArtID;
 #define wxART_UNDO                 wxART_MAKE_ART_ID(wxART_UNDO)
 #define wxART_REDO                 wxART_MAKE_ART_ID(wxART_REDO)
 
+#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)
@@ -111,12 +112,14 @@ typedef wxString wxArtID;
 // 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();
 
+    // 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).
@@ -124,7 +127,12 @@ public:
 
     // 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
+    wxDEPRECATED( static void Insert(wxArtProvider *provider) );
+#endif
 
     // Remove latest added provider and delete it.
     static bool Pop();
@@ -148,11 +156,28 @@ public:
                           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)
+    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);
 
+    // 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);
@@ -189,7 +214,10 @@ protected:
     // 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))
@@ -199,6 +227,8 @@ protected:
 
 private:
     static void CommonAddingProvider();
+    static wxIconBundle DoGetIconBundle(const wxArtID& id,
+                                        const wxArtClient& client);
 
 private:
     // list of providers:
@@ -210,4 +240,12 @@ private:
 };
 
 
+#if !defined(__WXUNIVERSAL__) && \
+    ((defined(__WXGTK__) && defined(__WXGTK20__)) || defined(__WXMSW__) || \
+     (defined(__WXMAC__) && wxOSX_USE_COCOA_OR_CARBON))
+  // *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_