summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2014-03-15 09:54:03 +0800
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-18 01:18:52 +0100
commit6aba49f84a17bad51f83968a03e5e9a58de726c6 (patch)
treeacffe7235d4ccd175f806f09af97deafa445c8e1
parent337d611886cd4930febf02142f91a6ef3d2d0c61 (diff)
downloadqtquickcontrols-6aba49f84a17bad51f83968a03e5e9a58de726c6.tar.gz
Doc: Document signals (not handlers) under \qmlsignal
Task-number: QTBUG-35846 Change-Id: I358c3427429b669425f0065686da7e202568c84d Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
-rw-r--r--src/dialogs/qquickplatformcolordialog.cpp4
-rw-r--r--src/dialogs/qquickplatformfiledialog.cpp4
-rw-r--r--src/dialogs/qquickplatformmessagedialog.cpp16
3 files changed, 12 insertions, 12 deletions
diff --git a/src/dialogs/qquickplatformcolordialog.cpp b/src/dialogs/qquickplatformcolordialog.cpp
index 11ddbfe6..e8f523c4 100644
--- a/src/dialogs/qquickplatformcolordialog.cpp
+++ b/src/dialogs/qquickplatformcolordialog.cpp
@@ -102,7 +102,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal QtQuick::Dialogs::ColorDialog::accepted
- This handler is called when the user has finished using the
+ This signal is emitted when the user has finished using the
dialog. You can then inspect the \l color property to get the selection.
Example:
@@ -117,7 +117,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal QtQuick::Dialogs::ColorDialog::rejected
- This handler is called when the user has dismissed the dialog,
+ This signal is emitted when the user has dismissed the dialog,
either by closing the dialog window or by pressing the Cancel button.
*/
diff --git a/src/dialogs/qquickplatformfiledialog.cpp b/src/dialogs/qquickplatformfiledialog.cpp
index 066aabe3..93b6b534 100644
--- a/src/dialogs/qquickplatformfiledialog.cpp
+++ b/src/dialogs/qquickplatformfiledialog.cpp
@@ -103,7 +103,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal QtQuick::Dialogs::FileDialog::accepted
- This handler is called when the user has finished using the
+ This signal is emitted when the user has finished using the
dialog. You can then inspect the \l fileUrl or \l fileUrls properties to
get the selection.
@@ -119,7 +119,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal QtQuick::Dialogs::FileDialog::rejected
- This handler is called when the user has dismissed the dialog,
+ This signal is emitted when the user has dismissed the dialog,
either by closing the dialog window or by pressing the Cancel button.
*/
diff --git a/src/dialogs/qquickplatformmessagedialog.cpp b/src/dialogs/qquickplatformmessagedialog.cpp
index 53d209ca..625f3899 100644
--- a/src/dialogs/qquickplatformmessagedialog.cpp
+++ b/src/dialogs/qquickplatformmessagedialog.cpp
@@ -105,7 +105,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal MessageDialog::accepted()
- This handler is called when the user has pressed any button which has the
+ This signal is emitted when the user has pressed any button which has the
\l {QMessageBox::AcceptRole} {AcceptRole}: \gui OK, \gui Open, \gui Save,
\gui {Save All}, \gui Retry or \gui Ignore.
*/
@@ -113,7 +113,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal MessageDialog::rejected()
- This handler is called when the user has dismissed the dialog, by closing
+ 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.
*/
@@ -121,13 +121,13 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal MessageDialog::discard()
- This handler is called when the user has pressed the \gui Discard button.
+ This signal is emitted when the user has pressed the \gui Discard button.
*/
/*!
\qmlsignal MessageDialog::help()
- This handler is called when the user has pressed the \gui Help button.
+ This signal is emitted when the user has pressed the \gui Help button.
Depending on platform, the dialog may not be automatically dismissed
because the help that your application provides may need to be relevant to
the text shown in this dialog in order to assist the user in making a
@@ -139,27 +139,27 @@ QT_BEGIN_NAMESPACE
/*!
\qmlsignal MessageDialog::yes()
- This handler is called when the user has pressed any button which has
+ This signal is emitted when the user has pressed any button which has
the \l {QMessageBox::YesRole} {YesRole}: \gui Yes or \gui {Yes to All}.
*/
/*!
\qmlsignal MessageDialog::no()
- This handler is called when the user has pressed any button which has
+ This signal is emitted when the user has pressed any button which has
the \l {QMessageBox::NoRole} {NoRole}: \gui No or \gui {No to All}.
*/
/*!
\qmlsignal MessageDialog::apply()
- This handler is called when the user has pressed the \gui Apply button.
+ This signal is emitted when the user has pressed the \gui Apply button.
*/
/*!
\qmlsignal MessageDialog::reset()
- This handler is called when the user has pressed any button which has
+ This signal is emitted when the user has pressed any button which has
the \l {QMessageBox::ResetRole} {ResetRole}: \gui Reset or \gui {Restore Defaults}.
*/