projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| f4fcc291 JS |
1 | % |
| 2 | % automatically generated by HelpGen $Revision$ from | |
| 3 | % artprov.h at 08/Apr/02 17:44:57 | |
| 4 | % | |
| 5 | ||
| 6 | \section{\class{wxArtProvider}}\label{wxartprovider} | |
| 7 | ||
| 8 | wxArtProvider class. | |
| 9 | ||
| 10 | \wxheading{Derived from} | |
| 11 | ||
| 12 | \helpref{wxObject}{wxobject} | |
| 13 | ||
| 14 | \wxheading{Include files} | |
| 15 | ||
| 16 | <wx/artprov.h> | |
| 17 | ||
| 18 | \wxheading{Data structures} | |
| 19 | ||
| d1853d47 GT |
20 | {\small |
| 21 | \begin{verbatim} | |
| f4fcc291 JS |
22 | typedef wxString wxArtClient |
| 23 | typedef wxString wxArtID | |
| d1853d47 GT |
24 | \end{verbatim} |
| 25 | } | |
| f4fcc291 JS |
26 | |
| 27 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 28 | ||
| 29 | \membersection{wxArtProvider::CleanUpProviders}\label{wxartprovidercleanupproviders} | |
| 30 | ||
| 31 | \func{void}{CleanUpProviders}{\void} | |
| 32 | ||
| 33 | Destroy caches and all providers. | |
| 34 | ||
| 35 | \membersection{wxArtProvider::CreateBitmap}\label{wxartprovidercreatebitmap} | |
| 36 | ||
| 37 | \func{wxBitmap}{CreateBitmap}{\param{const wxArtID\& }{WXUNUSED(id)}, \param{const wxArtClient\& }{WXUNUSED(client)}, \param{const wxSize\& }{WXUNUSED(size)}} | |
| 38 | ||
| 39 | Derived classes must override this method to create requested | |
| 40 | art resource. This method is called only once per instance's | |
| 41 | lifetime for each requested wxArtID. | |
| 42 | ||
| 43 | \membersection{wxArtProvider::GetBitmap}\label{wxartprovidergetbitmap} | |
| 44 | ||
| 45 | \func{wxBitmap}{GetBitmap}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}} | |
| 46 | ||
| 47 | Query the providers for bitmap with given ID and return it. Return | |
| 48 | wxNullBitmap if no provider provides it. | |
| 49 | ||
| 50 | \membersection{wxArtProvider::GetIcon}\label{wxartprovidergeticon} | |
| 51 | ||
| 52 | \func{wxIcon}{GetIcon}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}} | |
| 53 | ||
| 54 | Query the providers for icon with given ID and return it. Return | |
| 55 | wxNullIcon if no provider provides it. | |
| 56 | ||
| 57 | \membersection{wxArtProvider::PopProvider}\label{wxartproviderpopprovider} | |
| 58 | ||
| 59 | \func{bool}{PopProvider}{\void} | |
| 60 | ||
| 61 | Remove latest added provider and delete it. | |
| 62 | ||
| 63 | \membersection{wxArtProvider::PushProvider}\label{wxartproviderpushprovider} | |
| 64 | ||
| 65 | \func{void}{PushProvider}{\param{wxArtProvider* }{provider}} | |
| 66 | ||
| 67 | Add new provider to the top of providers stack. | |
| 68 | ||
| 69 | \membersection{wxArtProvider::RemoveProvider}\label{wxartproviderremoveprovider} | |
| 70 | ||
| 71 | \func{bool}{RemoveProvider}{\param{wxArtProvider* }{provider}} | |
| 72 | ||
| 73 | Remove provider. The provider must have been added previously. | |
| 74 | The provider is {\it not} deleted. | |
| 75 |