]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/artprov.tex
patch 1306473
[wxWidgets.git] / docs / latex / wx / artprov.tex
index c30aaaf8244f773da020538914e09e5e4ad8af32..16a804837e4e5a7850a31f2ceb9569ab34dfd51a 100644 (file)
@@ -29,8 +29,7 @@ provider with
 \end{verbatim}
 
 There's another way of taking advantage of this class: you can use it in your code and use
-platform native icons as provided by
-\helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or 
+platform native icons as provided by \helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or 
 \helpref{wxArtProvider::GetIcon}{wxartprovidergeticon} (NB: this is not yet really
 possible as of wxWidgets 2.3.3, the set of wxArtProvider bitmaps is too
 small). 
@@ -177,6 +176,13 @@ The bitmap if one of registered providers recognizes the ID or wxNullBitmap othe
 Same as \helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap}, but
 return a wxIcon object (or wxNullIcon on failure).
 
+\func{static wxSize}{GetSizeHint}{\param{const wxArtClient\& }{client}, \param{bool }{platform\_default = false}}
+
+Returns a suitable size hint for the given {\it wxArtClient}. If 
+{\it platform\_default} is \true, return a size based on the current platform, 
+otherwise return the size from the topmost wxArtProvider. {\it wxDefaultSize} may be 
+returned if the client doesn't have a specified size, like wxART\_OTHER for example.
+
 \membersection{wxArtProvider::PopProvider}\label{wxartproviderctor}
 
 \func{static bool}{PopProvider}{\void}