albert::PluginInstance Class Reference

#include <plugininstance.h>

Inheritance diagram for albert::PluginInstance:

Detailed Description

Abstract plugin instance class.

The base class every plugin has to inherit.

Public Member Functions
	PluginInstance ()
QString	id () const
	The plugin identifier. More...
QString	name () const
	The human readable plugin name. More...
QString	description () const
	Brief description of the plugin. More...
QDir	cacheDir () const
	The recommended cache location. More...
QDir	configDir () const
	The recommended config location. More...
QDir	dataDir () const
	The recommended data location. More...
std::unique_ptr< QSettings >	settings () const
	Persistent plugin settings utilizing QSettings. More...
std::unique_ptr< QSettings >	state () const
	Persistent plugin state utilizing QSettings. More...
virtual void	initialize (ExtensionRegistry &registry, std::map< QString, PluginInstance * > dependencies)
	The initialization function. More...
virtual void	finalize (ExtensionRegistry &registry)
	The finalization function. More...
virtual QWidget *	buildConfigWidget ()
	Config widget factory. More...

Protected Member Functions
virtual	~PluginInstance ()

Constructor & Destructor Documentation

PluginInstance()

albert::PluginInstance::PluginInstance

(

)

~PluginInstance()

virtual albert::PluginInstance::~PluginInstance ( )

protectedvirtual

Member Function Documentation

buildConfigWidget()

virtual QWidget * albert::PluginInstance::buildConfigWidget ( )

virtual

Config widget factory.

cacheDir()

QDir albert::PluginInstance::cacheDir

(

)

const

The recommended cache location.

Created if necessary.

configDir()

QDir albert::PluginInstance::configDir

(

)

const

The recommended config location.

Created if necessary.

dataDir()

QDir albert::PluginInstance::dataDir

(

)

const

The recommended data location.

Created if necessary.

description()

QString albert::PluginInstance::description

(

)

const

Brief description of the plugin.

Taken from the metadata.

finalize()

virtual void albert::PluginInstance::finalize ( ExtensionRegistry &  registry )

virtual

The finalization function.

Parameters

registry

The extension registry.

Since

0.23

Reimplemented in albert::plugin::ExtensionPlugin.

id()

QString albert::PluginInstance::id

(

)

const

The plugin identifier.

Taken from the metadata.

initialize()

virtual void albert::PluginInstance::initialize ( ExtensionRegistry &  registry, std::map< QString, PluginInstance * >  dependencies  )

virtual

The initialization function.

Parameters

registry	The extension registry.
instances	The dependencies of the plugin.

Since

0.23

Reimplemented in albert::plugin::ExtensionPlugin.

name()

QString albert::PluginInstance::name

(

)

const

The human readable plugin name.

Taken from the metadata.

settings()

std::unique_ptr< QSettings > albert::PluginInstance::settings

(

)

const

Persistent plugin settings utilizing QSettings.

Configured to use a section titled <plugin-id>.

state()

std::unique_ptr< QSettings > albert::PluginInstance::state

(

)

const

Persistent plugin state utilizing QSettings.

Configured to use a section titled <plugin-id>.

Since

0.23

---

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

• albert/include/albert/extension/pluginprovider/plugininstance.h