X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dbd94b75015561fe527069c138ce43c44797fe35..b253fb5cea219d563583fa8c26e71473f1c5c946:/docs/latex/wx/artprov.tex?ds=sidebyside diff --git a/docs/latex/wx/artprov.tex b/docs/latex/wx/artprov.tex index 109ae25880..16a804837e 100644 --- a/docs/latex/wx/artprov.tex +++ b/docs/latex/wx/artprov.tex @@ -6,11 +6,11 @@ \section{\class{wxArtProvider}}\label{wxartprovider} wxArtProvider class is used to customize the look of wxWidgets application. -When wxWidgets need to display an icon or a bitmap (e.g. in the standard file -dialog), it does not use hard-coded resource but asks wxArtProvider for it -instead. This way the users can plug in own wxArtProvider class and easily -replace standard art with his/her own version. It is easy thing to do: all -that is needed is to derive a class from wxArtProvider, override it's +When wxWidgets needs to display an icon or a bitmap (e.g. in the standard file +dialog), it does not use a hard-coded resource but asks wxArtProvider for it +instead. This way users can plug in their own wxArtProvider class and easily +replace standard art with their own version. All +that is needed is to derive a class from wxArtProvider, override its \helpref{CreateBitmap}{wxartprovidercreatebitmap} method and register the provider with \helpref{wxArtProvider::PushProvider}{wxartproviderpushprovider}: @@ -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}