diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2014-07-16 15:13:51 +0200 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@digia.com> | 2014-08-05 13:45:40 +0200 |
| commit | 8659dc846691e0fbef08a7ed1617f6b47289fb27 (patch) | |
| tree | 48757f23bff62974a6fc56865b9394115edb5f80 /src/dialogs/qquickdialog.cpp | |
| parent | 29f4ed3d6a50800ff0fb93c12451d7f962958a1e (diff) | |
Doc: Use \value command for documenting flags for QML properties
Replace the table structure with \value commands for documenting
acceptable values for Dialog::standardButtons and
MessageDialog::standardButtons properties, and remove the
unnecessary \enum definitions.
Task-number: QTBUG-35019
Change-Id: Ifcb9ae8b2fbe6859fae324d855a395e4d1d224c1
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
Diffstat (limited to 'src/dialogs/qquickdialog.cpp')
| -rw-r--r-- | src/dialogs/qquickdialog.cpp | 84 |
1 files changed, 55 insertions, 29 deletions
diff --git a/src/dialogs/qquickdialog.cpp b/src/dialogs/qquickdialog.cpp index 788c1e4c8..88f7776f2 100644 --- a/src/dialogs/qquickdialog.cpp +++ b/src/dialogs/qquickdialog.cpp @@ -416,14 +416,6 @@ void QQuickDialog::reject() { QQuickAbstractDialog::reject(); } -// TODO after QTBUG-35019 is fixed: fix links to this module's enums -// rather than linking to those in QMessageBox -/*! - \enum QQuickStandardButton::StandardButton - - This enum specifies a button with a standard label to be used on a dialog. -*/ - /*! \qmlproperty StandardButtons Dialog::standardButtons @@ -434,27 +426,61 @@ void QQuickDialog::reject() { property. You can control which buttons are available by setting standardButtons to a bitwise-or combination of the following flags: - \table - \row \li StandardButton.Ok \li An \gui OK button defined with the \l {QMessageBox::AcceptRole} {AcceptRole}. - \row \li StandardButton.Open \li An \gui Open button defined with the \l {QMessageBox::AcceptRole} {AcceptRole}. - \row \li StandardButton.Save \li A \gui Save button defined with the \l {QMessageBox::AcceptRole} {AcceptRole}. - \row \li StandardButton.Cancel \li A \gui Cancel button defined with the \l {QMessageBox::RejectRole} {RejectRole}. - \row \li StandardButton.Close \li A \gui Close button defined with the \l {QMessageBox::RejectRole} {RejectRole}. - \row \li StandardButton.Discard \li A \gui Discard or \gui {Don't Save} button, depending on the platform, - defined with the \l {QMessageBox::DestructiveRole} {DestructiveRole}. - \row \li StandardButton.Apply \li An \gui Apply button defined with the \l {QMessageBox::ApplyRole} {ApplyRole}. - \row \li StandardButton.Reset \li A \gui Reset button defined with the \l {QMessageBox::ResetRole} {ResetRole}. - \row \li StandardButton.RestoreDefaults \li A \gui {Restore Defaults} button defined with the \l {QMessageBox::ResetRole} {ResetRole}. - \row \li StandardButton.Help \li A \gui Help button defined with the \l {QMessageBox::HelpRole} {HelpRole}. - \row \li StandardButton.SaveAll \li A \gui {Save All} button defined with the \l {QMessageBox::AcceptRole} {AcceptRole}. - \row \li StandardButton.Yes \li A \gui Yes button defined with the \l {QMessageBox::YesRole} {YesRole}. - \row \li StandardButton.YesToAll \li A \gui {Yes to All} button defined with the \l {QMessageBox::YesRole} {YesRole}. - \row \li StandardButton.No \li A \gui No button defined with the \l {QMessageBox::NoRole} {NoRole}. - \row \li StandardButton.NoToAll \li A \gui {No to All} button defined with the \l {QMessageBox::NoRole} {NoRole}. - \row \li StandardButton.Abort \li An \gui Abort button defined with the \l {QMessageBox::RejectRole} {RejectRole}. - \row \li StandardButton.Retry \li A \gui Retry button defined with the \l {QMessageBox::AcceptRole} {AcceptRole}. - \row \li StandardButton.Ignore \li An \gui Ignore button defined with the \l {QMessageBox::AcceptRole} {AcceptRole}. - \endtable + \value StandardButton.Ok + An \gui OK button defined with the + \l {QMessageBox::}{AcceptRole}. + \value StandardButton.Open + An \gui Open button defined with the + \l {QMessageBox::}{AcceptRole}. + \value StandardButton.Save + A \gui Save button defined with the + \l {QMessageBox::}{AcceptRole}. + \value StandardButton.Cancel + A \gui Cancel button defined with the + \l {QMessageBox::}{RejectRole}. + \value StandardButton.Close + A \gui Close button defined with the + \l {QMessageBox::}{RejectRole}. + \value StandardButton.Discard + A \gui Discard or \gui {Don't Save} button, + depending on the platform, defined with the + \l {QMessageBox::}{DestructiveRole}. + \value StandardButton.Apply + An \gui Apply button defined with the + \l {QMessageBox::}{ApplyRole}. + \value StandardButton.Reset + A \gui Reset button defined with the + \l {QMessageBox::}{ResetRole}. + \value StandardButton.RestoreDefaults + A \gui {Restore Defaults} button defined with the + \l {QMessageBox::}{ResetRole}. + \value StandardButton.Help + A \gui Help button defined with the + \l {QMessageBox::}{HelpRole}. + \value StandardButton.SaveAll + A \gui {Save All} button defined with the + \l {QMessageBox::}{AcceptRole}. + \value StandardButton.Yes + A \gui Yes button defined with the + \l {QMessageBox::}{YesRole}. + \value StandardButton.YesToAll + A \gui {Yes to All} button defined with the + \l {QMessageBox::}{YesRole}. + \value StandardButton.No + A \gui No button defined with the + \l {QMessageBox::}{NoRole}. + \value StandardButton.NoToAll + A \gui {No to All} button defined with the + \l {QMessageBox::}{NoRole}. + \value StandardButton.Abort + An \gui Abort button defined with the + \l {QMessageBox::}{RejectRole}. + \value StandardButton.Retry + A \gui Retry button defined with the + \l {QMessageBox::}{AcceptRole}. + \value StandardButton.Ignore + An \gui Ignore button defined with the + \l {QMessageBox::}{AcceptRole}. For example the following dialog will show a calendar with the ability to save or cancel a date: |