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

#include <plugin.h>

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

Detailed Description

Convenience base class for extension plugins.

Implements pure virtual functions of Extension and PluginInstance.

  • QString id() using the metadata
  • QString name() using the metadata
  • QString description() using the metadata
  • std::vector<Extension*> extensions() returning {this}

Public Member Functions

QString id () const override
 Override returning PluginInstance::id. More...
 
QString name () const override
 Override returning PluginInstance::name. More...
 
QString description () const override
 Override returning PluginInstance::description. More...
 
void initialize (ExtensionRegistry &, std::map< QString, PluginInstance * >) override
 Override registering itself as extension. More...
 
void finalize (ExtensionRegistry &) override
 Override deregistering itself as extension. More...
 
- Public Member Functions inherited from albert::PluginInstance
 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...
 
- Public Member Functions inherited from albert::Extension
 Extension ()=default
 
virtual QString id () const =0
 The identifier of this extension. More...
 
virtual QString name () const =0
 Pretty, human readable name. More...
 
virtual QString description () const =0
 Brief description of this extension. More...
 

Additional Inherited Members

- Protected Member Functions inherited from albert::PluginInstance
virtual ~PluginInstance ()
 
- Protected Member Functions inherited from albert::Extension
virtual ~Extension ()=default
 

Member Function Documentation

◆ description()

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

Override returning PluginInstance::description.

Implements albert::Extension.

◆ finalize()

void albert::plugin::ExtensionPlugin::finalize ( ExtensionRegistry )
overridevirtual

Override deregistering itself as extension.

Reimplemented from albert::PluginInstance.

◆ id()

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

Override returning PluginInstance::id.

Implements albert::Extension.

◆ initialize()

void albert::plugin::ExtensionPlugin::initialize ( ExtensionRegistry ,
std::map< QString, PluginInstance * >   
)
overridevirtual

Override registering itself as extension.

Reimplemented from albert::PluginInstance.

◆ name()

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

Override returning PluginInstance::name.

Implements albert::Extension.


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