]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/artprov.tex
Removed over-specific references to wxDDE..
[wxWidgets.git] / docs / latex / wx / artprov.tex
index 3937cd5ebc427f2a76751d1f5de9a99712738fc2..6e48e3b6e2fe6d543f8a31815d73bb291435463d 100644 (file)
@@ -5,8 +5,8 @@
 
 \section{\class{wxArtProvider}}\label{wxartprovider}
 
 
 \section{\class{wxArtProvider}}\label{wxartprovider}
 
-wxArtProvider class is used to customize the look of wxWindows application.
-When wxWindows need to display an icon or a bitmap (e.g. in the standard file
+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
 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
@@ -32,10 +32,10 @@ There's another way of taking advantage of this class: you can use it in your co
 platform native icons as provided by
 \helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or 
 \helpref{wxArtProvider::GetIcon}{wxartprovidergeticon} (NB: this is not yet really
 platform native icons as provided by
 \helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or 
 \helpref{wxArtProvider::GetIcon}{wxartprovidergeticon} (NB: this is not yet really
-possible as of wxWindows 2.3.3, the set of wxArtProvider bitmaps is too
+possible as of wxWidgets 2.3.3, the set of wxArtProvider bitmaps is too
 small). 
 
 small). 
 
-\membersection{Identifying art resources}
+\membersection{Identifying art resources}\label{artprovideridentifying}
 
 Every bitmap is known to wxArtProvider under an unique ID that is used by when
 requesting a resource from it. The ID is represented by wxArtID type and can
 
 Every bitmap is known to wxArtProvider under an unique ID that is used by when
 requesting a resource from it. The ID is represented by wxArtID type and can
@@ -72,9 +72,24 @@ constants in the \helpref{artprov}{sampleartprovider} sample):
 \item wxART\_QUESTION         
 \item wxART\_WARNING          
 \item wxART\_INFORMATION      
 \item wxART\_QUESTION         
 \item wxART\_WARNING          
 \item wxART\_INFORMATION      
+\item wxART\_MISSING\_IMAGE      
 \end{itemize}
 
 \end{itemize}
 
-\membersection{Clients}
+Additionally, any string recognized by custom art providers registered using
+\helpref{PushProvider}{wxartproviderpushprovider} may be used.
+
+\wxheading{GTK+ Note}
+
+When running under GTK+ 2, GTK+ stock item IDs (e.g. {\tt "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). Icon themes recognized
+by GTK+ follow the
+\urlref{freedesktop.org Icon Themes specification}{http://freedesktop.org/Standards/icon-theme-spec}. Note that themes are not guaranteed to contain all
+icons, so wxArtProvider may return {\tt wxNullBitmap} or {\tt wxNullIcon}.
+Default theme is typically installed in {\tt /usr/share/icons/hicolor}.
+
+\membersection{Clients}\label{artproviderclients}
 
 Client is the entity that calls wxArtProvider's GetBitmap or GetIcon
 function. It is represented by wxClientID type and can have one of these 
 
 Client is the entity that calls wxArtProvider's GetBitmap or GetIcon
 function. It is represented by wxClientID type and can have one of these 
@@ -82,6 +97,7 @@ values:
 \begin{itemize}\itemsep=0pt
 \item wxART\_TOOLBAR
 \item wxART\_MENU
 \begin{itemize}\itemsep=0pt
 \item wxART\_TOOLBAR
 \item wxART\_MENU
+\item wxART\_BUTTON
 \item wxART\_FRAME\_ICON
 \item wxART\_CMN\_DIALOG
 \item wxART\_HELP\_BROWSER
 \item wxART\_FRAME\_ICON
 \item wxART\_CMN\_DIALOG
 \item wxART\_HELP\_BROWSER
@@ -161,7 +177,7 @@ 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).
 
 Same as \helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap}, but
 return a wxIcon object (or wxNullIcon on failure).
 
-\membersection{wxArtProvider::PopProvider}\label{wxartproviderpopprovider}
+\membersection{wxArtProvider::PopProvider}\label{wxartproviderctor}
 
 \func{static bool}{PopProvider}{\void}
 
 
 \func{static bool}{PopProvider}{\void}