summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2014-03-15 10:43:35 +0800
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-18 12:51:26 +0100
commit6c734a234e7460108c99c2485ac1f80d8a112f29 (patch)
tree3627272ff22bc0d221e8c304ad411489ec5efe7c
parentb756900bb236190cc23f8cade2bf7440e5235ba4 (diff)
downloadqtquickcontrols-6c734a234e7460108c99c2485ac1f80d8a112f29.tar.gz
Doc: Append handler names to \qmlsignal documentation
Change-Id: I5e06bdf03ba1ba8e5fe7669f690420dc9a039129 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r--src/controls/Calendar.qml10
-rw-r--r--src/controls/ComboBox.qml4
-rw-r--r--src/controls/SpinBox.qml2
-rw-r--r--src/controls/TableView.qml6
-rw-r--r--src/controls/TextArea.qml4
-rw-r--r--src/controls/TextField.qml4
-rw-r--r--src/controls/qquickaction.cpp4
-rw-r--r--src/controls/qquickmenuitem.cpp4
-rw-r--r--src/dialogs/qquickcolordialog.cpp4
-rw-r--r--src/dialogs/qquickdialog.cpp4
-rw-r--r--src/dialogs/qquickfiledialog.cpp4
-rw-r--r--src/dialogs/qquickfontdialog.cpp4
-rw-r--r--src/dialogs/qquickmessagedialog.cpp4
-rw-r--r--src/dialogs/qquickplatformcolordialog.cpp4
-rw-r--r--src/dialogs/qquickplatformfiledialog.cpp4
-rw-r--r--src/dialogs/qquickplatformfontdialog.cpp4
-rw-r--r--src/dialogs/qquickplatformmessagedialog.cpp16
-rw-r--r--src/widgets/qquickqcolordialog.cpp4
-rw-r--r--src/widgets/qquickqfiledialog.cpp4
-rw-r--r--src/widgets/qquickqfontdialog.cpp4
-rw-r--r--src/widgets/qquickqmessagebox.cpp4
21 files changed, 102 insertions, 0 deletions
diff --git a/src/controls/Calendar.qml b/src/controls/Calendar.qml
index 1fa5d72d..5b56dc76 100644
--- a/src/controls/Calendar.qml
+++ b/src/controls/Calendar.qml
@@ -217,6 +217,8 @@ Control {
Emitted when the mouse hovers over a valid date in the calendar.
\a date is the date that was hovered over.
+
+ The corresponding handler is \c onHovered.
*/
signal hovered(date date)
@@ -228,6 +230,8 @@ Control {
This is also emitted when dragging the mouse to another date while it is pressed.
\a date is the date that the mouse was pressed on.
+
+ The corresponding handler is \c onPressed.
*/
signal pressed(date date)
@@ -237,6 +241,8 @@ Control {
Emitted when the mouse is released over a valid date in the calendar.
\a date is the date that the mouse was released over.
+
+ The corresponding handler is \c onReleased.
*/
signal released(date date)
@@ -246,6 +252,8 @@ Control {
Emitted when the mouse is clicked on a valid date in the calendar.
\a date is the date that the mouse was clicked on.
+
+ The corresponding handler is \c onClicked.
*/
signal clicked(date date)
@@ -255,6 +263,8 @@ Control {
Emitted when the mouse is double-clicked on a valid date in the calendar.
\a date is the date that the mouse was double-clicked on.
+
+ The corresponding handler is \c onDoubleClicked.
*/
signal doubleClicked(date date)
diff --git a/src/controls/ComboBox.qml b/src/controls/ComboBox.qml
index f3cde537..5ce5bf07 100644
--- a/src/controls/ComboBox.qml
+++ b/src/controls/ComboBox.qml
@@ -245,6 +245,8 @@ Control {
\note If there is a \l validator set on the combobox,
the signal will only be emitted if the input is in an acceptable state.
+
+ The corresponding handler is \c onAccepted.
*/
signal accepted
@@ -257,6 +259,8 @@ Control {
This signal is similar to currentIndex changed, but will only
be emitted if the combo box index was changed by the user and not
when set programatically.
+
+ The corresponding handler is \c onActivated.
*/
signal activated(int index)
diff --git a/src/controls/SpinBox.qml b/src/controls/SpinBox.qml
index f235dfbd..826d9002 100644
--- a/src/controls/SpinBox.qml
+++ b/src/controls/SpinBox.qml
@@ -172,6 +172,8 @@ Control {
the control loses focus. Note that if there is a validator
set on the control and enter/return is pressed, this signal will
only be emitted if the validator returns an acceptable state.
+
+ The corresponding handler is \c onEditingFinished.
*/
signal editingFinished()
diff --git a/src/controls/TableView.qml b/src/controls/TableView.qml
index 1ca45a7f..3eb73cf6 100644
--- a/src/controls/TableView.qml
+++ b/src/controls/TableView.qml
@@ -255,6 +255,8 @@ ScrollView {
\a row int provides access to the activated row index.
\note This signal is only emitted for mouse interaction that is not blocked in the row or item delegate.
+
+ The corresponding handler is \c onActivated.
*/
signal activated(int row)
@@ -265,6 +267,8 @@ ScrollView {
\a row int provides access to the clicked row index.
\note This signal is only emitted if the row or item delegate does not accept mouse events.
+
+ The corresponding handler is \c onClicked.
*/
signal clicked(int row)
@@ -275,6 +279,8 @@ ScrollView {
\a row int provides access to the clicked row index.
\note This signal is only emitted if the row or item delegate does not accept mouse events.
+
+ The corresponding handler is \c onDoubleClicked.
*/
signal doubleClicked(int row)
diff --git a/src/controls/TextArea.qml b/src/controls/TextArea.qml
index 751e7ce0..876a2270 100644
--- a/src/controls/TextArea.qml
+++ b/src/controls/TextArea.qml
@@ -383,6 +383,8 @@ ScrollView {
This signal is emitted when the user clicks on a link embedded in the text.
The link must be in rich text or HTML format and the
\a link string provides access to the particular link.
+
+ The corresponding handler is \c onLinkActivated.
*/
signal linkActivated(string link)
@@ -395,6 +397,8 @@ ScrollView {
\a link string provides access to the particular link.
\sa hoveredLink
+
+ The corresponding handler is \c onLinkHovered.
*/
signal linkHovered(string link)
diff --git a/src/controls/TextField.qml b/src/controls/TextField.qml
index 3d11fc2e..7217caa2 100644
--- a/src/controls/TextField.qml
+++ b/src/controls/TextField.qml
@@ -401,6 +401,8 @@ Control {
Note that if there is a \l validator or \l inputMask set on the text
field, the signal will only be emitted if the input is in an acceptable
state.
+
+ The corresponding handler is \c onAccepted.
*/
signal accepted()
@@ -413,6 +415,8 @@ Control {
inputMask set on the text field and enter/return is pressed, this
signal will only be emitted if the input follows
the inputMask and the validator returns an acceptable state.
+
+ The corresponding handler is \c onEditingFinished.
*/
signal editingFinished()
diff --git a/src/controls/qquickaction.cpp b/src/controls/qquickaction.cpp
index 3c4bfed6..541e9a5d 100644
--- a/src/controls/qquickaction.cpp
+++ b/src/controls/qquickaction.cpp
@@ -178,6 +178,8 @@ QT_BEGIN_NAMESPACE
Emitted when either the menu item or its bound action have been activated. Includes
the object that triggered the event if relevant (e.g. a Button or MenuItem).
You shouldn't need to emit this signal, use \l trigger() instead.
+
+ The corresponding handler is \c onTriggered.
*/
/*! \qmlmethod Action::trigger(QObject *source)
@@ -191,6 +193,8 @@ QT_BEGIN_NAMESPACE
Emitted whenever a action's \l checked property changes.
This usually happens at the same time as \l triggered.
+
+ The corresponding handler is \c onToggled.
*/
QQuickAction::QQuickAction(QObject *parent)
diff --git a/src/controls/qquickmenuitem.cpp b/src/controls/qquickmenuitem.cpp
index 1788f423..60e06495 100644
--- a/src/controls/qquickmenuitem.cpp
+++ b/src/controls/qquickmenuitem.cpp
@@ -342,6 +342,8 @@ void QQuickMenuText::updateIcon()
Emitted when either the menu item or its bound action have been activated.
\sa trigger(), Action::triggered, Action::toggled
+
+ The corresponding handler is \c onTriggered.
*/
/*! \qmlmethod MenuItem::trigger()
@@ -404,6 +406,8 @@ void QQuickMenuText::updateIcon()
This usually happens at the same time as \l triggered.
\sa checked, triggered, Action::triggered, Action::toggled
+
+ The corresponding handler is \c onToggled.
*/
/*!
diff --git a/src/dialogs/qquickcolordialog.cpp b/src/dialogs/qquickcolordialog.cpp
index 58e35720..48935767 100644
--- a/src/dialogs/qquickcolordialog.cpp
+++ b/src/dialogs/qquickcolordialog.cpp
@@ -65,12 +65,16 @@ QT_BEGIN_NAMESPACE
\qmlsignal QtQuick::Dialogs::AbstractColorDialog::accepted
This signal is emitted by \l accept().
+
+ The corresponding handler is \c onAccepted.
*/
/*!
\qmlsignal QtQuick::Dialogs::AbstractColorDialog::rejected
This signal is emitted by \l reject().
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/dialogs/qquickdialog.cpp b/src/dialogs/qquickdialog.cpp
index e7660c53..9e726ccd 100644
--- a/src/dialogs/qquickdialog.cpp
+++ b/src/dialogs/qquickdialog.cpp
@@ -64,12 +64,16 @@ QT_BEGIN_NAMESPACE
\qmlsignal QtQuick::Dialogs::Dialog::accepted
This signal is emitted by \l accept().
+
+ The corresponding handler is \c onAccepted.
*/
/*!
\qmlsignal QtQuick::Dialogs::Dialog::rejected
This signal is emitted by \l reject().
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/dialogs/qquickfiledialog.cpp b/src/dialogs/qquickfiledialog.cpp
index 68beca28..4704b5b8 100644
--- a/src/dialogs/qquickfiledialog.cpp
+++ b/src/dialogs/qquickfiledialog.cpp
@@ -69,12 +69,16 @@ using namespace QV4;
\qmlsignal QtQuick::Dialogs::AbstractFileDialog::accepted
This signal is emitted by \l accept().
+
+ The corresponding handler is \c onAccepted.
*/
/*!
\qmlsignal QtQuick::Dialogs::AbstractFileDialog::rejected
This signal is emitted by \l reject().
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/dialogs/qquickfontdialog.cpp b/src/dialogs/qquickfontdialog.cpp
index d17ce986..802ab33c 100644
--- a/src/dialogs/qquickfontdialog.cpp
+++ b/src/dialogs/qquickfontdialog.cpp
@@ -66,12 +66,16 @@ QT_BEGIN_NAMESPACE
\qmlsignal QtQuick::Dialogs::AbstractFontDialog::accepted
The \a accepted signal is emitted by \l accept().
+
+ The corresponding handler is \c onAccepted.
*/
/*!
\qmlsignal QtQuick::Dialogs::AbstractFontDialog::rejected
The \a accepted signal is emitted by \l reject().
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/dialogs/qquickmessagedialog.cpp b/src/dialogs/qquickmessagedialog.cpp
index 43b6ca09..f5ff79af 100644
--- a/src/dialogs/qquickmessagedialog.cpp
+++ b/src/dialogs/qquickmessagedialog.cpp
@@ -65,12 +65,16 @@ QT_BEGIN_NAMESPACE
\qmlsignal QtQuick::Dialogs::AbstractMessageDialog::accepted
This signal is emitted by \l accept().
+
+ The corresponding handler is \c onAccepted.
*/
/*!
\qmlsignal QtQuick::Dialogs::AbstractMessageDialog::rejected
This signal is emitted by \l reject().
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/dialogs/qquickplatformcolordialog.cpp b/src/dialogs/qquickplatformcolordialog.cpp
index e8f523c4..9e4083c8 100644
--- a/src/dialogs/qquickplatformcolordialog.cpp
+++ b/src/dialogs/qquickplatformcolordialog.cpp
@@ -112,6 +112,8 @@ QT_BEGIN_NAMESPACE
onAccepted: { console.log("Selected color: " + color) }
}
\endqml
+
+ The corresponding handler is \c onAccepted.
*/
/*!
@@ -119,6 +121,8 @@ QT_BEGIN_NAMESPACE
This signal is emitted when the user has dismissed the dialog,
either by closing the dialog window or by pressing the Cancel button.
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/dialogs/qquickplatformfiledialog.cpp b/src/dialogs/qquickplatformfiledialog.cpp
index 93b6b534..99bfc392 100644
--- a/src/dialogs/qquickplatformfiledialog.cpp
+++ b/src/dialogs/qquickplatformfiledialog.cpp
@@ -114,6 +114,8 @@ QT_BEGIN_NAMESPACE
onAccepted: { console.log("Selected file: " + fileUrl) }
}
\endqml
+
+ The corresponding handler is \c onAccepted.
*/
/*!
@@ -121,6 +123,8 @@ QT_BEGIN_NAMESPACE
This signal is emitted when the user has dismissed the dialog,
either by closing the dialog window or by pressing the Cancel button.
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/dialogs/qquickplatformfontdialog.cpp b/src/dialogs/qquickplatformfontdialog.cpp
index 961d776d..04650a71 100644
--- a/src/dialogs/qquickplatformfontdialog.cpp
+++ b/src/dialogs/qquickplatformfontdialog.cpp
@@ -114,6 +114,8 @@ QT_BEGIN_NAMESPACE
onAccepted: { console.log("Selected font: " + font) }
}
\endqml
+
+ The corresponding handler is \c onAccepted.
*/
/*!
@@ -121,6 +123,8 @@ QT_BEGIN_NAMESPACE
The \a rejected signal is emitted when the user has dismissed the dialog,
either by closing the dialog window or by pressing the Cancel button.
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/dialogs/qquickplatformmessagedialog.cpp b/src/dialogs/qquickplatformmessagedialog.cpp
index 625f3899..42c32dcf 100644
--- a/src/dialogs/qquickplatformmessagedialog.cpp
+++ b/src/dialogs/qquickplatformmessagedialog.cpp
@@ -108,6 +108,8 @@ QT_BEGIN_NAMESPACE
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.
+
+ The corresponding handler is \c onAccepted.
*/
/*!
@@ -116,12 +118,16 @@ QT_BEGIN_NAMESPACE
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.
*/
/*!
\qmlsignal MessageDialog::discard()
This signal is emitted when the user has pressed the \gui Discard button.
+
+ The corresponding handler is \c onDiscard.
*/
/*!
@@ -134,6 +140,8 @@ QT_BEGIN_NAMESPACE
decision. However on other platforms it's not possible to show a dialog and
a help window at the same time. If you want to be sure that the dialog will
close, you can set \l visible to \c false in your handler.
+
+ The corresponding handler is \c onHelp.
*/
/*!
@@ -141,6 +149,8 @@ QT_BEGIN_NAMESPACE
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}.
+
+ The corresponding handler is \c onYes.
*/
/*!
@@ -148,12 +158,16 @@ QT_BEGIN_NAMESPACE
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}.
+
+ The corresponding handler is \c onNo.
*/
/*!
\qmlsignal MessageDialog::apply()
This signal is emitted when the user has pressed the \gui Apply button.
+
+ The corresponding handler is \c onApply.
*/
/*!
@@ -161,6 +175,8 @@ QT_BEGIN_NAMESPACE
This signal is emitted when the user has pressed any button which has
the \l {QMessageBox::ResetRole} {ResetRole}: \gui Reset or \gui {Restore Defaults}.
+
+ The corresponding handler is \c onReset.
*/
/*!
diff --git a/src/widgets/qquickqcolordialog.cpp b/src/widgets/qquickqcolordialog.cpp
index aa88aaeb..4359bc6d 100644
--- a/src/widgets/qquickqcolordialog.cpp
+++ b/src/widgets/qquickqcolordialog.cpp
@@ -118,6 +118,8 @@ private:
onAccepted: { console.log("Selected color: " + color) }
}
\endqml
+
+ The corresponding handler is \c onAccepted.
*/
/*!
@@ -125,6 +127,8 @@ private:
The \a rejected signal is emitted when the user has dismissed the dialog,
either by closing the dialog window or by pressing the Cancel button.
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/widgets/qquickqfiledialog.cpp b/src/widgets/qquickqfiledialog.cpp
index 9dc967dd..b37ec769 100644
--- a/src/widgets/qquickqfiledialog.cpp
+++ b/src/widgets/qquickqfiledialog.cpp
@@ -83,6 +83,8 @@ QT_BEGIN_NAMESPACE
onAccepted: { console.log("Selected file: " + fileUrl) }
}
\endqml
+
+ The corresponding handler is \c onAccepted.
*/
/*!
@@ -90,6 +92,8 @@ QT_BEGIN_NAMESPACE
The \a rejected signal is emitted when the user has dismissed the dialog,
either by closing the dialog window or by pressing the Cancel button.
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/widgets/qquickqfontdialog.cpp b/src/widgets/qquickqfontdialog.cpp
index 6936aff7..bc889e07 100644
--- a/src/widgets/qquickqfontdialog.cpp
+++ b/src/widgets/qquickqfontdialog.cpp
@@ -121,6 +121,8 @@ private:
onAccepted: { console.log("Selected file: " + filePath) }
}
\endqml
+
+ The corresponding handler is \c onAccepted.
*/
/*!
@@ -128,6 +130,8 @@ private:
The \a rejected signal is emitted when the user has dismissed the dialog,
either by closing the dialog window or by pressing the Cancel button.
+
+ The corresponding handler is \c onRejected.
*/
/*!
diff --git a/src/widgets/qquickqmessagebox.cpp b/src/widgets/qquickqmessagebox.cpp
index 5d62bee6..c959fd74 100644
--- a/src/widgets/qquickqmessagebox.cpp
+++ b/src/widgets/qquickqmessagebox.cpp
@@ -84,6 +84,8 @@ QT_BEGIN_NAMESPACE
onAccepted: { console.log("accepted") }
}
\endqml
+
+ The corresponding handler is \c onAccepted.
*/
/*!
@@ -91,6 +93,8 @@ QT_BEGIN_NAMESPACE
The \a rejected signal is emitted when the user has dismissed the dialog,
either by closing the dialog window or by pressing the Cancel button.
+
+ The corresponding handler is \c onRejected.
*/
/*!