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

#include <albert/extensionplugin.h>

Inheritance diagram for albert::ExtensionPlugin:
albert::PluginInstance albert::Extension

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()
 
- Public Member Functions inherited from albert::PluginInstance
const PluginLoaderloader () const
 The PluginLoader of this instance.
 
albert::ExtensionRegistryregistry ()
 The associated ExtensionRegistry.
 
virtual QWidget * buildConfigWidget ()
 The widget used to configure the plugin in the settings.
 
QString cacheLocation () const
 The recommended cache location.
 
QString configLocation () const
 The recommended config location.
 
QString dataLocation () const
 The recommended data location.
 
std::unique_ptr< QSettings > settings () const
 Persistent plugin settings.
 
std::unique_ptr< QSettings > state () const
 Persistent plugin state.
 

Additional Inherited Members

- Static Public Member Functions inherited from albert::PluginInstance
static QDir createOrThrow (const QString &path)
 Creates a directory, throws an exception if it fails.
 
- 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::ExtensionPlugin::description ( ) const
overridevirtual

Overrides Extension::description()

Returns
Plugin description

Implements albert::Extension.

◆ id()

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

Overrides Extension::id()

Returns
Plugin id

Implements albert::Extension.

◆ name()

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

Overrides Extension::name()

Returns
Plugin name

Implements albert::Extension.


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