diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2014-08-05 11:38:45 +0200 |
|---|---|---|
| committer | Shawn Rutledge <shawn.rutledge@digia.com> | 2014-10-06 13:45:38 +0200 |
| commit | fa9883f47e61d11ca4e208174ec49d01ee683b98 (patch) | |
| tree | 805d94571895aba95821def1f23b6ed6da29c723 /src/dialogs/qquickdialog.cpp | |
| parent | 4a9cd455fae9b2b0e473d3ddf58e664818feb545 (diff) | |
Doc: Fix documentation issues for Qt Quick Dialogs
- Document clickedButton property for Dialog, MessageDialog
- Update Dialog::accepted() and rejected() documentation
- Remove duplicate documentation for Dialog::visible property
- Update description of modality property for ColorDialog,
FontDialog
- Fix broken links
Change-Id: I5b73ea5cbccf1ad0203351730197336e1c6e1b98
Reviewed-by: Liang Qi <liang.qi@digia.com>
Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
Diffstat (limited to 'src/dialogs/qquickdialog.cpp')
| -rw-r--r-- | src/dialogs/qquickdialog.cpp | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/src/dialogs/qquickdialog.cpp b/src/dialogs/qquickdialog.cpp index ebe2c7b01..ab3d9200f 100644 --- a/src/dialogs/qquickdialog.cpp +++ b/src/dialogs/qquickdialog.cpp @@ -73,7 +73,9 @@ QT_BEGIN_NAMESPACE /*! \qmlsignal Dialog::accepted() - This signal is emitted by \l accept(). + This signal is emitted when the user has pressed any button which has the + \l {QMessageBox::}{AcceptRole}: \gui OK, \gui Open, \gui Save, + \gui {Save All}, \gui Retry or \gui Ignore. The corresponding handler is \c onAccepted. */ @@ -81,7 +83,9 @@ QT_BEGIN_NAMESPACE /*! \qmlsignal Dialog::rejected() - This signal is emitted by \l reject(). + This signal is emitted when the user has dismissed the dialog, by closing + the dialog window, by pressing a \gui Cancel, \gui Close or \gui Abort + button on the dialog, or by pressing the back button or the escape key. The corresponding handler is \c onRejected. */ @@ -152,6 +156,12 @@ QT_BEGIN_NAMESPACE \sa modality */ +/*! \qmlproperty StandardButton Dialog::clickedButton + + This property holds the button pressed by the user. Its value is + one of the flags set for the standardButtons property. +*/ + /*! \qmlproperty Qt::WindowModality Dialog::modality @@ -294,12 +304,6 @@ void QQuickDialog::setStandardButtons(StandardButtons buttons) } /*! - \qmlproperty bool Dialog::visible - - This property holds whether the dialog is visible. By default this is false. -*/ - -/*! \qmlproperty QObject Dialog::contentItem The QML object which implements the dialog contents. Should be an \l Item. |