summaryrefslogtreecommitdiffstats
path: root/doc/scripting-api
diff options
context:
space:
mode:
authorKatja Marttila <[email protected]>2025-05-22 11:46:16 +0300
committerKatja Marttila <[email protected]>2025-05-27 15:51:10 +0300
commitf4ec5b8ef15b2574076b4f3d0dabb6e42d8bdb22 (patch)
tree316d9bc45bc861d69cbe7d5310e15af3daad8fd8 /doc/scripting-api
parentaf6aa8d69d2633196cbe1e08b0a1709087032619 (diff)
Add possibility to add warning labels from scriptHEADdev
Introducing new invokable methods, addWizardPageWarning() and removeWizardPageWarning() to add and remove warning messages to existing pages. Warning messages can be added also with existing addWizardPageItem() -function, but the new method utilizes the LabelWithPixmap -class, which draws a warning image and a label with text wrapped. Task-number: QTIFW-3555 Change-Id: Ie7867d369762f7616ce8c7ca47d102111d651da5 Reviewed-by: Arttu Tarkiainen <[email protected]>
Diffstat (limited to 'doc/scripting-api')
-rw-r--r--doc/scripting-api/packagemanagercore.qdoc29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc
index e24ee9f16..ad6fb53cd 100644
--- a/doc/scripting-api/packagemanagercore.qdoc
+++ b/doc/scripting-api/packagemanagercore.qdoc
@@ -557,6 +557,35 @@
*/
/*!
+ \qmlmethod boolean installer::addWizardPageWarning(string message,
+ int page, string id, int position)
+
+ Adds a warning label into the installer's GUI wizard. The label is added on
+ \a page ordered by \a position number. If several widgets are added to the same
+ page, the widget with lower \a position number will be inserted on top. The label
+ is identified with \a id.
+
+ See \l{Controller Scripting} for the possible values of \a page.
+
+ If the installation is not a command line install, returns \c true and emits the
+ wizardPageWarningInsertionRequested() signal.
+
+ \sa removeWizardPageWarning(), wizardPageWarningInsertionRequested()
+*/
+
+/*!
+ \fn boolean removeWizardPageWarning(string id)
+
+ Removes the widget with the identification \a id, previously added to the
+ installer's wizard by addWarningMessage().
+
+ If the installation is not a command line install, returns \c true and
+ emits the wizardPageWarningRemovalRequested() signal.
+
+ \sa addWizardPageWarning()
+*/
+
+/*!
\qmlmethod void installer::addUserRepositories(stringlist repositories)
Registers additional \a repositories.