A simple button for update checks. More...

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

Properties
Updater	updater
	The different modes of what text to show on the button while checking for updates. More...

int	textMode
	The text mode while checking for updates. More...

bool	allowInstall
	Specifies if the button makes it possible for the user to install updates. More...

int	installMode
	The installation mode to be used to install updates. More...

int	installScope
	The installation scope to be used to install updates. More...

real	_currentProgress
	[PRIVATE PROPERTY]

string	_currentStatus
	[PRIVATE PROPERTY]

Detailed Description

A simple button for update checks.

Since: 3.0

The UpdateButton is a ready-made "button" to check for updates. It is connected to an updater and thus will automatically start checking for updates. It will also display a progress and optionally allow canceling and installation of updates.

The button will represent the updaters state and automatically enable/disable itself to avoid start beeing called twice. In addition to that, the whole button item will be disabled if the updater gets deleted while the button is still existant.

See also: QtAutoUpdater::Updater, QtAutoUpdater::Updater::checkForUpdates, Image Page

Definition at line 22 of file UpdateButton.qml.

Property Documentation

◆ allowInstall

bool de::skycoder42::QtAutoUpdater::Quick::UpdateButton::allowInstall

Specifies if the button makes it possible for the user to install updates.

Default: true

If set to true and after an update check, there are new updates, the button will show "Install" as text and when clicked start the update installation, according to the installMode and installScope properties via QtAutoUpdater::Updater::runUpdater().

If set to false, the button will instead show the information, that updates are available. If clicked again, the button simply starts another updater check

Accessors
MEMBER	allowInstall

See also: UpdateButton::installMode, UpdateButton::installScope, QtAutoUpdater::Updater::runUpdater

Definition at line 66 of file UpdateButton.qml.

◆ installMode

int de::skycoder42::QtAutoUpdater::Quick::UpdateButton::installMode

The installation mode to be used to install updates.

Default: Updater::InstallModeFlag::Parallel

The install mode to be passed to Updater::runUpdater, if the allowInstall flag is set and the user launches an installation via the button.

Accessors
MEMBER	installMode

See also: QtAutoUpdater::Updater::runUpdater, QtAutoUpdater::Updater::InstallModeFlag, UpdateButton::installScope

Definition at line 81 of file UpdateButton.qml.

◆ installScope

int de::skycoder42::QtAutoUpdater::Quick::UpdateButton::installScope

The installation scope to be used to install updates.

Default: Updater::InstallScope::PreferInternal

The install scope to be passed to Updater::runUpdater, if allowInstall is set and the user launches an installation via the button.

Accessors
MEMBER	installScope

See also: QtAutoUpdater::Updater::runUpdater, QtAutoUpdater::Updater::InstallModeFlag, UpdateButton::installMode

Definition at line 96 of file UpdateButton.qml.

◆ textMode

int de::skycoder42::QtAutoUpdater::Quick::UpdateButton::textMode

The text mode while checking for updates.

Default: UpdateButton::Cancel

This mode defines what the button shows and does while checking for updates. Refer to the documentation of the enum for more details.

Accessors
MEMBER	textMode

See also: UpdateButton::TextMode

Definition at line 48 of file UpdateButton.qml.

◆ updater

Updater de::skycoder42::QtAutoUpdater::Quick::UpdateButton::updater

The different modes of what text to show on the button while checking for updates.

The updater to be used by the button

Default: null

Accessors
MEMBER	updater

See also: QtAutoUpdater::Updater

Definition at line 34 of file UpdateButton.qml.

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

UpdateButton.qml