Albert
Loading...
Searching...
No Matches
albert::ExtensionPlugin Class Reference

#include <albert/extensionplugin.h>

Description

Extension plugin base class.

Implements pure virtual functions of Extension and PluginInstance.

Inheritance diagram for albert::ExtensionPlugin:
[legend]

Public Member Functions

QString id () const override
 Returns PluginMetadata::id.
 
QString name () const override
 Returns PluginMetadata::name.
 
QString description () const override
 Returns PluginMetadata::description.
 
std::vector< albert::Extension * > extensions () override
 Returns this extension.
 
- Public Member Functions inherited from albert::PluginInstance
virtual QWidget * buildConfigWidget ()
 Creates a widget that can be used to configure the plugin properties.
 
const PluginLoaderloader () const
 Returns the loader of this plugin.
 
std::filesystem::path cacheLocation () const
 Returns the writable cache location for this plugin.
 
std::filesystem::path configLocation () const
 Returns the writable config location for this plugin.
 
std::filesystem::path dataLocation () const
 Returns the writable data location for this plugin.
 
std::vector< std::filesystem::path > dataLocations () const
 Returns the existing data locations for this plugin.
 
std::unique_ptr< QSettings > settings () const
 Creates a preconfigured QSettings object for plugin config data.
 
std::unique_ptr< QSettings > state () const
 Creates a preconfigured QSettings object for plugin state data.
 
void readKeychain (const QString &key, std::function< void(const QString &value)> onSuccess, std::function< void(const QString &error)> 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 &error)> onError) const
 Sets the keychain value of key to value asynchronously.
 

Additional Inherited Members

- Protected Member Functions inherited from albert::PluginInstance
 PluginInstance ()
 Constructs a plugin instance.
 
virtual ~PluginInstance ()
 Destructs the plugin instance.
 
- Protected Member Functions inherited from albert::Extension
virtual ~Extension ()
 Destructs the extension.
 

Member Function Documentation

◆ description()

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

◆ extensions()

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

Returns this extension.

Reimplemented from albert::PluginInstance.

◆ id()

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

Returns PluginMetadata::id.

Implements albert::Extension.

◆ name()

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

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