wxWidgets/docs/latex/wx/artprov.tex
George Tasker d1853d4765 Fixes for documentation compilation
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@15167 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2002-04-16 18:00:31 +00:00

76 lines
2.2 KiB
TeX

%
% automatically generated by HelpGen $Revision$ from
% artprov.h at 08/Apr/02 17:44:57
%
\section{\class{wxArtProvider}}\label{wxartprovider}
wxArtProvider class.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/artprov.h>
\wxheading{Data structures}
{\small
\begin{verbatim}
typedef wxString wxArtClient
typedef wxString wxArtID
\end{verbatim}
}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxArtProvider::CleanUpProviders}\label{wxartprovidercleanupproviders}
\func{void}{CleanUpProviders}{\void}
Destroy caches and all providers.
\membersection{wxArtProvider::CreateBitmap}\label{wxartprovidercreatebitmap}
\func{wxBitmap}{CreateBitmap}{\param{const wxArtID\& }{WXUNUSED(id)}, \param{const wxArtClient\& }{WXUNUSED(client)}, \param{const wxSize\& }{WXUNUSED(size)}}
Derived classes must override this method to create requested
art resource. This method is called only once per instance's
lifetime for each requested wxArtID.
\membersection{wxArtProvider::GetBitmap}\label{wxartprovidergetbitmap}
\func{wxBitmap}{GetBitmap}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}}
Query the providers for bitmap with given ID and return it. Return
wxNullBitmap if no provider provides it.
\membersection{wxArtProvider::GetIcon}\label{wxartprovidergeticon}
\func{wxIcon}{GetIcon}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}}
Query the providers for icon with given ID and return it. Return
wxNullIcon if no provider provides it.
\membersection{wxArtProvider::PopProvider}\label{wxartproviderpopprovider}
\func{bool}{PopProvider}{\void}
Remove latest added provider and delete it.
\membersection{wxArtProvider::PushProvider}\label{wxartproviderpushprovider}
\func{void}{PushProvider}{\param{wxArtProvider* }{provider}}
Add new provider to the top of providers stack.
\membersection{wxArtProvider::RemoveProvider}\label{wxartproviderremoveprovider}
\func{bool}{RemoveProvider}{\param{wxArtProvider* }{provider}}
Remove provider. The provider must have been added previously.
The provider is {\it not} deleted.