A read-only view of one plugin's metadata, plus the runtime state the manager attaches to it. 更多...

#include <qxplugin/qxpluginspec.h>

Public 成员函数
	QxPluginSpec ()

	~QxPluginSpec ()

QString	id () const
	Stable plugin id; also the base name of its library and metadata file.

QVersionNumber	version () const

QVersionNumber	compatVersion () const
	Lowest host version the plugin still supports; the host must be in [compatVersion, version].

QString	vendor () const

QString	copyright () const

QString	category () const

QString	description () const

QString	url () const

QStringList	dependencies () const
	Required dependency ids, in declaration order.

QStringList	optionalDependencies () const
	Optional dependency ids (Type == "optional" in the metadata).

bool	isEnabledByDefault () const
	True when the plugin starts unless explicitly disabled (EnabledByDefault).

bool	isDisabled () const
	True when the plugin will not run: forced off, skipped by default, or failed.

QxPluginState	state () const

QxPlugin *	plugin () const
	The live instance, or null until Loaded.

QString	filePath () const
	Path of the metadata file (dynamic) or the registration key (static).

QString	error () const
	Why the plugin is not running; empty when it runs or is only skipped by default.

bool	read (const QString &filePath, const QJsonObject &metaData)
	Fills the spec from metadata; returns false (and records error()) on a malformed document.

友元
class	QxPluginManager

class	QxPluginManagerPrivate

详细描述

A read-only view of one plugin's metadata, plus the runtime state the manager attaches to it.

The manager builds a spec from the plugin.json (dynamic) or from an embedded QJsonObject (static), then walks it through QxPluginState as the run loads. Everything a plugin needs to know about another plugin - its id, its version, its dependency list - lives here; the plugin binary itself is only touched once.

在文件 qxpluginspec.h 第 53 行定义.

构造及析构函数说明

◆ QxPluginSpec()

QxPlugin::QxPluginSpec::QxPluginSpec ( )

在文件 qxpluginspec.cpp 第 37 行定义.

◆ ~QxPluginSpec()

QxPlugin::QxPluginSpec::~QxPluginSpec ( )

在文件 qxpluginspec.cpp 第 42 行定义.

成员函数说明

◆ category()

QString QxPlugin::QxPluginSpec::category ( ) const

在文件 qxpluginspec.cpp 第 74 行定义.

◆ compatVersion()

QVersionNumber QxPlugin::QxPluginSpec::compatVersion ( ) const

Lowest host version the plugin still supports; the host must be in [compatVersion, version].

在文件 qxpluginspec.cpp 第 56 行定义.

◆ copyright()

QString QxPlugin::QxPluginSpec::copyright ( ) const

在文件 qxpluginspec.cpp 第 68 行定义.

◆ dependencies()

QStringList QxPlugin::QxPluginSpec::dependencies ( ) const

Required dependency ids, in declaration order.

在文件 qxpluginspec.cpp 第 92 行定义.

◆ description()

QString QxPlugin::QxPluginSpec::description ( ) const

在文件 qxpluginspec.cpp 第 80 行定义.

◆ error()

QString QxPlugin::QxPluginSpec::error ( ) const

Why the plugin is not running; empty when it runs or is only skipped by default.

在文件 qxpluginspec.cpp 第 134 行定义.

◆ filePath()

QString QxPlugin::QxPluginSpec::filePath ( ) const

Path of the metadata file (dynamic) or the registration key (static).

在文件 qxpluginspec.cpp 第 128 行定义.

◆ id()

QString QxPlugin::QxPluginSpec::id ( ) const

Stable plugin id; also the base name of its library and metadata file.

在文件 qxpluginspec.cpp 第 44 行定义.

◆ isDisabled()

bool QxPlugin::QxPluginSpec::isDisabled ( ) const

True when the plugin will not run: forced off, skipped by default, or failed.

在文件 qxpluginspec.cpp 第 110 行定义.

◆ isEnabledByDefault()

bool QxPlugin::QxPluginSpec::isEnabledByDefault ( ) const

True when the plugin starts unless explicitly disabled (EnabledByDefault).

在文件 qxpluginspec.cpp 第 104 行定义.

◆ optionalDependencies()

QStringList QxPlugin::QxPluginSpec::optionalDependencies ( ) const

Optional dependency ids (Type == "optional" in the metadata).

在文件 qxpluginspec.cpp 第 98 行定义.

◆ plugin()

QxPlugin * QxPlugin::QxPluginSpec::plugin ( ) const

The live instance, or null until Loaded.

在文件 qxpluginspec.cpp 第 122 行定义.

◆ read()

bool QxPlugin::QxPluginSpec::read	(	const QString &	filePath,
		const QJsonObject &	metaData
	)

Fills the spec from metadata; returns false (and records error()) on a malformed document.

在文件 qxpluginspec.cpp 第 140 行定义.

◆ state()

QxPluginState QxPlugin::QxPluginSpec::state ( ) const

在文件 qxpluginspec.cpp 第 116 行定义.

◆ url()

QString QxPlugin::QxPluginSpec::url ( ) const

在文件 qxpluginspec.cpp 第 86 行定义.

◆ vendor()

QString QxPlugin::QxPluginSpec::vendor ( ) const

在文件 qxpluginspec.cpp 第 62 行定义.

◆ version()

QVersionNumber QxPlugin::QxPluginSpec::version ( ) const

在文件 qxpluginspec.cpp 第 50 行定义.

友元及相关函数文档

◆ QxPluginManager

friend class QxPluginManager

friend

在文件 qxpluginspec.h 第 96 行定义.

◆ QxPluginManagerPrivate

friend class QxPluginManagerPrivate