ICoreProxy Class Reference

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 IShortcutProxy *	GetShortcutProxy () const =0
	Returns the shortcut proxy used to communicate with the shortcut manager. More...
virtual QModelIndex	MapToSource (const QModelIndex &index) const =0
	Maps the given index to the plugin's model. More...
virtual LC::Util::BaseSettingsManager *	GetSettingsManager () const =0
	Returns the LeechCraft's settings manager. More...
virtual IIconThemeManager *	GetIconThemeManager () const =0
	Returns the icon theme manager. More...
virtual IColorThemeManager *	GetColorThemeManager () const =0
	Returns the color theme manager. More...
virtual IRootWindowsManager *	GetRootWindowsManager () const =0
	Returns the root windows manager. More...
virtual ITagsManager *	GetTagsManager () const =0
	Returns the application-wide tags manager. More...
virtual QStringList	GetSearchCategories () const =0
virtual IPluginsManager *	GetPluginsManager () const =0
	Returns the application's plugin manager. More...
virtual IEntityManager *	GetEntityManager () const =0
	Returns the entity manager object. More...
virtual QString	GetVersion () const =0
	Returns the version of LeechCraft core and base system. More...
virtual void	RegisterSkinnable (QAction *action)=0
	Registers the given action as having skinnable icons. More...
virtual bool	IsShuttingDown ()=0
	Checks if LeechCraft is currently shutting down. More...

Detailed Description

Proxy class for the communication with LeechCraft.

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

Definition at line 46 of file icoreproxy.h.

Constructor & Destructor Documentation

~ICoreProxy()

virtual ICoreProxy::~ICoreProxy ( )

inlinevirtual

Definition at line 49 of file icoreproxy.h.

Member Function Documentation

GetColorThemeManager()

virtual IColorThemeManager* ICoreProxy::GetColorThemeManager ( ) const

pure virtual

Returns the color theme manager.

Returns

The color manager.

See also

IColorThemeManager

GetEntityManager()

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.

Returns

The application-wide entity manager.

See also

LC::Entity

IEntityManager

GetIconThemeManager()

virtual IIconThemeManager* ICoreProxy::GetIconThemeManager ( ) const

pure virtual

Returns the icon theme manager.

Returns

The icon manager.

See also

IIconThemeManager

GetNetworkAccessManager()

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

The application-wide QNetworkAccessManager.

GetPluginsManager()

virtual IPluginsManager* ICoreProxy::GetPluginsManager ( ) const

pure virtual

Returns the application's plugin manager.

Returns

The application plugins manager.

See also

IPluginsManager

GetRootWindowsManager()

virtual IRootWindowsManager* ICoreProxy::GetRootWindowsManager ( ) const

pure virtual

Returns the root windows manager.

Returns

The root windows manager.

See also

IRootWindowsManager

GetSearchCategories()

virtual QStringList ICoreProxy::GetSearchCategories ( ) const

pure virtual

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

This function merely aggregates all the search categories from all the plugins implementing the IFinder interface, calling IFinder::GetCategories().

Returns

The search categories of all finder.

See also

IFinder

GetSettingsManager()

virtual LC::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 Core settings manager.

GetShortcutProxy()

virtual IShortcutProxy* ICoreProxy::GetShortcutProxy ( ) const

pure virtual

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

Returns

The application-wide shortcut proxy.

See also

IShortcutProxy

GetTagsManager()

virtual ITagsManager* ICoreProxy::GetTagsManager ( ) const

pure virtual

Returns the application-wide tags manager.

Returns

The application-wide tags manager.

See also

ITagsManager

GetVersion()

virtual QString ICoreProxy::GetVersion ( ) const

pure virtual

Returns the version of LeechCraft core and base system.

The returned strings reflects the runtime version of the Core.

Returns

The version of the LeechCraft Core.

IsShuttingDown()

virtual bool ICoreProxy::IsShuttingDown ( )

pure virtual

Checks if LeechCraft is currently shutting down.

This function returns whether shutdown sequence has been initiated.

For example, in this case user interaction is discouraged.

Returns

Whether LeechCraft is shutting down.

MapToSource()

virtual QModelIndex ICoreProxy::MapToSource ( const QModelIndex &  index ) const

pure virtual

Maps the given index to the plugin's model.

RegisterSkinnable()

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.

---

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

• /home/d34df00d/leechcraft/src/interfaces/core/icoreproxy.h