removed wx_dynamic_cast(), it can't be implemented properly without real dynamic_cast<>

[wxWidgets.git] / docs / latex / wx / artprov.tex

diff --git a/docs/latex/wx/artprov.tex b/docs/latex/wx/artprov.tex
index 6e48e3b6e2fe6d543f8a31815d73bb291435463d..d0b0fde2b694ed8a4b40186d0cb482e6b893c104 100644 (file)
--- 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). 
@@ -132,7 +131,7 @@ See the \helpref{artprov}{sampleartprovider} sample for an example of wxArtProvi
 
 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 neccessary to optimize CreateBitmap for speed (e.g. you may create wxBitmap objects
+not necessary to optimize CreateBitmap for speed (e.g. you may create wxBitmap objects
 from XPMs here).
 
 \wxheading{Parameters}
@@ -142,7 +141,7 @@ from XPMs here).
 \docparam{client}{wxArtClient identifier of the client (i.e. who is asking for the bitmap).
 This only servers as a hint.}
 
-\docparam{size}{Prefered size of the bitmap. The function may return a bitmap of different
+\docparam{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.}
 
 \wxheading{Note}
@@ -177,6 +176,12 @@ 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}{GetSize}{\param{const wxArtClient\& }{client}, \param{bool }{platform_default = false}}
+
+Returns the default size for the given art {\it client} by either using the topmost 
+wxArtProvider or if {\it platform_default} is \true then return a suitable default size for 
+{\it client} depending on the current platform.
+
 \membersection{wxArtProvider::PopProvider}\label{wxartproviderctor}
 
 \func{static bool}{PopProvider}{\void}