Proxy class for the communication with LeechCraft.
More...
#include "icoreproxy.h"
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.
virtual ICoreProxy::~ICoreProxy |
( |
| ) |
|
|
inlinevirtual |
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] | id | An ID previously obtained by GetID(). |
- See Also
- GetID()
Returns the color theme manager.
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] | on | The name of the icon in the "on" state. |
[in] | off | The 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.
Returns the application's plugin manager.
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".
Returns the shortcut proxy used to communicate with the shortcut manager.
- See Also
- IShortcutProxy
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] | action | The 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:
- /home/abuild/rpmbuild/BUILD/leechcraft-0.6.0/src/interfaces/core/icoreproxy.h