albert::util::ExtensionPlugin Class Reference

#include <albert/extensionplugin.h>

Inheritance diagram for albert::util::ExtensionPlugin:

Detailed Description

Convenience base class for extension plugins.

Implements pure virtual functions of Extension and PluginInstance.

Public Member Functions
QString	id () const override
	Overrides Extension::id()
QString	name () const override
	Overrides Extension::name()
QString	description () const override
	Overrides Extension::description()
std::vector< albert::Extension * >	extensions () override
	Overrides PluginInstance::extensions()
Public Member Functions inherited from albert::PluginInstance
virtual QWidget *	buildConfigWidget ()
	The widget used to configure the plugin in the settings.
const PluginLoader &	loader () const
	The PluginLoader of this instance.
std::filesystem::path	cacheLocation () const
	The recommended cache location.
std::filesystem::path	configLocation () const
	The recommended config location.
std::filesystem::path	dataLocation () const
	The recommended data location.
std::vector< std::filesystem::path >	dataLocations () const
	The existing data locations of this plugin.
std::unique_ptr< QSettings >	settings () const
	Persistent plugin settings.
std::unique_ptr< QSettings >	state () const
	Persistent plugin state.
void	readKeychain (const QString &key, std::function< void(const QString &)> onSuccess, std::function< void(const QString &)> onError) const
	Reads the keychain value for key asynchronously.
void	writeKeychain (const QString &key, const QString &value, std::function< void()> onSuccess, std::function< void(const QString &)> onError) const
	Sets the keychain value of key to value asynchronously.

Additional Inherited Members
Protected Member Functions inherited from albert::PluginInstance
	PluginInstance ()
virtual	~PluginInstance ()
Protected Member Functions inherited from albert::Extension
virtual	~Extension ()

Member Function Documentation

description()

QString albert::util::ExtensionPlugin::description ( ) const

overridevirtual

Overrides Extension::description()

Returns

Plugin description

Implements albert::Extension.

extensions()

std::vector< albert::Extension * > albert::util::ExtensionPlugin::extensions ( )

overridevirtual

Overrides PluginInstance::extensions()

Returns

this

Reimplemented from albert::PluginInstance.

id()

QString albert::util::ExtensionPlugin::id ( ) const

overridevirtual

Overrides Extension::id()

Returns

Plugin id

Implements albert::Extension.

name()

QString albert::util::ExtensionPlugin::name ( ) const

overridevirtual

Overrides Extension::name()

Returns

Plugin name

Implements albert::Extension.

---

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

• workspace/albert/include/albert/extensionplugin.h