de::skycoder42::QtAutoUpdater::Quick::UpdateResultDialog Class Reference

A dialog to show the result of an update check. More...

Inheritance diagram for de::skycoder42::QtAutoUpdater::Quick::UpdateResultDialog:

Properties
bool	showOnSuccess
	Show the dialog on a successfull update check. More...
bool	showOnFailure
	Show the dialog on a failed update check. More...
bool	showOnNoUpdates
	Show the dialog on a successfull update check, even if no updates are available. More...
bool	autoRunUpdater
	Specifies if the dialog should automatically start an installation. More...
int	autoInstallMode
	The install mode to use for automatic update installation. More...
int	installScope
	The install scope to use for update installation. More...
Properties inherited from de::skycoder42::QtAutoUpdater::Quick::DialogBase
Updater	updater
	The updater to be used by the dialog. More...

Detailed Description

A dialog to show the result of an update check.

Since

3.0

You can add this dialog to your UI and connect it to an updater. When an update check has completed, this dialog will show up, based on it's configuration, and inform the user about the result. It can also optionally allow him to install updates or do so automatically.

See also

QtAutoUpdater::Updater, Image Page

Definition at line 15 of file UpdateResultDialog.qml.

Property Documentation

autoInstallMode

int de::skycoder42::QtAutoUpdater::Quick::UpdateResultDialog::autoInstallMode

The install mode to use for automatic update installation.

Default: QtAutoUpdater::Updater::InstallModeFlag::Parallel

This is passed to QtAutoUpdater::Updater::runUpdater() for automatic updates, but not used if the user selects update installation manually.

Accessors
MEMBER	autoInstallMode

See also

UpdateResultDialog::autoRunUpdater, UpdateResultDialog::installScope, QtAutoUpdater::Updater::runUpdater, QtAutoUpdater::Updater::InstallModeFlag

Definition at line 103 of file UpdateResultDialog.qml.

autoRunUpdater

bool de::skycoder42::QtAutoUpdater::Quick::UpdateResultDialog::autoRunUpdater

Specifies if the dialog should automatically start an installation.

Default: false

If set to true, on a successful update, an installation will automatically be started. The autoInstallMode and installScope properties are used as arguments for QtAutoUpdater::Updater::runUpdater() and thus determine how the installer is started.

If a parallel installation is launched, the dialog itself will not show anything. If an installation is planned to be run on exit, an information is shown to the user, but only if the showOnSuccess property was set to true. If the dialog failes to start the installer and showOnFailure is set to true, an error message is shown informing the user that updates are available, but could not be installed.

Accessors
MEMBER	autoRunUpdater

See also

UpdateResultDialog::showOnSuccess, UpdateResultDialog::showOnFailure, UpdateResultDialog::autoInstallMode, UpdateResultDialog::installScope, QtAutoUpdater::Updater::runUpdater

Definition at line 88 of file UpdateResultDialog.qml.

installScope

int de::skycoder42::QtAutoUpdater::Quick::UpdateResultDialog::installScope

The install scope to use for update installation.

Default: QtAutoUpdater::Updater::InstallScope::PreferInternal

This is passed to QtAutoUpdater::Updater::runUpdater() for automatic any update installation started via this dialog. It applies for automatic and for user triggered updates and sets the prefered way of installing.

Accessors
MEMBER	installScope

See also

UpdateResultDialog::autoRunUpdater, UpdateResultDialog::autoInstallMode, QtAutoUpdater::Updater::runUpdater, QtAutoUpdater::Updater::InstallScope

Definition at line 119 of file UpdateResultDialog.qml.

showOnFailure

bool de::skycoder42::QtAutoUpdater::Quick::UpdateResultDialog::showOnFailure

Show the dialog on a failed update check.

Default: true

If the check for updates failed with an error, the dialog will only open up if this property is set to true. It will not show an error message, but inform the user that an error occured.

Accessors
MEMBER	showOnFailure

See also

UpdateResultDialog::showOnSuccess

Definition at line 50 of file UpdateResultDialog.qml.

showOnNoUpdates

bool de::skycoder42::QtAutoUpdater::Quick::UpdateResultDialog::showOnNoUpdates

Show the dialog on a successfull update check, even if no updates are available.

Default: true

If the check for updates succeeded and the showOnSuccess property is set, this property controls what happens if no updates are available. If set to true, the user is informed that there are no new updates. If set to false, nothing is shown.

Accessors
MEMBER	showOnNoUpdates

See also

UpdateResultDialog::showOnSuccess

Definition at line 65 of file UpdateResultDialog.qml.

showOnSuccess

bool de::skycoder42::QtAutoUpdater::Quick::UpdateResultDialog::showOnSuccess

Show the dialog on a successfull update check.

Default: true

If the check for updates succeeded, the dialog will only open up if this property is set to true. However, a few other properties limit this further. showOnNoUpdates and autoRunUpdater can lead to the dialog not beeing shown, even on success.

If autoRunUpdater was not enabled (set to false), the user will be presented with the options to install updates, based on which variants the backend provides. Thus the user can decide if he wants to install updates now, on exit or later.

Accessors
MEMBER	showOnSuccess

See also

UpdateResultDialog::showOnNoUpdates, UpdateResultDialog::showOnFailure, UpdateResultDialog::autoRunUpdater

Definition at line 36 of file UpdateResultDialog.qml.

---

The documentation for this class was generated from the following file:

• UpdateResultDialog.qml