PluginSpec Class

Member Function Documentation

void PluginSpec::addArgument(const QString &argument)

Adds argument to the command line arguments specific to the plugin.

ExtensionSystem::PluginSpec::PluginArgumentDescriptions PluginSpec::argumentDescriptions() const

Returns a list of descriptions of command line arguments the plugin processes.

QStringList PluginSpec::arguments() const

Returns command line arguments specific to the plugin. Set at startup.

See also setArguments().

QString PluginSpec::category() const

Returns the category that the plugin belongs to. Categories are used to group plugins together in the UI. Returns an empty string if the plugin does not belong to a category.

QString PluginSpec::compatVersion() const

Returns the plugin compatibility version. This is valid after the PluginSpec::Read state is reached.

QString PluginSpec::copyright() const

Returns the plugin copyright. This is valid after the PluginSpec::Read state is reached.

QVector<ExtensionSystem::PluginDependency> PluginSpec::dependencies() const

The plugin dependencies. This is valid after the PluginSpec::Read state is reached.

QHash<ExtensionSystem::PluginDependency, ExtensionSystem::PluginSpec *> PluginSpec::dependencySpecs() const

Returns the list of dependencies, already resolved to existing plugin specs. Valid if PluginSpec::Resolved state is reached.

See also PluginSpec::dependencies().

QString PluginSpec::description() const

Returns the plugin description. This is valid after the PluginSpec::Read state is reached.

QString PluginSpec::errorString() const

Returns a detailed, possibly multi-line, error description in case of an error.

QString PluginSpec::filePath() const

Returns the absolute path to the plugin.

bool PluginSpec::hasError() const

Returns whether an error occurred while reading or starting the plugin.

bool PluginSpec::isAvailableForHostPlatform() const

Returns whether the plugin works on the host platform.

bool PluginSpec::isEffectivelyEnabled() const

Returns whether the plugin is loaded at startup.

See also isEnabledBySettings().

bool PluginSpec::isEnabledByDefault() const

Returns whether the plugin is enabled by default. A plugin might be disabled because the plugin is experimental, or because the installation settings define it as disabled by default.

bool PluginSpec::isEnabledBySettings() const

Returns whether the plugin should be loaded at startup, taking into account the default enabled state, and the user's settings.

See also isEffectivelyEnabled().

bool PluginSpec::isEnabledIndirectly() const

Returns true if loading was not done due to user unselecting this plugin or its dependencies.

bool PluginSpec::isExperimental() const

Returns whether the plugin has its experimental flag set.

bool PluginSpec::isForceDisabled() const

Returns whether the plugin is disabled via the -noload option on the command line.

bool PluginSpec::isForceEnabled() const

Returns whether the plugin is enabled via the -load option on the command line.

bool PluginSpec::isRequired() const

Returns whether the plugin is required.

QString PluginSpec::license() const

Returns the plugin license. This is valid after the PluginSpec::Read state is reached.

QString PluginSpec::location() const

Returns the absolute path to the directory containing the plugin.

QString PluginSpec::longDescription() const

Returns the plugin's long description. This is valid after the PluginSpec::Read state is reached.

QJsonObject PluginSpec::metaData() const

Returns the plugin meta data.

QString PluginSpec::name() const

Returns the plugin name. This is valid after the PluginSpec::Read state is reached.

[since 3.0] QRegularExpression PluginSpec::platformSpecification() const

Returns a QRegularExpression matching the platforms this plugin works on. An empty pattern implies all platforms.

This function was introduced in Qt 3.0.

ExtensionSystem::IPlugin *PluginSpec::plugin() const

Returns the corresponding IPlugin instance, if the plugin library has already been successfully loaded. That is, the PluginSpec::Loaded state is reached.

bool PluginSpec::provides(const QString &pluginName, const QString &version) const

Returns whether this plugin can be used to fill in a dependency of the given pluginName and version.

See also PluginSpec::dependencies().

bool PluginSpec::requiresAny(const QSet<ExtensionSystem::PluginSpec *> &plugins) const

Returns whether the plugin requires any of the plugins specified by plugins.

void PluginSpec::setArguments(const QStringList &arguments)

Sets the command line arguments specific to the plugin to arguments.

See also arguments().

void PluginSpec::setEnabledBySettings(bool value)

Sets whether the plugin should be loaded at startup to value.

See also isEnabledBySettings().

ExtensionSystem::PluginSpec::State PluginSpec::state() const

Returns the state in which the plugin currently is. See the description of the PluginSpec::State enum for details.

QString PluginSpec::url() const

Returns the plugin URL where you can find more information about the plugin. This is valid after the PluginSpec::Read state is reached.

QString PluginSpec::vendor() const

Returns the plugin vendor. This is valid after the PluginSpec::Read state is reached.

QString PluginSpec::version() const

Returns the plugin version. This is valid after the PluginSpec::Read state is reached.