diff options
Diffstat (limited to 'doc/scripting-api/packagemanagercore.qdoc')
| -rw-r--r-- | doc/scripting-api/packagemanagercore.qdoc | 149 |
1 files changed, 105 insertions, 44 deletions
diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc index 918aed78d..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. ** @@ -70,31 +70,13 @@ /*! \qmlsignal installer::componentAdded(Component component) - Emitted when a new root component is added. - - \sa rootComponentsAdded(), updaterComponentsAdded() -*/ - -/*! - \qmlsignal installer::rootComponentsAdded(list<Component> components) - - Emitted when a new list of root components is added. - - \sa componentAdded(), updaterComponentsAdded() -*/ - -/*! - \qmlsignal installer::updaterComponentsAdded(list<Component> components) - - Emitted when a new list of updater components is added. - - \sa componentAdded(), rootComponentsAdded() + Emitted when a new root \a component is added. */ /*! \qmlsignal installer::valueChanged(string key, string value) - Emitted when a value changes. + Emitted when a \a value for \a key changes. \sa setValue() */ @@ -102,13 +84,13 @@ /*! \qmlsignal installer::statusChanged(Status status) - Emitted when the installer status changes. + Emitted when the installer \a status changes. */ /*! \qmlsignal installer::currentPageChanged(int page) - Emitted when the current page changes. + Emitted when the current \a page changes. */ /*! @@ -120,21 +102,21 @@ /*! \qmlsignal installer::metaJobProgress(int progress) - Triggered with progress updates of the communication with a remote + Triggered with \a progress updates of the communication with a remote repository. Progress ranges from 0 to 100. */ /*! \qmlsignal installer::metaJobTotalProgress(int progress) - Triggered when total progress value of the communication with a + Triggered when total \a progress value of the communication with a remote repository changes. */ /*! \qmlsignal installer::metaJobInfoMessage(string message) - Triggered with informative updates of the communication with a remote repository. + Triggered with informative updates, \a message, of the communication with a remote repository. */ /*! @@ -148,7 +130,7 @@ /*! \qmlsignal installer::finishAllComponentsReset(list<Component> rootComponents) - Triggered when the list of new root components has been updated. + Triggered when the list of new root components \a rootComponents has been updated. \sa startAllComponentsReset() */ @@ -162,7 +144,7 @@ /*! \qmlsignal installer::finishUpdaterComponentsReset(list<Component> componentsWithUpdates) - Triggered when the list of available remote updates has been updated. + Triggered when the list of available remote updates \a componentsWithUpdates has been updated. */ /*! @@ -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. @@ -272,7 +260,9 @@ \qmlsignal installer::setValidatorForCustomPageRequested(Component component, string name, string callbackName) - Triggered when setValidatorForCustomPage is called. + Requests that a validator be set for the custom page specified by \a name and + \a callbackName for the component \a component. Triggered when + setValidatorForCustomPage() is called. */ /*! @@ -317,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. */ /*! @@ -406,7 +406,7 @@ /*! \qmlmethod boolean installer::isFileExtensionRegistered(string extension) - Returns whether a file extension is already registered in the Windows registry. Returns \c false + Returns whether a file \a extension is already registered in the Windows registry. Returns \c false on all other platforms. */ @@ -436,6 +436,37 @@ */ /*! + \qmlmethod string installer::toNativeSeparators(string path) + + Returns \a path with the '/' separators converted to separators that are + appropriate for the underlying operating system. + + 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() +*/ + +/*! + \qmlmethod string installer::fromNativeSeparators(string path) + + Returns \a path using '/' as file separator. + + 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() +*/ + +/*! \qmlmethod boolean installer::fileExists(string filePath) Returns \c true if the \a filePath exists; otherwise returns \c false. @@ -484,6 +515,9 @@ \qmlmethod void installer::setValidatorForCustomPage(Component component, string name, string callbackName) + Sets a validator for the custom page specified by \a name and \a callbackName + for the component \a component. + \sa setValidatorForCustomPageRequested() */ @@ -521,7 +555,8 @@ /*! \qmlmethod void installer::setTemporaryRepositories(stringlist repositories, boolean replace) - Sets additional \a repositories for this instance of the installer or updater. + Sets additional \a repositories for this instance of the installer or updater. If \a replace + is \c true, existing repositories will be replaced. Will be removed after invoking it again. \sa addUserRepositories() @@ -562,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 @@ -580,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. */ /*! @@ -613,13 +668,13 @@ /*! \qmlmethod array installer::execute(string program, stringlist arguments = undefined, - string stdin = "", string stdinCodec = "latin1", - string stdoutCodec = "latin1") + string stdIn = "", string stdInCodec = "latin1", + string stdOutCodec = "latin1") Starts the program \a program with the arguments \a arguments in a new process and waits for it to finish. - \a stdin is sent as standard input to the application. + \a stdIn is sent as standard input to the application. \a stdInCodec is the name of the codec to use for converting the input string into bytes to write to the standard input of the application. @@ -703,18 +758,24 @@ /*! \qmlmethod void installer::setInstallerBaseBinary(string path) - Sets the \c installerbase binary to use when writing the maintenance tool. - Set the path if an update to the binary is available. + 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 will be used. */ /*! - \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 */ |