docs/latex/wx/artprov.tex

   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
  20 {\small \begin{verbatim}
  21 typedef wxString wxArtClient
  22 typedef wxString wxArtID
  23 \end{verbatim}}
  24
  25 \latexignore{\rtfignore{\wxheading{Members}}}
  26
  27 \membersection{wxArtProvider::CleanUpProviders}\label{wxartprovidercleanupproviders}
  28
  29 \func{void}{CleanUpProviders}{\void}
  30
  31 Destroy caches and all providers.
  32
  33 \membersection{wxArtProvider::CreateBitmap}\label{wxartprovidercreatebitmap}
  34
  35 \func{wxBitmap}{CreateBitmap}{\param{const wxArtID\& }{WXUNUSED(id)}, \param{const wxArtClient\& }{WXUNUSED(client)}, \param{const wxSize\& }{WXUNUSED(size)}}
  36
  37 Derived classes must override this method to create requested
  38 art resource. This method is called only once per instance's
  39 lifetime for each requested wxArtID.
  40
  41 \membersection{wxArtProvider::GetBitmap}\label{wxartprovidergetbitmap}
  42
  43 \func{wxBitmap}{GetBitmap}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}}
  44
  45 Query the providers for bitmap with given ID and return it. Return
  46 wxNullBitmap if no provider provides it.
  47
  48 \membersection{wxArtProvider::GetIcon}\label{wxartprovidergeticon}
  49
  50 \func{wxIcon}{GetIcon}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}}
  51
  52 Query the providers for icon with given ID and return it. Return
  53 wxNullIcon if no provider provides it.
  54
  55 \membersection{wxArtProvider::PopProvider}\label{wxartproviderpopprovider}
  56
  57 \func{bool}{PopProvider}{\void}
  58
  59 Remove latest added provider and delete it.
  60
  61 \membersection{wxArtProvider::PushProvider}\label{wxartproviderpushprovider}
  62
  63 \func{void}{PushProvider}{\param{wxArtProvider* }{provider}}
  64
  65 Add new provider to the top of providers stack.
  66
  67 \membersection{wxArtProvider::RemoveProvider}\label{wxartproviderremoveprovider}
  68
  69 \func{bool}{RemoveProvider}{\param{wxArtProvider* }{provider}}
  70
  71 Remove provider. The provider must have been added previously.
  72 The provider is {\it not} deleted.
  73