diff options
author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-03-02 13:59:10 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-03-05 11:53:28 +0000 |
commit | 6afc9b2a2d892e676104371fbeabccbd76b6ede3 (patch) | |
tree | 45d2436b75be12e50fe64e6c8b8866123a65dbab /doc/messageboxhandler.qdoc | |
parent | f31ffa0bc120d4d7e0a10402b71288f5eabdef74 (diff) |
Docs: edit MessageBoxHandler docs
Move scripting docs to another file and add C++ docs.
Edit the C++ docs for grammar and style.
Change-Id: I2494c573662687cd107916c06e24b0f528596a7e
Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
Diffstat (limited to 'doc/messageboxhandler.qdoc')
-rw-r--r-- | doc/messageboxhandler.qdoc | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/doc/messageboxhandler.qdoc b/doc/messageboxhandler.qdoc new file mode 100644 index 000000000..f3660c958 --- /dev/null +++ b/doc/messageboxhandler.qdoc @@ -0,0 +1,104 @@ +/**************************************************************************** +** +** 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 QMessageBox + \inqmlmodule scripting + + \brief Provides a modal dialog for informing the user or asking the user + a question and receiving an answer. + + + \code + var result = QMessageBox.question("quit.question", "Installer", "Do you want to quit the installer?", + QMessageBox.Yes | QMessageBox.No); + if (result == QMessageBox.Yes) { + // ... + } + \endcode + + \section2 Buttons in Message Boxes + + QMessageBox defines a list of common buttons: + \list + \li QMessageBox.Ok + \li QMessageBox.Open + \li QMessageBox.Save + \li QMessageBox.Cancel + \li QMessageBox.Close + \li QMessageBox.Discard + \li QMessageBox.Apply + \li QMessageBox.Reset + \li QMessageBox.RestoreDefaults + \li QMessageBox.Help + \li QMessageBox.SaveAll + \li QMessageBox.Yes + \li QMessageBox.YesToAll + \li QMessageBox.No + \li QMessageBox.NoToAll + \li QMessageBox.Abort + \li QMessageBox.Retry + \li QMessageBox.Ignore + \li QMessageBox.NoButton + \endlist + + \section2 Scripted Installations + + Sometimes it is useful to automatically close message boxes, for example during a scripted + installation. This can be achieved by calling installer::setMessageBoxAutomaticAnswer, + installer::autoAcceptMessageBoxes or installer::autoRejectMessageBoxes. The \c identifier + argument in the method calls allows to identify specific message boxes for this purpose. +*/ + + +/*! + \qmlmethod Button QMessageBox::critical(string identifier, string title, string text, + Buttons buttons = QMessageBox.Ok, Button button = QMessageBox.NoButton) + + Opens a critical message box with the given \a title and \a text. +*/ + +/*! + \qmlmethod Button QMessageBox::information(string identifier, string title, string text, + Buttons buttons = QMessageBox.Ok, Button button = QMessageBox.NoButton) + + Opens an information message box with the given \a title and \a text. +*/ + +/*! + \qmlmethod Button QMessageBox::question(string identifier, string title, string text, + Buttons buttons = QMessageBox.Yes | QMessageBox.No, Button button = QMessageBox.NoButton) + + Opens a question message box with the given \a title and \a text. +*/ + +/*! + \qmlmethod Button QMessageBox::warning(string identifier, string title, string text, + Buttons buttons = QMessageBox.Ok, Button button = QMessageBox.NoButton) + + Opens a warning message box with the given \a title and \a text. +*/ |