de::skycoder42::QtAutoUpdater::Quick::UpdateInstallerComponent Class Reference

A component that creates an update installation wizard. More...

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

Properties
Connections	_connections
	[PRIVATE PROPERTY] More...
Properties inherited from de::skycoder42::QtAutoUpdater::Quick::UpdaterComponent
Updater	updater
	The updater to be used by the component. More...
bool	useAsComponent
	Specifies if the consumer of the component expects an item or a component. More...
bool	loading
	Specifies if the component is currently beeing loaded. More...
var	goBackCallback
	Sets a callback to be called to close a created component. More...
Component	viewComponent
	[PRIVATE PROPERTY]

Additional Inherited Members
Signals inherited from de::skycoder42::QtAutoUpdater::Quick::UpdaterComponent
void	showComponent (Component component, var params)
	Gets emitted to show this component in the GUI. More...
void	showItem (Item item)
	Gets emitted to show this component in the GUI. More...

Detailed Description

A component that creates an update installation wizard.

Since

3.0

This class should be placed in your GUI as a view factory. It will emit the showItem() or showComponent() signals (depending on useAsComponent) and you have to catch this signal to actually show the created UI. The UI is a custom QQuickItem and must be shown as full screen view.

It is internally connected to the QtAutoUpdater::Updater::showInstaller() signal of the used updater and will automatically emit the signal as soon as a parallel internal installation was started via QtAutoUpdater::Updater::runUpdater().

The following example shows how to realize this with a StackView as view container:

StackView {
    id: stackView
    anchors.fill: parent  // parent should be the root window
    ...
}
 
UpdateInstallerComponent {
    id: component
    updater: QtAutoUpdater.createUpdater(...)
    useAsComponent: true
 
    goBackCallback: stackView.pop
    onShowItem: stackView.push(item)
}

See also

UpdaterComponent, UpdaterComponent::showItem,UpdaterComponent::showComponent, UpdaterComponent::useAsComponent, QtQuick.Controls.StackView, QtAutoUpdater::Updater::showInstaller, QtAutoUpdater::Updater::runUpdater, Image Page

Definition at line 39 of file UpdateInstallerComponent.qml.

Property Documentation

_connections

Connections de::skycoder42::QtAutoUpdater::Quick::UpdateInstallerComponent::_connections

[PRIVATE PROPERTY]

Remarks

This property is read-only

Definition at line 43 of file UpdateInstallerComponent.qml.

---

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

• UpdateInstallerComponent.qml