Albert
|
#include <albert/pluginmetadata.h>
Common plugin metadata.
Public Types | |
enum class | LoadType { User , Frontend } |
The load type of the plugin. More... | |
Public Attributes | |
QString | iid |
Plugin interface identifier. | |
QString | id |
Unique identifier. | |
QString | version |
Semantic version. | |
QString | name |
Human readable name. | |
QString | description |
Brief, imperative description. | |
QString | license |
SPDX short-form license identifier. | |
QString | url |
Browsable source. | |
QString | readme_url |
Online readme. | |
QStringList | translations |
Available translations. | |
QStringList | authors |
The copyright holders. | |
QStringList | runtime_dependencies |
Required libraries. | |
QStringList | binary_dependencies |
Required executables. | |
QStringList | plugin_dependencies |
Required plugins. | |
QStringList | third_party_credits |
Third party credits and license notes. | |
QStringList | platforms |
List of supported platforms. | |
LoadType | load_type |
The load type of the plugin. | |
|
strong |
The load type of the plugin.
Some plugins have to be treated differently when loading. E.g. a frontends are an integral part of the app, there has to be exactly one frontend which will be loaded before any other plugins. Some other pluins cannot be safely unloaded at runtime (e.g. Python).
Enumerator | |
---|---|
User | Plugin should be user (un-)loadable. |
Frontend | Loading handled by the core. Requires Frontend interface. |
QStringList albert::PluginMetadata::authors |
The copyright holders.
QStringList albert::PluginMetadata::binary_dependencies |
Required executables.
QString albert::PluginMetadata::description |
Brief, imperative description.
QString albert::PluginMetadata::id |
Unique identifier.
No duplicates allowed. To avoid name conflicts implementations should prefix their plugins ids with the id of the loader id.
QString albert::PluginMetadata::iid |
Plugin interface identifier.
The core app API version used.
QString albert::PluginMetadata::license |
LoadType albert::PluginMetadata::load_type |
The load type of the plugin.
QString albert::PluginMetadata::name |
Human readable name.
QStringList albert::PluginMetadata::platforms |
List of supported platforms.
If empty all platforms are supported.
QStringList albert::PluginMetadata::plugin_dependencies |
Required plugins.
QString albert::PluginMetadata::readme_url |
Online readme.
QStringList albert::PluginMetadata::runtime_dependencies |
Required libraries.
QStringList albert::PluginMetadata::third_party_credits |
Third party credits and license notes.
QStringList albert::PluginMetadata::translations |
Available translations.
QString albert::PluginMetadata::url |
Browsable source.
QString albert::PluginMetadata::version |