diff options
Diffstat (limited to 'doc/scripting-api/packagemanagercore.qdoc')
| -rw-r--r-- | doc/scripting-api/packagemanagercore.qdoc | 90 |
1 files changed, 62 insertions, 28 deletions
diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc index ea32a59b7..ecf4b1eaa 100644 --- a/doc/scripting-api/packagemanagercore.qdoc +++ b/doc/scripting-api/packagemanagercore.qdoc @@ -1,7 +1,7 @@ /**************************************************************************** ** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ +** Copyright (C) 2023 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Installer Framework. ** @@ -71,24 +71,6 @@ \qmlsignal installer::componentAdded(Component component) Emitted when a new root \a component is added. - - \sa rootComponentsAdded(), updaterComponentsAdded() -*/ - -/*! - \qmlsignal installer::rootComponentsAdded(list<Component> components) - - Emitted when a new list of root \a components is added. - - \sa componentAdded(), updaterComponentsAdded() -*/ - -/*! - \qmlsignal installer::updaterComponentsAdded(list<Component> components) - - Emitted when a new list of updater \a components is added. - - \sa componentAdded(), rootComponentsAdded() */ /*! @@ -235,6 +217,12 @@ */ /*! + \qmlsignal installer::downloadArchivesFinished() + + Emitted when all data archives for components have been downloaded successfully. +*/ + +/*! \qmlsignal installer::wizardPageInsertionRequested(Widget widget, WizardPage page) Emitted when a custom \a widget is about to be inserted into \a page by addWizardPage. @@ -319,15 +307,25 @@ */ /*! + \qmlmethod boolean installer::recalculateAllComponents() + + Recalculates all components to install and uninstall. Returns \c true + on success, \c false otherwise. +*/ + +/*! \qmlmethod void installer::componentsToInstallNeedsRecalculation() + \deprecated [4.5] Use recalculateAllComponents() instead. Ensures that component dependencies are re-calculated. */ /*! \qmlmethod void installer::clearComponentsToInstallCalculated() - - Forces a recalculation of components to install. + \deprecated [4.5] Installer framework recalculates components each time the calculation + of components to install is requested, so there is no need to call this anymore, and the + method does nothing. On previous versions calling this forced a recalculation of + components to install. */ /*! @@ -445,7 +443,12 @@ On Unix platforms the returned string is the same as the argument. + \note Predefined variables, such as @TargetDir@, are not resolved by + this function. To convert the separators to predefined variables, use + \c installer.value() to resolve the variables first. + \sa fromNativeSeparators() + \sa value() */ /*! @@ -455,7 +458,12 @@ On Unix platforms the returned string is the same as the argument. + \note Predefined variables, such as @TargetDir@, are not resolved by + this function. To convert the separators to predefined variables, use + \c installer.value() to resolve the variables first. + \sa toNativeSeparators() + \sa value() */ /*! @@ -589,6 +597,18 @@ */ /*! + \qmlmethod bool installer::hasAdminRights() + + Returns \c true if the installer has admin rights. For example, if the installer + was started with a root account, or the internal admin rights elevation is active. + + Returns \c false otherwise. + + \sa gainAdminRights() + \sa dropAdminRights() +*/ + +/*! \qmlmethod boolean installer::isProcessRunning(string name) Returns \c true if a process with \a name is running. On Windows, the comparison @@ -607,15 +627,23 @@ /*! \qmlmethod void installer::setAllowedRunningProcesses(stringlist processes) + \deprecated [4.6] The \MT no longer automatically checks for all running processes + in the installation directory for CLI runs. To check for a process to stop, use + \l {component::addStopProcessForUpdateRequest}{component.addStopProcessForUpdateRequest} instead. + Sets additional \a processes that can run when - updating with the maintenance tool. + updating with the \MT. */ /*! \qmlmethod stringlist installer::allowedRunningProcesses() + \deprecated [4.6] The \MT no longer automatically checks for all running processes + in the installation directory for CLI runs. To check for a process to stop, use + \l {component::addStopProcessForUpdateRequest}{component.addStopProcessForUpdateRequest} instead. + Returns processes that are allowed to run when updating with - the maintenance tool. + the \MT. */ /*! @@ -730,7 +758,7 @@ /*! \qmlmethod void installer::setInstallerBaseBinary(string path) - Sets the \c installerbase binary to use when writing the maintenance tool. + Sets the \c installerbase binary to use when writing the \MT. Set the \a path if an update to the binary is available. If not set, the executable segment of the running installer or uninstaller @@ -738,10 +766,16 @@ */ /*! - \qmlmethod string installer::value(string key, string defaultValue = "") + \qmlmethod string installer::value(string key, string defaultValue = "", int format = 0) - Returns the installer value for \a key. If \a key is not known to the system, \a defaultValue is - returned. Additionally, on Windows, \a key can be a registry key. + Returns the installer value for \a key. If \a key is not known to the system, + \a defaultValue is returned. Additionally, on Windows, \a key can be a + registry key. Optionally, you can specify the \a format of the registry key. + By default the \a format is QSettings::NativeFormat. For accessing + the 32-bit system registry from a 64-bit application running on 64-bit + Windows, use QSettings::Registry32Format. For accessing the 64-bit system + registry from a 32-bit application running on 64-bit Windows, use + QSettings::Registry64Format. \sa setValue, containsValue, valueChanged */ |