that is needed is to derive a class from wxArtProvider, override its
\helpref{CreateBitmap}{wxartprovidercreatebitmap} method and register the
provider with
-\helpref{wxArtProvider::PushProvider}{wxartproviderpushprovider}:
+\helpref{wxArtProvider::Push}{wxartproviderpush}:
\begin{verbatim}
class MyProvider : public wxArtProvider
{ ... }
};
...
- wxArtProvider::PushProvider(new MyProvider);
+ wxArtProvider::Push(new MyProvider);
\end{verbatim}
There's another way of taking advantage of this class: you can use it in your code and use
possible as of wxWidgets 2.3.3, the set of wxArtProvider bitmaps is too
small).
+
\membersection{Identifying art resources}\label{artprovideridentifying}
Every bitmap is known to wxArtProvider under an unique ID that is used by when
\item wxART\_MISSING\_IMAGE
\end{itemize}
-Additionally, any string recognized by custom art providers registered using
-\helpref{PushProvider}{wxartproviderpushprovider} may be used.
+Additionally, any string recognized by custom art providers registered using
+\helpref{Push}{wxartproviderpush} may be used.
\wxheading{GTK+ Note}
icons, so wxArtProvider may return {\tt wxNullBitmap} or {\tt wxNullIcon}.
Default theme is typically installed in {\tt /usr/share/icons/hicolor}.
+
\membersection{Clients}\label{artproviderclients}
Client is the entity that calls wxArtProvider's GetBitmap or GetIcon
\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxArtProvider::\destruct{wxArtProvider}}\label{wxartproviderdtor}
+
+\func{}{\destruct{wxArtProvider}}{\void}
+
+The destructor automatically removes the provider from the provider stack used
+by \helpref{GetBitmap}{wxartprovidergetbitmap}.
+
+
\membersection{wxArtProvider::CreateBitmap}\label{wxartprovidercreatebitmap}
\func{wxBitmap}{CreateBitmap}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client}, \param{const wxSize\& }{size}}
\helpref{wxArtProvider::GetIcon}{wxartprovidergeticon}
to query wxArtProvider for a resource.
+
+\membersection{wxArtProvider::Delete}\label{wxartproviderdelete}
+
+\func{static bool}{Delete}{\param{wxArtProvider* }{provider}}
+
+Delete the given \arg{provider}.
+
+
\membersection{wxArtProvider::GetBitmap}\label{wxartprovidergetbitmap}
\func{static wxBitmap}{GetBitmap}{\param{const wxArtID\& }{id}, \param{const wxArtClient\& }{client = wxART\_OTHER}, \param{const wxSize\& }{size = wxDefaultSize}}
The bitmap if one of registered providers recognizes the ID or wxNullBitmap 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}}
otherwise return the size from the topmost wxArtProvider. {\it wxDefaultSize} may be
returned if the client doesn't have a specified size, like wxART\_OTHER for example.
-\membersection{wxArtProvider::InsertProvider}\label{wxartproviderinsertprovider}
-\func{static void}{InsertProvider}{\param{wxArtProvider* }{provider}}
+\membersection{wxArtProvider::Insert}\label{wxartproviderinsert}
+
+\func{static void}{Insert}{\param{wxArtProvider* }{provider}}
Register new art provider and add it to the bottom of providers stack (i.e.
it will be queried as the last one).
\wxheading{See also}
-\helpref{PushProvider}{wxartproviderpushprovider}
+\helpref{Push}{wxartproviderpush}
+
-\membersection{wxArtProvider::PopProvider}\label{wxartproviderctor}
+\membersection{wxArtProvider::Pop}\label{wxartproviderctor}
-\func{static bool}{PopProvider}{\void}
+\func{static bool}{Pop}{\void}
Remove latest added provider and delete it.
-\membersection{wxArtProvider::PushProvider}\label{wxartproviderpushprovider}
-\func{static void}{PushProvider}{\param{wxArtProvider* }{provider}}
+\membersection{wxArtProvider::Push}\label{wxartproviderpush}
+
+\func{static void}{Push}{\param{wxArtProvider* }{provider}}
Register new art provider and add it to the top of providers stack (i.e. it
will be queried as the first provider).
\wxheading{See also}
-\helpref{InsertProvider}{wxartproviderinsertprovider}
+\helpref{Insert}{wxartproviderinsert}
+
-\membersection{wxArtProvider::RemoveProvider}\label{wxartproviderremoveprovider}
+\membersection{wxArtProvider::Remove}\label{wxartproviderremove}
-\func{static bool}{RemoveProvider}{\param{wxArtProvider* }{provider}}
+\func{static bool}{Remove}{\param{wxArtProvider* }{provider}}
-Remove a provider from the stack. The provider must have been added previously
-and is {\it not} deleted.
+Remove a provider from the stack if it is on it. The provider is {\emph not}
+deleted, unlike when using \helpref{Delete()}{wxartproviderdelete}.
class WXDLLEXPORT wxArtProvider : public wxObject
{
public:
+ // Dtor removes the provider from providers stack if it's still on it
+ virtual ~wxArtProvider();
+
+
// Add new provider to the top of providers stack (i.e. the provider will
- // be querier first of all).
- static void PushProvider(wxArtProvider *provider);
+ // be queried first of all).
+ static void Push(wxArtProvider *provider);
// Add new provider to the bottom of providers stack (i.e. the provider
// will be queried as the last one).
- static void InsertProvider(wxArtProvider *provider);
+ static void Insert(wxArtProvider *provider);
// Remove latest added provider and delete it.
- static bool PopProvider();
+ static bool Pop();
+
+ // Remove provider from providers stack but don't delete it.
+ static bool Remove(wxArtProvider *provider);
+
+ // Delete the given provider and remove it from the providers stack.
+ static bool Delete(wxArtProvider *provider);
- // Remove provider. The provider must have been added previously!
- // The provider is _not_ deleted.
- static bool RemoveProvider(wxArtProvider *provider);
// Query the providers for bitmap with given ID and return it. Return
// wxNullBitmap if no provider provides it.
// the topmost provider if platform_dependent = false
static wxSize GetSizeHint(const wxArtClient& client, bool platform_dependent = false);
+#if WXWIN_COMPATIBILITY_2_6
+ // use the corresponding methods without redundant "Provider" suffix
+ wxDEPRECATED( static void PushProvider(wxArtProvider *provider) );
+ wxDEPRECATED( static void InsertProvider(wxArtProvider *provider) );
+ wxDEPRECATED( static bool PopProvider() );
+
+ // use Delete() if this is what you really need, or just delete the
+ // provider pointer, do not use Remove() as it does not delete the pointer
+ // unlike RemoveProvider() which does
+ wxDEPRECATED( static bool RemoveProvider(wxArtProvider *provider) );
+#endif // WXWIN_COMPATIBILITY_2_6
+
protected:
friend class wxArtProviderModule;
// Initializes default provider
void MyFrame::OnPlugProvider(wxCommandEvent& event)
{
if ( event.IsChecked() )
- wxArtProvider::PushProvider(new MyArtProvider);
+ wxArtProvider::Push(new MyArtProvider);
else
- wxArtProvider::PopProvider();
+ wxArtProvider::Pop();
}
}
-// ----------------------------------------------------------------------------
+// ============================================================================
// wxArtProvider class
-// ----------------------------------------------------------------------------
+// ============================================================================
IMPLEMENT_ABSTRACT_CLASS(wxArtProvider, wxObject)
wxArtProvidersList *wxArtProvider::sm_providers = NULL;
wxArtProviderCache *wxArtProvider::sm_cache = NULL;
+// ----------------------------------------------------------------------------
+// wxArtProvider ctors/dtor
+// ----------------------------------------------------------------------------
+
+wxArtProvider::~wxArtProvider()
+{
+ Remove(this);
+}
+
+// ----------------------------------------------------------------------------
+// wxArtProvider operations on provider stack
+// ----------------------------------------------------------------------------
+
/*static*/ void wxArtProvider::CommonAddingProvider()
{
if ( !sm_providers )
sm_cache->Clear();
}
-/*static*/ void wxArtProvider::PushProvider(wxArtProvider *provider)
+/*static*/ void wxArtProvider::Push(wxArtProvider *provider)
{
CommonAddingProvider();
sm_providers->Insert(provider);
}
-/*static*/ void wxArtProvider::InsertProvider(wxArtProvider *provider)
+/*static*/ void wxArtProvider::Insert(wxArtProvider *provider)
{
CommonAddingProvider();
sm_providers->Append(provider);
}
-/*static*/ bool wxArtProvider::PopProvider()
+/*static*/ bool wxArtProvider::Pop()
{
wxCHECK_MSG( sm_providers, false, _T("no wxArtProvider exists") );
- wxCHECK_MSG( sm_providers->GetCount() > 0, false, _T("wxArtProviders stack is empty") );
+ wxCHECK_MSG( !sm_providers->empty(), false, _T("wxArtProviders stack is empty") );
delete sm_providers->GetFirst()->GetData();
- sm_providers->Erase(sm_providers->GetFirst());
sm_cache->Clear();
return true;
}
-/*static*/ bool wxArtProvider::RemoveProvider(wxArtProvider *provider)
+/*static*/ bool wxArtProvider::Remove(wxArtProvider *provider)
{
wxCHECK_MSG( sm_providers, false, _T("no wxArtProvider exists") );
if ( sm_providers->DeleteObject(provider) )
{
- delete provider;
sm_cache->Clear();
return true;
}
return false;
}
+/*static*/ bool wxArtProvider::Delete(wxArtProvider *provider)
+{
+ // provider will remove itself from the stack in its dtor
+ delete provider;
+
+ return true;
+}
+
/*static*/ void wxArtProvider::CleanUpProviders()
{
- WX_CLEAR_LIST(wxArtProvidersList, *sm_providers);
- wxDELETE(sm_providers);
- wxDELETE(sm_cache);
+ if ( sm_providers )
+ {
+ while ( !sm_providers->empty() )
+ delete *sm_providers->begin();
+
+ delete sm_providers;
+ sm_providers = NULL;
+
+ delete sm_cache;
+ sm_cache = NULL;
+ }
}
+// ----------------------------------------------------------------------------
+// wxArtProvider: retrieving bitmaps/icons
+// ----------------------------------------------------------------------------
+
/*static*/ wxBitmap wxArtProvider::GetBitmap(const wxArtID& id,
const wxArtClient& client,
const wxSize& size)
#endif // GTK+ 2/else
}
+// ----------------------------------------------------------------------------
+// deprecated wxArtProvider methods
+// ----------------------------------------------------------------------------
+
+#if WXWIN_COMPATIBILITY_2_6
+
+/* static */ void wxArtProvider::PushProvider(wxArtProvider *provider)
+{
+ Push(provider);
+}
+
+/* static */ void wxArtProvider::InsertProvider(wxArtProvider *provider)
+{
+ Insert(provider);
+}
+
+/* static */ bool wxArtProvider::PopProvider()
+{
+ return Pop();
+}
+
+/* static */ bool wxArtProvider::RemoveProvider(wxArtProvider *provider)
+{
+ // RemoveProvider() used to delete the provider being removed so this is
+ // not a typo, we must call Delete() and not Remove() here
+ return Delete(provider);
+}
+
+#endif // WXWIN_COMPATIBILITY_2_6
+
+// ============================================================================
+// wxArtProviderModule
+// ============================================================================
class wxArtProviderModule: public wxModule
{
/*static*/ void wxArtProvider::InitStdProvider()
{
- wxArtProvider::PushProvider(new wxDefaultArtProvider);
+ wxArtProvider::Push(new wxDefaultArtProvider);
}
#if !defined(__WXGTK20__) || defined(__WXUNIVERSAL__)
/*static*/ void wxArtProvider::InitNativeProvider()
{
- wxArtProvider::PushProvider(new wxGTK2ArtProvider);
+ wxArtProvider::Push(new wxGTK2ArtProvider);
}
// ----------------------------------------------------------------------------
// has one
wxArtProvider *art = ms_theme->GetArtProvider();
if ( art )
- wxArtProvider::PushProvider(art);
+ wxArtProvider::Push(art);
}
return themeOld;
{
delete m_renderer;
delete m_scheme;
- wxArtProvider::RemoveProvider(m_artProvider);
+ delete m_artProvider;
}
wxRenderer *wxGTKTheme::GetRenderer()
{
delete m_renderer;
delete m_scheme;
- wxArtProvider::RemoveProvider(m_artProvider);
+ delete m_artProvider;
}
wxRenderer *wxMonoTheme::GetRenderer()
{
delete m_renderer;
delete m_scheme;
- wxArtProvider::RemoveProvider(m_artProvider);
+ delete m_artProvider;
}
wxRenderer *wxWin32Theme::GetRenderer()
projects / wxWidgets.git / commitdiff
