update for bakefile 0.2.6

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

diff --git a/interface/wx/artprov.h b/interface/wx/artprov.h
index cf2fd276aecdd41cd4fa745d3f9c20a5da8dd11a..3701f3bdd51afb10d383a81ddfb35261fecec054 100644 (file)
--- a/interface/wx/artprov.h
+++ b/interface/wx/artprov.h
@@ -6,6 +6,17 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/**
+    This type identifies the client of the art objects requested to wxArtProvider.
+*/
+typedef wxString wxArtClient;
+
+/**
+    This type identifies a specific art object which can be requested to wxArtProvider.
+*/
+typedef wxString wxArtID;
+
+
 /**
     @class wxArtProvider
 
@@ -45,14 +56,10 @@
     code and use platform native icons as provided by wxArtProvider::GetBitmap or
     wxArtProvider::GetIcon.
 
-    @todo IS THIS NB TRUE?
-    (@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
+    @section artprovider_identify Identifying art resources
 
     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
+    is used when requesting a resource from it. The ID is represented by the ::wxArtID type
     and can have one of these predefined values (you can see bitmaps represented by these
     constants in the @ref page_samples_artprov):
 
@@ -116,9 +123,16 @@
 
     @note
     When running under GTK+ 2, GTK+ stock item IDs (e.g. @c "gtk-cdrom") may be used
-    as well. Additionally, if wxGTK was compiled against GTK+ >= 2.4, then it is also
-    possible to load icons from current icon theme by specifying their name (without
-    extension and directory components).
+    as well:
+    @code
+    #ifdef __WXGTK__
+        wxBitmap bmp = wxArtProvider::GetBitmap("gtk-cdrom", wxART_MENU);
+    #endif
+    @endcode
+    For a list of the GTK+ stock items please refer to the GTK+ documentation page
+    http://library.gnome.org/devel/gtk/stable/gtk-Stock-Items.html.
+    It is also possible to load icons from the current icon theme by specifying their name 
+    (without extension and directory components).
     Icon themes recognized by GTK+ follow the freedesktop.org Icon Themes specification
     (see http://freedesktop.org/Standards/icon-theme-spec).
     Note that themes are not guaranteed to contain all icons, so wxArtProvider may
@@ -126,9 +140,9 @@
     The default theme is typically installed in @c /usr/share/icons/hicolor.
 
 
-    @section wxartprovider_clients Clients
+    @section artprovider_clients Clients
 
-    Client is the entity that calls wxArtProvider's GetBitmap or GetIcon function.
+    The @e client is the entity that calls wxArtProvider's GetBitmap() or GetIcon() function.
     It is represented by wxClientID type and can have one of these values:
 
     @li wxART_TOOLBAR
@@ -141,7 +155,7 @@
     @li wxART_OTHER (used for all requests that don't fit into any of the
         categories above)
 
-    Client ID servers as a hint to wxArtProvider that is supposed to help it to
+    Client ID serve as a hint to wxArtProvider that is supposed to help it to
     choose the best looking bitmap. For example it is often desirable to use
     slightly different icons in menus and toolbars even though they represent
     the same action (e.g. wxART_FILE_OPEN). Remember that this is really only a
@@ -149,7 +163,7 @@
     identical bitmap for different client values!
 
     @library{wxcore}
-    @category{misc,data}
+    @category{misc}
 
     @see the @ref page_samples_artprov for an example of wxArtProvider usage.
 */
@@ -193,11 +207,29 @@ public:
                           const wxSize& size = wxDefaultSize);
 
     /**
-        Returns a suitable size hint for the given @e wxArtClient. If
-        @a platform_default is @true, return a size based on the current platform,
-        otherwise return the size from the topmost wxArtProvider. @e wxDefaultSize may
-        be returned if the client doesn't have a specified size, like wxART_OTHER for
-        example.
+        Returns native icon size for use specified by @a client hint.
+
+        If the platform has no commonly used default for this use or if
+        @a client is not recognized, returns wxDefaultSize.
+
+        @note In some cases, a platform may have @em several appropriate
+              native sizes (for example, wxART_FRAME_ICON for frame icons).
+              In that case, this method returns only one of them, picked
+              reasonably.
+
+        @since 2.9.0
+     */
+    static wxSize GetNativeSizeHint(const wxArtClient& client);
+
+    /**
+        Returns a suitable size hint for the given @e wxArtClient.
+
+        If @a platform_default is @true, return a size based on the current
+        platform using GetNativeSizeHint(), otherwise return the size from the
+        topmost wxArtProvider. @e wxDefaultSize may be returned if the client
+        doesn't have a specified size, like wxART_OTHER for example.
+
+        @see GetNativeSizeHint()
     */
     static wxSize GetSizeHint(const wxArtClient& client,
                               bool platform_default = false);