summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorArttu Tarkiainen <arttu.tarkiainen@qt.io>2020-05-08 16:38:15 +0300
committerArttu Tarkiainen <arttu.tarkiainen@qt.io>2020-06-11 12:19:06 +0300
commitf6565bdc455d7b3a10941c29d780b58fc1305ef2 (patch)
treea9b11b7ba52e29ad845533303c85b4f69113ed92 /doc
parentfc973b4c0b1b4e30ff69564565fd30e5ac18524a (diff)
Add a page list widget to installer wizard
If an installer is configured with <WizardShowPageList> set to true (default), a QListWidget set as a side widget for the wizard will be shown. The list should indicate completed and incomplete pages and the current wizard page. User navigation is not enabled in this change. The page list should honor the visibility of individual pages and update itself dynamically. In addition the visibility of a page in page list widget can be set internally with setShowOnPageList() which overrides other factors when hiding a page. The page item title shown on the list can be set internally with setPageListTitle() for the PackageManagerPage object, or the item can alternatively use the normal page title and the object name. Task-number: QTIFW-1755 Change-Id: I8a792d957a10e2176de5f42f29b1282e8e7667db Reviewed-by: Katja Marttila <katja.marttila@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/installerfw.qdoc10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc
index 0a6c7bfe4..22dc89d40 100644
--- a/doc/installerfw.qdoc
+++ b/doc/installerfw.qdoc
@@ -206,13 +206,15 @@
\li Filename for a logo used as \c QWizard::LogoPixmap.
\row
\li Watermark
- \li Filename for a watermark used as \c QWizard::WatermarkPixmap.
+ \li Filename for a watermark used as \c QWizard::WatermarkPixmap. If
+ \c <WizardShowPageList> is set to \c true, the watermark is hidden.
\row
\li Banner
\li Filename for a banner used as \c QWizard::BannerPixmap (only used by ModernStyle).
\row
\li Background
\li Filename for an image used as \c QWizard::BackgroundPixmap (only used by MacStyle).
+ If \c <WizardShowPageList> is set to \c true, the background is hidden.
\row
\li WizardStyle
\li Set the wizard style to be used ("Modern", "Mac", "Aero" or "Classic").
@@ -230,6 +232,12 @@
override this. You can add the \c em or \c ex suffix to the specified value to
use the \e em or \e ex unit, as in a CSS file.
\row
+ \li WizardShowPageList
+ \li Set to \c false if the widget listing installer pages on the left side of the
+ wizard should not be shown. Defaults to \c true. If visible, this widget hides
+ \c QWizard::WatermarkPixmap on \c QWizard::ClassicStyle and \c QWizard::ModernStyle,
+ and \c QWizard::BackgroundPixmap on \c QWizard::MacStyle.
+ \row
\li TitleColor
\li Set the color of the titles and subtitles (takes an HTML color code,
such as "#88FF33").