X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/571d2e0f232be3f7220c485c7e72eccfb87f2855..2b147f2e19c90ea74a4f96260ef8954a9bfbe2f1:/docs/latex/wx/artprov.tex diff --git a/docs/latex/wx/artprov.tex b/docs/latex/wx/artprov.tex index 8c2b6d4aaf..18c24acaeb 100644 --- a/docs/latex/wx/artprov.tex +++ b/docs/latex/wx/artprov.tex @@ -10,9 +10,10 @@ 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 +that is needed is to derive a class from wxArtProvider, override either its +\helpref{CreateBitmap}{wxartprovidercreatebitmap} and/or its +\helpref{CreateIconBundle}{wxartprovidercreateiconbundle} methods +and register the provider with \helpref{wxArtProvider::Push}{wxartproviderpush}: \begin{verbatim} @@ -22,12 +23,20 @@ provider with wxBitmap CreateBitmap(const wxArtID& id, const wxArtClient& client, const wxSize size) + + // optionally override this one as well + wxIconBundle CreateIconBundle(const wxArtID& id, + const wxArtClient& client) { ... } }; ... wxArtProvider::Push(new MyProvider); \end{verbatim} +If you need bitmap images (of the same artwork) that should be displayed at different sizes +you should probably consider overriding \helpref{CreateIconBundle()}{wxartprovidercreateiconbundle} +and supplying icon bundles that contain different bitmap sizes. + 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 \helpref{wxArtProvider::GetIcon}{wxartprovidergeticon} (NB: this is not yet really @@ -37,42 +46,61 @@ small). \membersection{Identifying art resources}\label{artprovideridentifying} -Every bitmap is known to wxArtProvider under an unique ID that is used by when +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 and can have one of these predefined values (you can see bitmaps represented by these constants in the \helpref{artprov}{sampleartprovider} sample): \begin{itemize}\itemsep=0pt -\item wxART\_ADD\_BOOKMARK -\item wxART\_DEL\_BOOKMARK -\item wxART\_HELP\_SIDE\_PANEL -\item wxART\_HELP\_SETTINGS -\item wxART\_HELP\_BOOK -\item wxART\_HELP\_FOLDER -\item wxART\_HELP\_PAGE -\item wxART\_GO\_BACK -\item wxART\_GO\_FORWARD -\item wxART\_GO\_UP -\item wxART\_GO\_DOWN -\item wxART\_GO\_TO\_PARENT -\item wxART\_GO\_HOME -\item wxART\_FILE\_OPEN -\item wxART\_PRINT -\item wxART\_HELP -\item wxART\_TIP -\item wxART\_REPORT\_VIEW -\item wxART\_LIST\_VIEW -\item wxART\_NEW\_DIR -\item wxART\_FOLDER -\item wxART\_GO\_DIR\_UP -\item wxART\_EXECUTABLE\_FILE -\item wxART\_NORMAL\_FILE -\item wxART\_TICK\_MARK -\item wxART\_CROSS\_MARK -\item wxART\_ERROR -\item wxART\_QUESTION -\item wxART\_WARNING -\item wxART\_INFORMATION -\item wxART\_MISSING\_IMAGE + +\item wxART\_ERROR +\item wxART\_QUESTION +\item wxART\_WARNING +\item wxART\_INFORMATION +\item wxART\_ADD\_BOOKMARK +\item wxART\_DEL\_BOOKMARK +\item wxART\_HELP\_SIDE\_PANEL +\item wxART\_HELP\_SETTINGS +\item wxART\_HELP\_BOOK +\item wxART\_HELP\_FOLDER +\item wxART\_HELP\_PAGE +\item wxART\_GO\_BACK +\item wxART\_GO\_FORWARD +\item wxART\_GO\_UP +\item wxART\_GO\_DOWN +\item wxART\_GO\_TO\_PARENT +\item wxART\_GO\_HOME +\item wxART\_PRINT +\item wxART\_HELP +\item wxART\_TIP +\item wxART\_REPORT\_VIEW +\item wxART\_LIST\_VIEW +\item wxART\_NEW\_DIR +\item wxART\_FOLDER +\item wxART\_FOLDER\_OPEN +\item wxART\_GO\_DIR\_UP +\item wxART\_EXECUTABLE\_FILE +\item wxART\_NORMAL\_FILE +\item wxART\_TICK\_MARK +\item wxART\_CROSS\_MARK +\item wxART\_MISSING\_IMAGE +\item wxART\_NEW +\item wxART\_FILE\_OPEN +\item wxART\_FILE\_SAVE +\item wxART\_FILE\_SAVE\_AS +\item wxART\_DELETE +\item wxART\_COPY +\item wxART\_CUT +\item wxART\_PASTE +\item wxART\_UNDO +\item wxART\_REDO +\item wxART\_QUIT +\item wxART\_FIND +\item wxART\_FIND\_AND\_REPLACE +\item wxART\_HARDDISK +\item wxART\_FLOPPY +\item wxART\_CDROM +\item wxART\_REMOVABLE + \end{itemize} Additionally, any string recognized by custom art providers registered using @@ -125,6 +153,10 @@ See the \helpref{artprov}{sampleartprovider} sample for an example of wxArtProvi +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} @@ -140,10 +172,10 @@ by \helpref{GetBitmap}{wxartprovidergetbitmap}. \func{wxBitmap}{CreateBitmap}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client}, \param{const wxSize\& }{size}} -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 necessary to optimize CreateBitmap for speed (e.g. you may create wxBitmap objects -from XPMs here). +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 necessary to optimize CreateBitmap() for speed (e.g. you may +create wxBitmap objects from XPMs here). \wxheading{Parameters} @@ -159,9 +191,23 @@ dimensions, it will be automatically rescaled to meet client's request.} This is {\bf not} part of wxArtProvider's public API, use \helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or +\helpref{wxArtProvider::GetIconBundle}{wxartprovidergeticonbundle} or \helpref{wxArtProvider::GetIcon}{wxartprovidergeticon} to query wxArtProvider for a resource. +\wxheading{See also} + +\helpref{CreateIconBundle}{wxartprovidercreateiconbundle} + + +\membersection{wxArtProvider::CreateIconBundle}\label{wxartprovidercreateiconbundle} + +\func{wxIconBundle}{CreateIconBundle}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client}} + +This method is similar to \helpref{CreateBitmap}{wxartprovidercreatebitmap} but +can be used when a bitmap (or an icon) exists in several sizes. + + \membersection{wxArtProvider::Delete}\label{wxartproviderdelete} @@ -189,6 +235,23 @@ Query registered providers for bitmap with given ID. The bitmap if one of registered providers recognizes the ID or wxNullBitmap otherwise. +\membersection{wxArtProvider::GetIconBundle}\label{wxartprovidergeticonbundle} + +\func{static wxIconBundle}{GetIconBundle}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}} + +Query registered providers for icon bundle with given ID. + +\wxheading{Parameters} + +\docparam{id}{wxArtID unique identifier of the icon bundle.} + +\docparam{client}{wxArtClient identifier of the client (i.e. who is asking for the icon bundle).} + +\wxheading{Return value} + +The icon bundle if one of registered providers recognizes the ID or wxNullIconBundle otherwise. + + \membersection{wxArtProvider::GetIcon}\label{wxartprovidergeticon} \func{static wxIcon}{GetIcon}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}}