Leena Miettinen f160b711fe Doc: move ScriptEngine scripting docs to separate files
Change-Id: Iac1c810cf52fb4a480ebde956d62830af97b6f8c
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
2015-03-06 08:32:02 +00:00

136 lines
3.2 KiB
Plaintext

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\qmltype gui
\inqmlmodule scripting
\brief Enables interaction with the installer UI.
*/
/*!
\qmlsignal gui::interrupted()
*/
/*!
\qmlsignal gui::languageChanged()
*/
/*!
\qmlsignal gui::finishButtonClicked()
*/
/*!
\qmlsignal gui::gotRestarted()
*/
/*!
\qmlsignal gui::settingsButtonClicked();
*/
/*!
\qmlmethod object gui::pageById(int id)
Returns the installer page specified by \a id. The values of \c id for the
available installer pages are provided by QInstaller::WizardPage.
*/
/*!
\qmlmethod object gui::pageByObjectName(string name)
Returns the installer page specified by \a name. The value of \c name is the
object name set in the UI file that defines the installer page.
*/
/*!
\qmlmethod object gui::currentPageWidget()
Returns the current wizard page.
*/
/*!
\qmlmethod object gui::pageWidgetByObjectName(string name)
*/
/*!
\qmlmethod string gui::defaultButtonText(int wizardButton)
*/
/*!
\qmlmethod void gui::clickButton(int wizardButton, int delayInMs)
Automatically clicks the button specified by \a wizardButton after a delay
in milliseconds specified by \a delayInMs.
*/
/*!
\qmlmethod boolean gui::isButtonEnabled(int wizardButton)
*/
/*!
\qmlmethod void gui::showSettingsButton(boolean show)
*/
/*!
\qmlmethod void gui::setSettingsButtonEnabled(boolean enable)
*/
/*!
\qmlmethod object gui::findChild(object parent, string objectName)
Returns the first descendant of \a parent that has \a objectName as name.
\sa QObject::findChild
*/
/*!
\qmlmethod object[] gui::findChildren(object parent, string objectName)
Returns all descendants of \a parent that have \a objectName as name.
\sa QObject::findChildren
*/
/*!
\qmlmethod void gui::cancelButtonClicked()
*/
/*!
\qmlmethod void gui::reject()
*/
/*!
\qmlmethod void gui::rejectWithoutPrompt()
*/
/*!
\qmlmethod void gui::showFinishedPage()
*/
/*!
\qmlmethod void gui::setModified(boolean value)
*/