X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/878770b8544c70c21311d95a6bdccc839a101688..a8bda512079352ba81933e278d9ccdb8ef7a9866:/interface/wx/artprov.h diff --git a/interface/wx/artprov.h b/interface/wx/artprov.h index 182fce28e3..0fa1b70397 100644 --- a/interface/wx/artprov.h +++ b/interface/wx/artprov.h @@ -3,18 +3,18 @@ // Purpose: interface of wxArtProvider // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** This type identifies the client of the art objects requested to wxArtProvider. */ -typedef wxString wxArtClient; +typedef class wxString wxArtClient; /** This type identifies a specific art object which can be requested to wxArtProvider. */ -typedef wxString wxArtID; +typedef class wxString wxArtID; /** @@ -59,7 +59,7 @@ typedef wxString wxArtID; @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): @@ -79,10 +79,12 @@ typedef wxString wxArtID; @li wxART_GO_BACK @li wxART_GO_FORWARD @li wxART_GO_UP - @li wxART_GO_DOWN @li wxART_GO_TO_PARENT @li wxART_GO_HOME + @li wxART_GOTO_FIRST (since 2.9.2) + + @li wxART_GOTO_LAST (since 2.9.2) @li wxART_PRINT @li wxART_HELP @li wxART_TIP @@ -96,11 +98,11 @@ typedef wxString wxArtID; @li wxART_NORMAL_FILE @li wxART_TICK_MARK @li wxART_CROSS_MARK - @li wxART_MISSING_IMAGE @li wxART_NEW @li wxART_FILE_OPEN @li wxART_FILE_SAVE + @li wxART_FILE_SAVE_AS @li wxART_DELETE @li wxART_COPY @@ -108,6 +110,9 @@ typedef wxString wxArtID; @li wxART_PASTE @li wxART_UNDO @li wxART_REDO + @li wxART_PLUS (since 2.9.2) + @li wxART_MINUS (since 2.9.2) + @li wxART_CLOSE @li wxART_QUIT @li wxART_FIND @li wxART_FIND_AND_REPLACE @@ -125,15 +130,17 @@ typedef wxString wxArtID; When running under GTK+ 2, GTK+ stock item IDs (e.g. @c "gtk-cdrom") may be used as well: @code - #ifdef __WXGTK__ + #ifdef __WXGTK__ wxBitmap bmp = wxArtProvider::GetBitmap("gtk-cdrom", wxART_MENU); - #endif + #endif @endcode - 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 freedesktop.org Icon Themes specification - (see http://freedesktop.org/Standards/icon-theme-spec). + For a list of the GTK+ stock items please refer to the + GTK+ documentation + page. + 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. Note that themes are not guaranteed to contain all icons, so wxArtProvider may return ::wxNullBitmap or ::wxNullIcon. The default theme is typically installed in @c /usr/share/icons/hicolor. @@ -162,7 +169,7 @@ typedef wxString wxArtID; 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. */