X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c4f71cc3d63fb7bdfbd6cec3e39c8a8679f3e60..de536319f16406adf967003637b2655c61f6cb09:/interface/artprov.h?ds=inline

diff --git a/interface/artprov.h b/interface/artprov.h
index d78cd3767b..fc50474b81 100644
--- a/interface/artprov.h
+++ b/interface/artprov.h
@@ -18,8 +18,8 @@
     replace standard art with their own version.
 
     All that is needed is to derive a class from wxArtProvider, override either its
-    wxArtProvider::CreateBitmap and/or its wxArtProvider::CreateIconBundle methods
-    and register the provider with wxArtProvider::Push:
+    wxArtProvider::CreateBitmap() and/or its wxArtProvider::CreateIconBundle() methods
+    and register the provider with wxArtProvider::Push():
 
     @code
       class MyProvider : public wxArtProvider
@@ -47,7 +47,7 @@
     wxArtProvider::GetIcon.
 
     @todo IS THIS NB TRUE?
-    (NB: this is not yet really possible as of wxWidgets 2.3.3, the set of wxArtProvider
+    (@note this is not yet really possible as of wxWidgets 2.3.3, the set of wxArtProvider
      bitmaps is too small).
 
     @section wxartprovider_identify Identifying art resources
@@ -55,7 +55,7 @@
     Every bitmap and icon bundle are known to wxArtProvider under an unique ID that
     is used when requesting a resource from it. The ID is represented by wxArtID type
     and can have one of these predefined values (you can see bitmaps represented by these
-    constants in the @ref page_utils_samples_artprovider):
+    constants in the @ref page_samples_artprovider):
 
     <table>
     <tr><td>
@@ -152,7 +152,7 @@
     @library{wxcore}
     @category{misc,data}
 
-    @see the @ref page_utils_samples_artprovider for an example of wxArtProvider usage.
+    @see the @ref page_samples_artprovider for an example of wxArtProvider usage.
 */
 class wxArtProvider : public wxObject
 {
@@ -161,43 +161,10 @@ public:
         The destructor automatically removes the provider from the provider stack used
         by GetBitmap().
     */
-    ~wxArtProvider();
+    virtual ~wxArtProvider();
 
     /**
-        Derived art provider classes must override this method to create requested art
-        resource. Note that returned bitmaps are cached by wxArtProvider and it is
-        therefore not necessary to optimize CreateBitmap() for speed (e.g. you may
-        create wxBitmap objects from XPMs here).
-
-        @param id
-            wxArtID unique identifier of the bitmap.
-        @param client
-            wxArtClient identifier of the client (i.e. who is asking for the bitmap).
-            This only servers as a hint.
-        @param size
-            Preferred size of the bitmap. The function may return a bitmap of different
-            dimensions, it will be automatically rescaled to meet client's request.
-
-        @note
-        This is not part of wxArtProvider's public API, use wxArtProvider::GetBitmap
-        or wxArtProvider::GetIconBundle or wxArtProvider::GetIcon to query wxArtProvider
-        for a resource.
-
-        @see CreateIconBundle()
-    */
-    wxBitmap CreateBitmap(const wxArtID& id,
-                          const wxArtClient& client,
-                          const wxSize& size);
-
-    /**
-        This method is similar to CreateBitmap() but can be used when a bitmap
-        (or an icon) exists in several sizes.
-    */
-    wxIconBundle CreateIconBundle(const wxArtID& id,
-                                  const wxArtClient& client);
-
-    /**
-        Delete the given @e provider.
+        Delete the given @a provider.
     */
     static bool Delete(wxArtProvider* provider);
 
@@ -211,8 +178,8 @@ public:
         @param size
             Size of the returned bitmap or wxDefaultSize if size doesn't matter.
 
-        @returns The bitmap if one of registered providers recognizes the ID or
-                 wxNullBitmap otherwise.
+        @return The bitmap if one of registered providers recognizes the ID or
+                wxNullBitmap otherwise.
     */
     static wxBitmap GetBitmap(const wxArtID& id,
                               const wxArtClient& client = wxART_OTHER,
@@ -245,8 +212,8 @@ public:
             wxArtClient identifier of the client (i.e. who is asking for the icon
             bundle).
 
-        @returns The icon bundle if one of registered providers recognizes the ID
-                 or wxNullIconBundle otherwise.
+        @return The icon bundle if one of registered providers recognizes the ID
+                or wxNullIconBundle otherwise.
     */
     static wxIconBundle GetIconBundle(const wxArtID& id,
                                       const wxArtClient& client = wxART_OTHER);
@@ -277,5 +244,40 @@ public:
         deleted, unlike when using Delete().
     */
     static bool Remove(wxArtProvider* provider);
+
+protected:
+
+    /**
+        Derived art provider classes must override this method to create requested art
+        resource. Note that returned bitmaps are cached by wxArtProvider and it is
+        therefore not necessary to optimize CreateBitmap() for speed (e.g. you may
+        create wxBitmap objects from XPMs here).
+
+        @param id
+            wxArtID unique identifier of the bitmap.
+        @param client
+            wxArtClient identifier of the client (i.e. who is asking for the bitmap).
+            This only servers as a hint.
+        @param size
+            Preferred size of the bitmap. The function may return a bitmap of different
+            dimensions, it will be automatically rescaled to meet client's request.
+
+        @note
+        This is not part of wxArtProvider's public API, use wxArtProvider::GetBitmap
+        or wxArtProvider::GetIconBundle or wxArtProvider::GetIcon to query wxArtProvider
+        for a resource.
+
+        @see CreateIconBundle()
+    */
+    virtual wxBitmap CreateBitmap(const wxArtID& id,
+                                  const wxArtClient& client,
+                                  const wxSize& size);
+
+    /**
+        This method is similar to CreateBitmap() but can be used when a bitmap
+        (or an icon) exists in several sizes.
+    */
+    virtual wxIconBundle CreateIconBundle(const wxArtID& id,
+                                          const wxArtClient& client);
 };