LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
ICoreProxy Class Referenceabstract

Proxy class for the communication with LeechCraft. More...

#include "icoreproxy.h"

Public Member Functions

virtual ~ICoreProxy ()
 
virtual QNetworkAccessManager * GetNetworkAccessManager () const =0
 Returns application-wide network access manager. More...
 
virtual IShortcutProxyGetShortcutProxy () const =0
 Returns the shortcut proxy used to communicate with the shortcut manager. More...
 
virtual QModelIndex MapToSource (const QModelIndex &) const =0
 Maps the given index up to the plugin's through the hierarchy of LeechCraft's models. More...
 
virtual
LeechCraft::Util::BaseSettingsManager * 
GetSettingsManager () const =0
 Returns the LeechCraft's settings manager. More...
 
virtual QIcon GetIcon (const QString &on, const QString &off=QString()) const =0
 
virtual void UpdateIconset (const QList< QAction * > &actions) const =0
 Updates the icons of the given actions according to current iconset. More...
 
virtual IColorThemeManagerGetColorThemeManager () const =0
 Returns the color theme manager. More...
 
virtual IRootWindowsManagerGetRootWindowsManager () const =0
 
virtual ITagsManagerGetTagsManager () const =0
 
virtual QStringList GetSearchCategories () const =0
 
virtual int GetID ()=0
 Returns an ID for a delegated task from the pool. More...
 
virtual void FreeID (int id)=0
 Marks an ID previously returned by GetID as unused. More...
 
virtual IPluginsManagerGetPluginsManager () const =0
 Returns the application's plugin manager. More...
 
virtual IEntityManagerGetEntityManager () const =0
 Returns the entity manager object. More...
 
virtual QString GetVersion () const =0
 Returns the version of LeechCraft core and base system. More...
 
virtual QObject * GetSelf ()=0
 Returns the pointer to itself as QObject*. More...
 
virtual void RegisterSkinnable (QAction *action)=0
 Registers the given action as having skinnable icons. More...
 
virtual bool IsShuttingDown ()=0
 

Detailed Description

Proxy class for the communication with LeechCraft.

Allows one to talk with LeechCraft, requesting and getting various services.

Definition at line 65 of file icoreproxy.h.

Constructor & Destructor Documentation

virtual ICoreProxy::~ICoreProxy ( )
inlinevirtual

Definition at line 68 of file icoreproxy.h.

Member Function Documentation

virtual void ICoreProxy::FreeID ( int  id)
pure virtual

Marks an ID previously returned by GetID as unused.

Returns the id to the global ID pool. Use this in your downloader plugins after your download finishes.

Parameters
[in]idAn ID previously obtained by GetID().
See Also
GetID()
virtual IColorThemeManager* ICoreProxy::GetColorThemeManager ( ) const
pure virtual

Returns the color theme manager.

virtual IEntityManager* ICoreProxy::GetEntityManager ( ) const
pure virtual

Returns the entity manager object.

Entity manager is used to perform interoperation with other plugins by exchanging entity objects with them.

See Also
LeechCraft::Entity
virtual QIcon ICoreProxy::GetIcon ( const QString &  on,
const QString &  off = QString() 
) const
pure virtual

Returns the current theme's icon for the given on and off states. Similar to the mapping files.

Parameters
[in]onThe name of the icon in the "on" state.
[in]offThe name of the icon in the "off" state, if any.
Returns
The QIcon object created from image files which could be obtained via GetIconPath().
See Also
GetIconPath
virtual int ICoreProxy::GetID ( )
pure virtual

Returns an ID for a delegated task from the pool.

Use this in your downloader plugin when generating an ID for a newly added task. This way you can avoid ID clashes with other downloaders.

Returns
The ID of the task.
See Also
FreeID()
virtual QNetworkAccessManager* ICoreProxy::GetNetworkAccessManager ( ) const
pure virtual

Returns application-wide network access manager.

If your plugin wants to work well with other internet-related ones and wants to integrate with application-wide cookie database and network cache, it should use the returned QNetworkAccessManager.

Returns
Application-wide QNetworkAccessManager.
virtual IPluginsManager* ICoreProxy::GetPluginsManager ( ) const
pure virtual

Returns the application's plugin manager.

virtual IRootWindowsManager* ICoreProxy::GetRootWindowsManager ( ) const
pure virtual
virtual QStringList ICoreProxy::GetSearchCategories ( ) const
pure virtual

Returns the list of all possible search categories from the finders installed.

virtual QObject* ICoreProxy::GetSelf ( )
pure virtual

Returns the pointer to itself as QObject*.

Just to avoid nasty reinterpret_casts.

virtual LeechCraft::Util::BaseSettingsManager* ICoreProxy::GetSettingsManager ( ) const
pure virtual

Returns the LeechCraft's settings manager.

In the returned settings manager you can use any property name you want if it starts from "PluginsStorage". To avoid name collisions from different plugins it's strongly encouraged to also use the plugin name in the property. So the property name would look like "PluginsStorage/PluginName/YourProperty".

virtual IShortcutProxy* ICoreProxy::GetShortcutProxy ( ) const
pure virtual

Returns the shortcut proxy used to communicate with the shortcut manager.

See Also
IShortcutProxy
virtual ITagsManager* ICoreProxy::GetTagsManager ( ) const
pure virtual

Returns the application-wide tags manager.

virtual QString ICoreProxy::GetVersion ( ) const
pure virtual

Returns the version of LeechCraft core and base system.

virtual bool ICoreProxy::IsShuttingDown ( )
pure virtual
virtual QModelIndex ICoreProxy::MapToSource ( const QModelIndex &  ) const
pure virtual

Maps the given index up to the plugin's through the hierarchy of LeechCraft's models.

virtual void ICoreProxy::RegisterSkinnable ( QAction *  action)
pure virtual

Registers the given action as having skinnable icons.

Registers the given action so that it automatically gets its icon updated whenever the current iconset changes.

Parameters
[in]actionThe action to register.
virtual void ICoreProxy::UpdateIconset ( const QList< QAction * > &  actions) const
pure virtual

Updates the icons of the given actions according to current iconset.


The documentation for this class was generated from the following file: