组件类

成员函数文档

[显式] Component::Component(QInstaller::PackageManagerCore *core)

创建了包管理器中由 core 指定的新组件。

[虚函数， noexcept] Component::~Component()

销毁组件。

[可调用] void Component::addAutoDependOn(const QString &newDependOn)

将指定的组件 newDependOn 添加到自动依赖列表中。或者，可以通过逗号分隔来指定多个组件。

另请参阅component.addAutoDependOn 和 autoDependencies。

[可调用] void Component::addDependency(const QString &newDependency)

将指定的组件 newDependency 添加到依赖列表中。或者可以通过逗号分隔来指定多个组件。

另请参阅component.addDependency 和 dependencies。

[可调用] void Component::addDownloadableArchive(const QString &path)

将存档 path 添加到该组件中。这仅当此组件是从在线仓库下载时调用此函数。添加 path 时，安装开始时会从仓库中下载。

另请参阅component.addDownloadableArchive，removeDownloadableArchive，fromOnlineRepository 和 archives。

void Component::addElevatedOperation(QInstaller::Operation *operation)

将 operation 添加到需要安装此组件的操作列表中。 operation 将以提升的权限执行。

bool Component::addElevatedOperation(const QString &operation, const QStringList &parameters)

创建并添加安装操作 operation。可以添加任意数量的 parameters。参数包含的变量，如 @TargetDir@，将被它们的值替换。操作将以提升的权限执行。

如果创建操作，则返回 true；否则返回 false。

另请参阅component.addElevatedOperation。

void Component::addOperation(QInstaller::Operation *operation)

将operation添加到安装此组件需要的操作列表。

bool Component::addOperation(const QString &operation, const QStringList &parameters)

创建并添加一个用于operation的安装操作。添加任何数量的parameters。参数包含的变量，如@TargetDir@，将被其值替换。

如果创建操作，则返回 true；否则返回 false。

另请参阅component.addOperation.

[invokable] void Component::addStopProcessForUpdateRequest(const QString &process)

在安装、更新或卸载组件之前，添加退出进程process的请求。

另请参阅component.addStopProcessForUpdateRequest.

void Component::appendComponent(QInstaller::Component *component)

将component作为此组件的子组件添加。如果component已经有一个父组件，它将从一个父组件中移除。如果component包含多个子组件，并且设置了SortingPriorityGreaterThan()排序优先级，则子组件列表将按最高优先级的子组件置顶排序。

QStringList Component::archives() const

包含此组件所有已知归档的名称。即使在下载过程中，通过所用QFileEngineHandler，下载的归档也会映射到installer:// URL。

bool Component::autoCreateOperations() const

指定在安装开始时是否应该自动创建操作。这将通过调用createOperations()来完成。如果您设置为false，则完全由组件的脚本创建所有操作。

当组件的脚本将创建所有操作时返回false；否则返回true。

另请参阅setAutoCreateOperations()和component.autoCreateOperations。

[virtual invokable] void Component::beginInstallation()

另请参阅component.beginInstallation。

[invokable] bool Component::componentChangeRequested()

如果该组件将发生变化（更新、安装或卸载），则返回true。

另请参阅component.componentChangeRequested

[virtual invokable] void Component::createOperations()

另请参阅 component.createOperations 和 createOperationsForArchive。

[虚拟可调用] void Component::createOperationsForArchive(const QString &archive)

创建安装此组件存档所需的所有操作。此方法从 createOperations 调用。您可以通过在组件脚本中提供相同名称的方法来重写此方法。

默认实现将调用 createOperationsForPath，为存档中的所有内容执行操作。如果 archive 是安装程序系统已知的压缩存档，则创建一个解压缩操作。

另请参阅 component.createOperationsForArchive。

[虚拟可调用] void Component::createOperationsForPath(const QString &path)

创建安装此组件路径所需的所有操作。path 是一个包含组件名称的完全限定文件名。此方法从 createOperationsForArchive 调用。您可以通过在组件脚本中提供相同名称的方法来重写它。

默认实现为 path 中的所有文件和文件夹递归地创建复制和创建目录操作。

另请参阅 component.createOperationsForPath。

QStringList Component::currentDependencies() const

返回组件当前拥有的依赖项列表。当组件已安装，但依赖项列表与存储库中引入的列表不同时，依赖项可能会变化。如果组件未安装，或请求更新已安装的组件，则从存储库中读取当前依赖项，以确保在安装或更新组件时正确计算依赖项。

QStringList Component::dependencies() const

返回在存储库或 package.xml 中定义的依赖项列表。

QList<QInstaller::Component *> Component::descendantComponents() const

返回儿童组件列表，包括组件子级的所有后代。

QString Component::displayName() const

包含此组件的显示名称，该名称在用户可见。

QStringList Component::downloadableArchives()

在安装前从在线存储库返回要下载的存档。应在开始安装时仅调用一次。

bool Component::forcedInstallation() const

返回此组件是否始终应安装。

[可调用的] bool Component::installationRequested() const

返回用户是否想安装组件。

另请参阅component.installationRequested.

[可调用的] bool Component::isAutoDependOn(const QSet<QString> &componentsToInstall) const

确定组件是否作为自动依赖项。如果componentsToInstall中的所有组件都已安装或选择安装，则此组件需要一起安装，将返回true。

另请参阅component.isAutoDependOn.

bool Component::isEssential() const

返回此组件是否是必需品。必需品始终安装，并且在其他组件之前更新。

[可调用的] bool Component::isForcedUpdate()

如果组件已安装并设置了ForcedUpdate标志，则返回true。强制更新组件将在任何其他组件可以更新或安装之前与必需组件一起更新。

另请参阅component.isForcedUpdate.

[可调用的] bool Component::isFromOnlineRepository() const

返回此组件是否已从在线存储库加载。

另请参阅component.isFromOnlineRepository、addDownloadableArchive()和fromOnlineRepository.

bool Component::isSelected() const

返回组件是否已选择。

bool Component::isSelectedForInstallation() const

返回组件是否已选中用于安装。

[可调用的] bool Component::isUninstalled() const

返回组件是否已卸载。

另请参阅component.isUninstalled.

bool Component::isUnstable() const

如果此组件不稳定，则返回true。

[可调用的] bool Component::isUpdateAvailable() const

返回是否为此组件提供更新。

另请参阅 component.isUpdateAvailable.

bool Component::isVirtual() const

返回此组件是否为虚拟的。

QHash<QString, QVariantMap> Component::licenses() const

返回包含组件的许可证文件名、文本和优先级的哈希表。

void Component::loadComponentScript(const bool postLoad = false)

将组件脚本加载到脚本引擎中。在性能非常重要且不需要在安装开始前调用脚本函数的情况下，调用此方法并将postLoad设置为true以提高大量组件更新或安装时的性能。

void Component::loadDataFromPackage(const QInstaller::Package &package)

根据包中的package.xml中设置的值设置变量。如果包中引用了UI文件、许可证和翻译，则会加载它们。如果此组件的PackageManagerCore对象作为包查看器运行，则只设置变量而不加载引用的文件。

void Component::loadDataFromPackage(const KDUpdater::LocalPackage &package)

根据本地包中的package.xml中设置的值设置变量。

void Component::loadLicenses(const QString &directory, const QHash<QString, QVariant> &licenseHash)

从directory中加载licenseHash中包含的许可证文本。这些文本保存到一个新的哈希表中，包含文件名、文本和优先级。

void Component::loadTranslations(const QDir &directory, const QStringList &qms)

在directory内部加载与名称过滤器qms匹配的翻译。只有基本名称与当前区域设置的名称匹配的翻译会被加载。有关更多信息，请参阅翻译页面。

void Component::loadUserInterfaces(const QDir &directory, const QStringList &uis)

在directory内部加载与名称过滤器uis匹配的用户界面文件。可以通过访问userInterfaces()并使用在UI文件中设置的类名来访问加载的界面。

void Component::loadXMLExtractOperations()

加载在组件.xml中定义的所有提取操作。操作将覆盖默认的提取操作实现。

void Component::loadXMLOperations()

加载组件.xml中定义的所有操作（除提取操作外）。操作将被添加到安装此组件所需的操作列表中。

[信号] void Component::loaded()

另请参阅 component.loaded.

QStringList Component::localDependencies() const

返回在components.xml中定义的已安装组件的依赖列表。

QString Component::localTempPath() const

返回组件临时存储的本地目录的路径。

void Component::markAsPerformedInstallation()

将组件标记为已安装。

QString Component::name() const

包含此组件的唯一标识符。

QInstaller::OperationList Component::operations(const KDUpdater::UpdateOperation::OperationGroups &mask = Operation::All) const

返回安装此组件所需的操作。如果autoCreateOperations()为true，则如果尚未自动创建任何操作，则会调用createOperations()。

mask参数通过操作组筛选返回的操作。

bool Component::operationsCreatedSuccessfully() const

返回是否成功创建了安装此组件所需的操作。

QInstaller::PackageManagerCore *Component::packageManagerCore() const

返回此组件所属的安装程序。

QInstaller::Component *Component::parentComponent() const

返回此组件的父级。例如，如果存在，则名为org.qt-project.sdk.qt的组件的父级是org.qt-project.sdk。

QList<QPair<QString, bool>> Component::pathsForUninstallation() const

返回以前使用registerPathForUninstallation()注册用于卸载的路径列表。

[可调用] void Component::registerPathForUninstallation(const QString &path, bool wipe = false)

将位于path处的文件或目录注册为在卸载此组件时删除。如果是目录，则递归。如果将wipe设置为true，并且目录包含用户在安装后所做的更改，则也会删除该目录。

另请参阅 component.registerPathForUninstallation.

void Component::removeComponent(QInstaller::Component *component)

如果component是该组件的子组件，则移除它。函数返回后，组件对象仍然存在。由调用者决定删除传入的component。

[可调用] void Component::removeDownloadableArchive(const QString &path)

移除通过addDownloadableArchive()之前添加到此组件的存档path。只有当这个组件是从在线仓库下载的时，才能调用此函数。

另请参阅component.removeDownloadableArchive、addDownloadableArchive、fromOnlineRepository和archives。

[可调用] void Component::removeStopProcessForUpdateRequest(const QString &process)

重新移除退出进程process的请求。

另请参阅component.removeStopProcessForUpdateRequest。

int Component::removeValue(const QString &key)

从为此组件设置的变量中移除所有具有key的值。返回移除的值的数量，如果键存在于变量中，则为1，否则为0。

QUrl Component::repositoryUrl() const

包含此组件下载的仓库URL。如果此组件不是从在线仓库下载的，则返回空QUrl。

另请参阅setRepositoryUrl()。

[可调用] void Component::setInstalled()

另请参阅isInstalled()和component.setInstalled。

void Component::setRepositoryUrl(const QUrl &url)

将此组件的仓库URL设置为url。

另请参阅repositoryUrl()。

[可调用] void Component::setStopProcessForUpdateRequest(const QString &process, bool requested)

一个便捷函数，根据requested是否为true（添加）或false（移除），添加或删除停止process的请求。

另请参阅component.addStopProcessForUpdateReques。

[可调用] void Component::setUninstalled()

另请参阅isUninstalled()和component.setUninstalled。

void Component::setUnstable(QInstaller::Component::UnstableError error, const QString &errorMessage = QString())

设置此组件及其所有子组件和依赖于该组件的组件不稳定，错误代码为error，错误消息为errorMessage。

另请参阅 isUnstable。

[可调用] void Component::setUpdateAvailable(bool isUpdateAvailable)

将isUpdateAvailable标志设置为true，以指示核心找到了更新。

另请参阅 isUpdateAvailable和component.setUpdateAvailable。

void Component::setValidatorCallbackName(const QString &name)

设置验证器回调名称为name。

[可调用] void Component::setValue(const QString &key, const QString &value)

将变量key的值设置为value。

另请参阅 value和component.setValue。

QStringList Component::stopProcessForUpdateRequests() const

需要在安装、更新或卸载此组件之前关闭的进程列表。

QString Component::treeName() const

返回此组件在树视图中的位置。如果未设置树名，则返回组件名。树名必须唯一，不应与其他树名或组件名冲突。

bool Component::treeNameMoveChildren() const

如果此组件的后代应该在与其父组件修改后的位置相关联的情况下自动创建树名，则返回true，否则返回false。

[可调用] bool Component::uninstallationRequested() const

返回用户是否想要卸载此组件。

另请参阅 component.uninstallationRequested。

[可调用] bool Component::updateRequested() const

返回用户是否想要为此组件安装更新。

另请参阅 component.updateRequested。

quint64 Component::updateUncompressedSize()

返回压缩存档的大小。

[可调用] QWidget *Component::userInterface(const QString &name) const

返回为 name 创建的 QWidget 或者在控件被删除或找不到时，返回 0。

另请参阅component.userInterface。

bool Component::validatePage()

调用带有验证器回调名称的脚本方法。如果方法返回 true，则返回 true。如果验证器回调名称为空，则始终返回 true。

[可调用] QString Component::value(const QString &key, const QString &defaultValue = QString()) const

返回变量名 key 的值。如果 key 尚未知晓，则返回 defaultValue。

另请参阅setValue。

[信号] void Component::valueChanged(const QString &key, const QString &value)

当变量名 key 的值更改到 value 时发出。

另请参阅component.valueChanged 和 setValue。

QHash<QString, QString> Component::variables() const

返回所有为该组件设置的变量的键值哈希。

[信号] void Component::virtualStateChanged()

另请参阅component.virtualStateChanged。