diff options
Diffstat (limited to 'doc/noninteractive.qdoc')
| -rw-r--r-- | doc/noninteractive.qdoc | 29 |
1 files changed, 22 insertions, 7 deletions
diff --git a/doc/noninteractive.qdoc b/doc/noninteractive.qdoc index 2b5f9b964..d22a17800 100644 --- a/doc/noninteractive.qdoc +++ b/doc/noninteractive.qdoc @@ -80,6 +80,21 @@ For more information about the JavaScript global objects that you can use in control scripts, see \l{Scripting API}. + In addition to the predefined global objects, the scripting API supports working + with other objects derived from \c QObject. In the above code example the + \c{gui.currentPageWidget()} method returns a widget of type \c QWidget. + + The scripting API makes use of Qt's object trees. Widgets derived from \c QObject export + their named child objects as properties for the JavaScript object, where the name of the + property is the same as the child object's \c{QObject::objectName}. The default properties + and their access functions of objects derived from \c QObject can also be used in the scripts. + + For example, in the above code the \c MessageLabel object from class \c QLabel is a child + of the \c widget. The \c setText() is the setter access function for its \c QLabel::text property. + + In addition to properties, the signals and public slots of objects derived from \c QObject + can be used in both controller and component scripts. + \section1 Predefined Installer Pages The QInstaller JavaScript object provides access to the following predefined @@ -126,7 +141,7 @@ \row \li \c MessageLabel \li Displays a message. By default, it displays the - "Welcome to the \l{ProductNameTarget}{<Name>} Setup Wizard" message. + "Welcome to the \l{ProductNameTarget}{<Name>} Setup" message. \row \li \c InformationLabel @@ -140,15 +155,15 @@ \row \li \c PackageManagerRadioButton - \li The package manager radio button shown on the page while running as maintenance tool. + \li The package manager radio button shown on the page while running as \MT. \row \li \c UpdaterRadioButton - \li The updater radio button shown on the page while running as maintenance tool. + \li The updater radio button shown on the page while running as \MT. \row \li \c UninstallerRadioButton - \li The uninstaller radio button shown on the page while running as maintenance tool. + \li The uninstaller radio button shown on the page while running as \MT. Selected by default. \endtable @@ -169,10 +184,10 @@ \row \li \c packageManagerCoreTypeChanged() - \li Connect to this signal if you want to be notified when the type of maintenance tool + \li Connect to this signal if you want to be notified when the type of \MT changes. \note The signal is only emitted when the user has started the binary as so called - maintenance tool (after the installation) and switches between the radio buttons. + \MT (after the installation) and switches between the radio buttons. \endtable Example code: @@ -552,7 +567,7 @@ \row \li \c WriteError \li OK - \li An error occurred while writing the maintenance tool. + \li An error occurred while writing the \MT. \row \li \c ElevationError |