aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2014-03-14 23:41:01 +0800
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-18 13:17:42 +0100
commit303db2e8a19ea1f2c1b8d5dc59e2754b0d03bd61 (patch)
tree9fed3403c91ab9b43aa30e660cbd1530439e6083 /src
parentd7ea461fde7a5d227313eda83b5af84ec9b0477b (diff)
Doc: Document signals (not handlers) under \qmlsignal
Append the handler names to the end of the corresponding signal doc. Task-number: QTBUG-35846 Change-Id: I3d627ba7ed5be94e5c402ab092b4d582536499e8 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/particles/qquickcustomaffector.cpp6
-rw-r--r--src/particles/qquickparticleaffector.cpp8
-rw-r--r--src/particles/qquickparticleemitter.cpp6
-rw-r--r--src/particles/qquicktrailemitter.cpp7
-rw-r--r--src/qml/types/qquickworkerscript.cpp6
-rw-r--r--src/quick/items/context2d/qquickcanvasitem.cpp22
-rw-r--r--src/quick/items/qquickdroparea.cpp24
-rw-r--r--src/quick/items/qquickflickable.cpp42
-rw-r--r--src/quick/items/qquickitem.cpp234
-rw-r--r--src/quick/items/qquickloader.cpp6
-rw-r--r--src/quick/items/qquickmousearea.cpp118
-rw-r--r--src/quick/items/qquickmultipointtoucharea.cpp48
-rw-r--r--src/quick/items/qquickpathview.cpp42
-rw-r--r--src/quick/items/qquickpincharea.cpp18
-rw-r--r--src/quick/items/qquickrepeater.cpp14
-rw-r--r--src/quick/items/qquicktext.cpp18
-rw-r--r--src/quick/items/qquicktextedit.cpp12
-rw-r--r--src/quick/items/qquicktextinput.cpp16
-rw-r--r--src/quick/items/qquickwindow.cpp4
-rw-r--r--src/quick/util/qquickanimation.cpp14
20 files changed, 428 insertions, 237 deletions
diff --git a/src/particles/qquickcustomaffector.cpp b/src/particles/qquickcustomaffector.cpp
index 890d415e3f..192f1676fd 100644
--- a/src/particles/qquickcustomaffector.cpp
+++ b/src/particles/qquickcustomaffector.cpp
@@ -49,9 +49,9 @@ QT_BEGIN_NAMESPACE
//TODO: Move docs (and inheritence) to real base when docs can propagate. Currently this pretends to be the base class!
/*!
- \qmlsignal QtQuick.Particles::Affector::onAffectParticles(Array particles, real dt)
+ \qmlsignal QtQuick.Particles::Affector::affectParticles(Array particles, real dt)
- This handler is called when particles are selected to be affected. particles contains
+ This signal is emitted when particles are selected to be affected. particles contains
an array of particle objects which can be directly manipulated.
dt is the time since the last time it was affected. Use dt to normalize
@@ -59,6 +59,8 @@ QT_BEGIN_NAMESPACE
Note that JavaScript is slower to execute, so it is not recommended to use this in
high-volume particle systems.
+
+ The corresponding handler is \c onAffectParticles.
*/
/*!
diff --git a/src/particles/qquickparticleaffector.cpp b/src/particles/qquickparticleaffector.cpp
index 7c72c27b74..261894402b 100644
--- a/src/particles/qquickparticleaffector.cpp
+++ b/src/particles/qquickparticleaffector.cpp
@@ -115,12 +115,12 @@ QT_BEGIN_NAMESPACE
non-rectangular area.
*/
/*!
- \qmlsignal QtQuick.Particles::Affector::onAffected(real x, real y)
+ \qmlsignal QtQuick.Particles::Affector::affected(real x, real y)
- This handler is called when a particle is selected to be affected. It will not be called
+ This signal is emitted when a particle is selected to be affected. It will not be emitted
if a particle is considered by the Affector but not actually altered in any way.
- In the special case where an Affector has no possible effect (e.g. Affector {}), affected
+ In the special case where an Affector has no possible effect (e.g. Affector {}), this signal
will be emitted for all particles being considered if you connect to it. This allows you to
execute arbitrary code in response to particles (use the Affector::onAffectParticles
signal handler if you want to execute code which affects the particles
@@ -128,6 +128,8 @@ QT_BEGIN_NAMESPACE
signal with a high-volume particle system.
x,y is the particle's current position.
+
+ The corresponding handler is \c onAffected.
*/
QQuickParticleAffector::QQuickParticleAffector(QQuickItem *parent) :
QQuickItem(parent), m_needsReset(false), m_ignoresTime(false), m_onceOff(false), m_enabled(true)
diff --git a/src/particles/qquickparticleemitter.cpp b/src/particles/qquickparticleemitter.cpp
index 41c64306a2..7c3df09341 100644
--- a/src/particles/qquickparticleemitter.cpp
+++ b/src/particles/qquickparticleemitter.cpp
@@ -189,13 +189,15 @@ QT_BEGIN_NAMESPACE
*/
/*!
- \qmlsignal QtQuick.Particles::Emitter::onEmitParticles(Array particles)
+ \qmlsignal QtQuick.Particles::Emitter::emitParticles(Array particles)
- This handler is called when particles are emitted. particles is a JavaScript
+ This signal is emitted when particles are emitted. particles is a JavaScript
array of Particle objects. You can modify particle attributes directly within the handler.
Note that JavaScript is slower to execute, so it is not recommended to use this in
high-volume particle systems.
+
+ The corresponding handler is \c onEmitParticles.
*/
/*! \qmlmethod QtQuick.Particles::Emitter::burst(int count)
diff --git a/src/particles/qquicktrailemitter.cpp b/src/particles/qquicktrailemitter.cpp
index cbc738fba5..e68e851d43 100644
--- a/src/particles/qquicktrailemitter.cpp
+++ b/src/particles/qquicktrailemitter.cpp
@@ -119,12 +119,11 @@ QQuickTrailEmitter::QQuickTrailEmitter(QQuickItem *parent) :
\qmlproperty real QtQuick.Particles::TrailEmitter::emitRatePerParticle
*/
/*!
- \qmlsignal QtQuick.Particles::TrailEmitter::onEmitFollowParticles(Array particles, Particle followed)
+ \qmlsignal QtQuick.Particles::TrailEmitter::emitFollowParticles(Array particles, Particle followed)
- This handler is called when particles are emitted from the \a followed particle. \a particles contains an array of particle objects which can be directly manipulated.
-
- If you use this signal handler, emitParticles will not be emitted.
+ This signal is emitted when particles are emitted from the \a followed particle. \a particles contains an array of particle objects which can be directly manipulated.
+ The corresponding handler is \c onEmitFollowParticles. If you use this signal handler, emitParticles will not be emitted.
*/
bool QQuickTrailEmitter::isEmitFollowConnected()
diff --git a/src/qml/types/qquickworkerscript.cpp b/src/qml/types/qquickworkerscript.cpp
index e8fe75bee1..45fa191bc9 100644
--- a/src/qml/types/qquickworkerscript.cpp
+++ b/src/qml/types/qquickworkerscript.cpp
@@ -720,10 +720,12 @@ void QQuickWorkerScript::componentComplete()
}
/*!
- \qmlsignal WorkerScript::onMessage(jsobject msg)
+ \qmlsignal WorkerScript::message(jsobject msg)
- This handler is called when a message \a msg is received from a worker
+ This signal is emitted when a message \a msg is received from a worker
script in another thread through a call to sendMessage().
+
+ The corresponding handler is \c onMessage.
*/
bool QQuickWorkerScript::event(QEvent *event)
diff --git a/src/quick/items/context2d/qquickcanvasitem.cpp b/src/quick/items/context2d/qquickcanvasitem.cpp
index 8b9ad50a3f..ed05315824 100644
--- a/src/quick/items/context2d/qquickcanvasitem.cpp
+++ b/src/quick/items/context2d/qquickcanvasitem.cpp
@@ -896,9 +896,11 @@ QQmlRefPointer<QQuickCanvasPixmap> QQuickCanvasItem::loadedPixmap(const QUrl& ur
}
/*!
- \qmlsignal QtQuick::Canvas::onImageLoaded()
+ \qmlsignal QtQuick::Canvas::imageLoaded()
- This handler is called when an image has been loaded.
+ This signal is emitted when an image has been loaded.
+
+ The corresponding handler is \c onImageLoaded.
\sa loadImage()
*/
@@ -1098,20 +1100,24 @@ QRect QQuickCanvasItem::tiledRect(const QRectF &window, const QSize &tileSize)
}
/*!
- \qmlsignal QtQuick::Canvas::onPaint(rect region)
+ \qmlsignal QtQuick::Canvas::paint(rect region)
- This handler is called to render the \a region. If a context is active it
- can be referenced from the context property.
+ This signal is emitted when the \a region needs to be rendered. If a context
+ is active it can be referenced from the context property.
- This signal can be triggered markdirty(), requestPaint() or by changing
+ This signal can be triggered by markdirty(), requestPaint() or by changing
the current canvas window.
+
+ The corresponding handler is \c onPaint.
*/
/*!
- \qmlsignal QtQuick::Canvas::onPainted()
+ \qmlsignal QtQuick::Canvas::painted()
- This handler is called after all context painting commands are executed and
+ This signal is emitted after all context painting commands are executed and
the Canvas has been rendered.
+
+ The corresponding handler is \c onPainted.
*/
QT_END_NAMESPACE
diff --git a/src/quick/items/qquickdroparea.cpp b/src/quick/items/qquickdroparea.cpp
index 57e500a150..23ee016941 100644
--- a/src/quick/items/qquickdroparea.cpp
+++ b/src/quick/items/qquickdroparea.cpp
@@ -208,9 +208,11 @@ qreal QQuickDropAreaDrag::y() const
}
/*!
- \qmlsignal QtQuick::DropArea::onPositionChanged(DragEvent drag)
+ \qmlsignal QtQuick::DropArea::positionChanged(DragEvent drag)
- This handler is called when the position of a drag has changed.
+ This signal is emitted when the position of a drag has changed.
+
+ The corresponding handler is \c onPositionChanged.
*/
void QQuickDropArea::dragMoveEvent(QDragMoveEvent *event)
@@ -249,9 +251,11 @@ QStringList QQuickDropAreaPrivate::getKeys(const QMimeData *mimeData) const
}
/*!
- \qmlsignal QtQuick::DropArea::onEntered(DragEvent drag)
+ \qmlsignal QtQuick::DropArea::entered(DragEvent drag)
+
+ This signal is emitted when a \a drag enters the bounds of a DropArea.
- This handler is called when a \a drag enters the bounds of a DropArea.
+ The corresponding handler is \c onEntered.
*/
void QQuickDropArea::dragEnterEvent(QDragEnterEvent *event)
@@ -282,9 +286,11 @@ void QQuickDropArea::dragEnterEvent(QDragEnterEvent *event)
}
/*!
- \qmlsignal QtQuick::DropArea::onExited()
+ \qmlsignal QtQuick::DropArea::exited()
- This handler is called when a drag exits the bounds of a DropArea.
+ This signal is emitted when a drag exits the bounds of a DropArea.
+
+ The corresponding handler is \c onExited.
*/
void QQuickDropArea::dragLeaveEvent(QDragLeaveEvent *)
@@ -303,10 +309,12 @@ void QQuickDropArea::dragLeaveEvent(QDragLeaveEvent *)
}
/*!
- \qmlsignal QtQuick::DropArea::onDropped(DragEvent drop)
+ \qmlsignal QtQuick::DropArea::dropped(DragEvent drop)
- This handler is called when a drop event occurs within the bounds of
+ This signal is emitted when a drop event occurs within the bounds of
a DropArea.
+
+ The corresponding handler is \c onDropped.
*/
void QQuickDropArea::dropEvent(QDropEvent *event)
diff --git a/src/quick/items/qquickflickable.cpp b/src/quick/items/qquickflickable.cpp
index 77687cf72a..7ac37c2853 100644
--- a/src/quick/items/qquickflickable.cpp
+++ b/src/quick/items/qquickflickable.cpp
@@ -548,19 +548,23 @@ is finished.
*/
/*!
- \qmlsignal QtQuick::Flickable::onDragStarted()
+ \qmlsignal QtQuick::Flickable::dragStarted()
- This handler is called when the view starts to be dragged due to user
+ This signal is emitted when the view starts to be dragged due to user
interaction.
+
+ The corresponding handler is \c onDragStarted.
*/
/*!
- \qmlsignal QtQuick::Flickable::onDragEnded()
+ \qmlsignal QtQuick::Flickable::dragEnded()
- This handler is called when the user stops dragging the view.
+ This signal is emitted when the user stops dragging the view.
If the velocity of the drag is sufficient at the time the
touch/mouse button is released then a flick will start.
+
+ The corresponding handler is \c onDragEnded.
*/
/*!
@@ -615,34 +619,42 @@ is finished.
*/
/*!
- \qmlsignal QtQuick::Flickable::onMovementStarted()
+ \qmlsignal QtQuick::Flickable::movementStarted()
- This handler is called when the view begins moving due to user
+ This signal is emitted when the view begins moving due to user
interaction.
+
+ The corresponding handler is \c onMovementStarted.
*/
/*!
- \qmlsignal QtQuick::Flickable::onMovementEnded()
+ \qmlsignal QtQuick::Flickable::movementEnded()
- This handler is called when the view stops moving due to user
- interaction. If a flick was generated, this handler will
- be triggered once the flick stops. If a flick was not
- generated, the handler will be triggered when the
+ This signal is emitted when the view stops moving due to user
+ interaction. If a flick was generated, this signal will
+ be emitted once the flick stops. If a flick was not
+ generated, this signal will be emitted when the
user stops dragging - i.e. a mouse or touch release.
+
+ The corresponding handler is \c onMovementEnded.
*/
/*!
- \qmlsignal QtQuick::Flickable::onFlickStarted()
+ \qmlsignal QtQuick::Flickable::flickStarted()
- This handler is called when the view is flicked. A flick
+ This signal is emitted when the view is flicked. A flick
starts from the point that the mouse or touch is released,
while still in motion.
+
+ The corresponding handler is \c onFlickStarted.
*/
/*!
- \qmlsignal QtQuick::Flickable::onFlickEnded()
+ \qmlsignal QtQuick::Flickable::flickEnded()
+
+ This signal is emitted when the view stops moving due to a flick.
- This handler is called when the view stops moving due to a flick.
+ The corresponding handler is \c onFlickEnded.
*/
/*!
diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp
index 7020f810ca..dd6d848330 100644
--- a/src/quick/items/qquickitem.cpp
+++ b/src/quick/items/qquickitem.cpp
@@ -923,276 +923,354 @@ bool QQuickKeysAttached::isConnected(const char *signalName)
*/
/*!
- \qmlsignal QtQuick::Keys::onPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::pressed(KeyEvent event)
- This handler is called when a key has been pressed. The \a event
+ This signal is emitted when a key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onReleased(KeyEvent event)
+ \qmlsignal QtQuick::Keys::released(KeyEvent event)
- This handler is called when a key has been released. The \a event
+ This signal is emitted when a key has been released. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onReleased.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit0Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit0Pressed(KeyEvent event)
- This handler is called when the digit '0' has been pressed. The \a event
+ This signal is emitted when the digit '0' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit0Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit1Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit1Pressed(KeyEvent event)
- This handler is called when the digit '1' has been pressed. The \a event
+ This signal is emitted when the digit '1' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit1Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit2Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit2Pressed(KeyEvent event)
- This handler is called when the digit '2' has been pressed. The \a event
+ This signal is emitted when the digit '2' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit2Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit3Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit3Pressed(KeyEvent event)
- This handler is called when the digit '3' has been pressed. The \a event
+ This signal is emitted when the digit '3' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit3Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit4Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit4Pressed(KeyEvent event)
- This handler is called when the digit '4' has been pressed. The \a event
+ This signal is emitted when the digit '4' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit4Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit5Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit5Pressed(KeyEvent event)
- This handler is called when the digit '5' has been pressed. The \a event
+ This signal is emitted when the digit '5' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit5Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit6Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit6Pressed(KeyEvent event)
- This handler is called when the digit '6' has been pressed. The \a event
+ This signal is emitted when the digit '6' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit6Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit7Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit7Pressed(KeyEvent event)
- This handler is called when the digit '7' has been pressed. The \a event
+ This signal is emitted when the digit '7' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit7Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit8Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit8Pressed(KeyEvent event)
- This handler is called when the digit '8' has been pressed. The \a event
+ This signal is emitted when the digit '8' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit8Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDigit9Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::digit9Pressed(KeyEvent event)
- This handler is called when the digit '9' has been pressed. The \a event
+ This signal is emitted when the digit '9' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDigit9Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onLeftPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::leftPressed(KeyEvent event)
- This handler is called when the Left arrow has been pressed. The \a event
+ This signal is emitted when the Left arrow has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onLeftPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onRightPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::rightPressed(KeyEvent event)
- This handler is called when the Right arrow has been pressed. The \a event
+ This signal is emitted when the Right arrow has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onRightPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onUpPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::upPressed(KeyEvent event)
- This handler is called when the Up arrow has been pressed. The \a event
+ This signal is emitted when the Up arrow has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onUpPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDownPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::downPressed(KeyEvent event)
- This handler is called when the Down arrow has been pressed. The \a event
+ This signal is emitted when the Down arrow has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDownPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onTabPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::tabPressed(KeyEvent event)
- This handler is called when the Tab key has been pressed. The \a event
+ This signal is emitted when the Tab key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onTabPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onBacktabPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::backtabPressed(KeyEvent event)
- This handler is called when the Shift+Tab key combination (Backtab) has
+ This signal is emitted when the Shift+Tab key combination (Backtab) has
been pressed. The \a event parameter provides information about the event.
+
+ The corresponding handler is \c onBacktabPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onAsteriskPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::asteriskPressed(KeyEvent event)
- This handler is called when the Asterisk '*' has been pressed. The \a event
+ This signal is emitted when the Asterisk '*' has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onAsteriskPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onEscapePressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::escapePressed(KeyEvent event)
- This handler is called when the Escape key has been pressed. The \a event
+ This signal is emitted when the Escape key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onEscapePressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onReturnPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::returnPressed(KeyEvent event)
- This handler is called when the Return key has been pressed. The \a event
+ This signal is emitted when the Return key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onReturnPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onEnterPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::enterPressed(KeyEvent event)
- This handler is called when the Enter key has been pressed. The \a event
+ This signal is emitted when the Enter key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onEnterPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onDeletePressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::deletePressed(KeyEvent event)
- This handler is called when the Delete key has been pressed. The \a event
+ This signal is emitted when the Delete key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onDeletePressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onSpacePressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::spacePressed(KeyEvent event)
- This handler is called when the Space key has been pressed. The \a event
+ This signal is emitted when the Space key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onSpacePressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onBackPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::backPressed(KeyEvent event)
- This handler is called when the Back key has been pressed. The \a event
+ This signal is emitted when the Back key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onBackPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onCancelPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::cancelPressed(KeyEvent event)
- This handler is called when the Cancel key has been pressed. The \a event
+ This signal is emitted when the Cancel key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onCancelPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onSelectPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::selectPressed(KeyEvent event)
- This handler is called when the Select key has been pressed. The \a event
+ This signal is emitted when the Select key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onSelectPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onYesPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::yesPressed(KeyEvent event)
- This handler is called when the Yes key has been pressed. The \a event
+ This signal is emitted when the Yes key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onYesPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onNoPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::noPressed(KeyEvent event)
- This handler is called when the No key has been pressed. The \a event
+ This signal is emitted when the No key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onNoPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onContext1Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::context1Pressed(KeyEvent event)
- This handler is called when the Context1 key has been pressed. The \a event
+ This signal is emitted when the Context1 key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onContext1Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onContext2Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::context2Pressed(KeyEvent event)
- This handler is called when the Context2 key has been pressed. The \a event
+ This signal is emitted when the Context2 key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onContext2Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onContext3Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::context3Pressed(KeyEvent event)
- This handler is called when the Context3 key has been pressed. The \a event
+ This signal is emitted when the Context3 key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onContext3Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onContext4Pressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::context4Pressed(KeyEvent event)
- This handler is called when the Context4 key has been pressed. The \a event
+ This signal is emitted when the Context4 key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onContext4Pressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onCallPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::callPressed(KeyEvent event)
- This handler is called when the Call key has been pressed. The \a event
+ This signal is emitted when the Call key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onCallPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onHangupPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::hangupPressed(KeyEvent event)
- This handler is called when the Hangup key has been pressed. The \a event
+ This signal is emitted when the Hangup key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onHangupPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onFlipPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::flipPressed(KeyEvent event)
- This handler is called when the Flip key has been pressed. The \a event
+ This signal is emitted when the Flip key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onFlipPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onMenuPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::menuPressed(KeyEvent event)
- This handler is called when the Menu key has been pressed. The \a event
+ This signal is emitted when the Menu key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onMenuPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onVolumeUpPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::volumeUpPressed(KeyEvent event)
- This handler is called when the VolumeUp key has been pressed. The \a event
+ This signal is emitted when the VolumeUp key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onVolumeUpPressed.
*/
/*!
- \qmlsignal QtQuick::Keys::onVolumeDownPressed(KeyEvent event)
+ \qmlsignal QtQuick::Keys::volumeDownPressed(KeyEvent event)
- This handler is called when the VolumeDown key has been pressed. The \a event
+ This signal is emitted when the VolumeDown key has been pressed. The \a event
parameter provides information about the event.
+
+ The corresponding handler is \c onVolumeDownPressed.
*/
QQuickKeysAttached::QQuickKeysAttached(QObject *parent)
diff --git a/src/quick/items/qquickloader.cpp b/src/quick/items/qquickloader.cpp
index debe4b7497..c8b8544eec 100644
--- a/src/quick/items/qquickloader.cpp
+++ b/src/quick/items/qquickloader.cpp
@@ -816,10 +816,12 @@ void QQuickLoader::componentComplete()
}
/*!
- \qmlsignal QtQuick::Loader::onLoaded()
+ \qmlsignal QtQuick::Loader::loaded()
- This handler is called when the \l status becomes \c Loader.Ready, or on successful
+ This signal is emitted when the \l status becomes \c Loader.Ready, or on successful
initial load.
+
+ The corresponding handler is \c onLoaded.
*/
diff --git a/src/quick/items/qquickmousearea.cpp b/src/quick/items/qquickmousearea.cpp
index a8aadb9eed..3c9480da1c 100644
--- a/src/quick/items/qquickmousearea.cpp
+++ b/src/quick/items/qquickmousearea.cpp
@@ -258,30 +258,32 @@ bool QQuickMouseAreaPrivate::propagateHelper(QQuickMouseEvent *ev, QQuickItem *i
*/
/*!
- \qmlsignal QtQuick::MouseArea::onEntered()
+ \qmlsignal QtQuick::MouseArea::entered()
- This handler is called when the mouse enters the mouse area.
+ This signal is emitted when the mouse enters the mouse area.
- By default the onEntered handler is only called while a button is
- pressed. Setting hoverEnabled to true enables handling of
- onEntered when no mouse button is pressed.
+ By default this signal is only emitted if a button is currently
+ pressed. Set \l hoverEnabled to true to emit this signal
+ even when no mouse button is pressed.
\sa hoverEnabled
+
+ The corresponding handler is \c onEntered.
*/
/*!
- \qmlsignal QtQuick::MouseArea::onExited()
+ \qmlsignal QtQuick::MouseArea::exited()
- This handler is called when the mouse exits the mouse area.
+ This signal is emitted when the mouse exits the mouse area.
- By default the onExited handler is only called while a button is
- pressed. Setting hoverEnabled to true enables handling of
- onExited when no mouse button is pressed.
+ By default this signal is only emitted if a button is currently
+ pressed. Set \l hoverEnabled to true to emit this signal
+ even when no mouse button is pressed.
The example below shows a fairly typical relationship between
two MouseAreas, with \c mouseArea2 on top of \c mouseArea1. Moving the
- mouse into \c mouseArea2 from \c mouseArea1 will cause \c onExited
- to be called for \c mouseArea1.
+ mouse into \c mouseArea2 from \c mouseArea1 will cause \c mouseArea1
+ to emit the \c exited signal.
\qml
Rectangle {
width: 400; height: 400
@@ -299,112 +301,134 @@ bool QQuickMouseAreaPrivate::propagateHelper(QQuickMouseEvent *ev, QQuickItem *i
}
\endqml
- If instead you give the two mouseAreas a parent-child relationship,
+ If instead you give the two MouseAreas a parent-child relationship,
moving the mouse into \c mouseArea2 from \c mouseArea1 will \b not
- cause \c onExited to be called for \c mouseArea1. Instead, they will
+ cause \c mouseArea1 to emit \c exited. Instead, they will
both be considered to be simultaneously hovered.
\sa hoverEnabled
+
+ The corresponding handler is \c onExited.
*/
/*!
- \qmlsignal QtQuick::MouseArea::onPositionChanged(MouseEvent mouse)
+ \qmlsignal QtQuick::MouseArea::positionChanged(MouseEvent mouse)
- This handler is called when the mouse position changes.
+ This signal is emitted when the mouse position changes.
The \l {MouseEvent}{mouse} parameter provides information about the mouse, including the x and y
position, and any buttons currently pressed.
- The \e accepted property of the MouseEvent parameter is ignored in this handler.
+ By default this signal is only emitted if a button is currently
+ pressed. Set \l hoverEnabled to true to emit this signal
+ even when no mouse button is pressed.
+
+ When handling this signal, changing the \l {MouseEvent::}{accepted} property of the \a mouse
+ parameter has no effect.
- By default the onPositionChanged handler is only called while a button is
- pressed. Setting hoverEnabled to true enables handling of
- onPositionChanged when no mouse button is pressed.
+ The corresponding handler is \c onPositionChanged.
*/
/*!
- \qmlsignal QtQuick::MouseArea::onClicked(MouseEvent mouse)
+ \qmlsignal QtQuick::MouseArea::clicked(MouseEvent mouse)
- This handler is called when there is a click. A click is defined as a press followed by a release,
+ This signal is emitted when there is a click. A click is defined as a press followed by a release,
both inside the MouseArea (pressing, moving outside the MouseArea, and then moving back inside and
releasing is also considered a click).
The \l {MouseEvent}{mouse} parameter provides information about the click, including the x and y
position of the release of the click, and whether the click was held.
- The \e accepted property of the MouseEvent parameter is ignored in this handler.
+ When handling this signal, changing the \l {MouseEvent::}{accepted} property of the \a mouse
+ parameter has no effect.
+
+ The corresponding handler is \c onClicked.
*/
/*!
- \qmlsignal QtQuick::MouseArea::onPressed(MouseEvent mouse)
+ \qmlsignal QtQuick::MouseArea::pressed(MouseEvent mouse)
- This handler is called when there is a press.
+ This signal is emitted when there is a press.
The \l {MouseEvent}{mouse} parameter provides information about the press, including the x and y
position and which button was pressed.
- The \e accepted property of the MouseEvent parameter determines whether this MouseArea
- will handle the press and all future mouse events until release. The default is to accept
- the event and not allow other MouseArea beneath this one to handle the event. If \e accepted
- is set to false, no further events will be sent to this MouseArea until the button is next
- pressed.
+ When handling this signal, use the \l {MouseEvent::}{accepted} property of the \a mouse
+ parameter to control whether this MouseArea handles the press and all future mouse events until
+ release. The default is to accept the event and not allow other MouseAreas beneath this one to
+ handle the event. If \e accepted is set to false, no further events will be sent to this MouseArea
+ until the button is next pressed.
+
+ The corresponding handler is \c onPressed.
*/
/*!
- \qmlsignal QtQuick::MouseArea::onReleased(MouseEvent mouse)
+ \qmlsignal QtQuick::MouseArea::released(MouseEvent mouse)
- This handler is called when there is a release.
+ This signal is emitted when there is a release.
The \l {MouseEvent}{mouse} parameter provides information about the click, including the x and y
position of the release of the click, and whether the click was held.
- The \e accepted property of the MouseEvent parameter is ignored in this handler.
+ When handling this signal, changing the \l {MouseEvent::}{accepted} property of the \a mouse
+ parameter has no effect.
+
+ The corresponding handler is \c onReleased.
\sa onCanceled
*/
/*!
- \qmlsignal QtQuick::MouseArea::onPressAndHold(MouseEvent mouse)
+ \qmlsignal QtQuick::MouseArea::pressAndHold(MouseEvent mouse)
- This handler is called when there is a long press (currently 800ms).
+ This signal is emitted when there is a long press (currently 800ms).
The \l {MouseEvent}{mouse} parameter provides information about the press, including the x and y
position of the press, and which button is pressed.
- The \e accepted property of the MouseEvent parameter is ignored in this handler.
+ When handling this signal, changing the \l {MouseEvent::}{accepted} property of the \a mouse
+ parameter has no effect.
+
+ The corresponding handler is \c onPressAndHold.
*/
/*!
- \qmlsignal QtQuick::MouseArea::onDoubleClicked(MouseEvent mouse)
+ \qmlsignal QtQuick::MouseArea::doubleClicked(MouseEvent mouse)
- This handler is called when there is a double-click (a press followed by a release followed by a press).
+ This signal is emitted when there is a double-click (a press followed by a release followed by a press).
The \l {MouseEvent}{mouse} parameter provides information about the click, including the x and y
position of the release of the click, and whether the click was held.
- If the \e accepted property of the \l {MouseEvent}{mouse} parameter is set to false
- in the handler, the onPressed/onReleased/onClicked handlers will be called for the second
- click; otherwise they are suppressed. The accepted property defaults to true.
+ When handling this signal, if the \l {MouseEvent::}{accepted} property of the \a mouse
+ parameter is set to false, the pressed/released/clicked signals will be emitted for the second
+ click; otherwise they are suppressed. The \c accepted property defaults to true.
+
+ The corresponding handler is \c onDoubleClicked.
*/
/*!
- \qmlsignal QtQuick::MouseArea::onCanceled()
+ \qmlsignal QtQuick::MouseArea::canceled()
- This handler is called when mouse events have been canceled, either because an event was not accepted, or
+ This signal is emitted when mouse events have been canceled, either because an event was not accepted, or
because another item stole the mouse event handling.
This signal is for advanced use: it is useful when there is more than one MouseArea
that is handling input, or when there is a MouseArea inside a \l Flickable. In the latter
- case, if you execute some logic on the pressed signal and then start dragging, the
+ case, if you execute some logic in the \c onPressed signal handler and then start dragging, the
\l Flickable will steal the mouse handling from the MouseArea. In these cases, to reset
the logic when the MouseArea has lost the mouse handling to the \l Flickable,
- \c onCanceled should be used in addition to onReleased.
+ \c canceled should be handled in addition to \l released.
+
+ The corresponding handler is \c onCanceled.
*/
/*!
- \qmlsignal QtQuick::MouseArea::onWheel(WheelEvent wheel)
+ \qmlsignal QtQuick::MouseArea::wheel(WheelEvent wheel)
- This handler is called in response to both mouse wheel and trackpad scroll gestures.
+ This signal is emitted in response to both mouse wheel and trackpad scroll gestures.
The \l {WheelEvent}{wheel} parameter provides information about the event, including the x and y
position, any buttons currently pressed, and information about the wheel movement, including
angleDelta and pixelDelta.
+
+ The corresponding handler is \c onWheel.
*/
QQuickMouseArea::QQuickMouseArea(QQuickItem *parent)
diff --git a/src/quick/items/qquickmultipointtoucharea.cpp b/src/quick/items/qquickmultipointtoucharea.cpp
index 6a5ba931c7..c20559454e 100644
--- a/src/quick/items/qquickmultipointtoucharea.cpp
+++ b/src/quick/items/qquickmultipointtoucharea.cpp
@@ -259,60 +259,72 @@ void QQuickTouchPoint::setSceneY(qreal sceneY)
*/
/*!
- \qmlsignal QtQuick::MultiPointTouchArea::onPressed(list<TouchPoint> touchPoints)
+ \qmlsignal QtQuick::MultiPointTouchArea::pressed(list<TouchPoint> touchPoints)
- This handler is called when new touch points are added. \a touchPoints is a list of these new points.
+ This signal is emitted when new touch points are added. \a touchPoints is a list of these new points.
- If minimumTouchPoints is set to a value greater than one, this handler will not be called until the minimum number
- of required touch points has been reached. At that point, onPressed will be called with all the current touch points.
+ If minimumTouchPoints is set to a value greater than one, this signal will not be emitted until the minimum number
+ of required touch points has been reached.
+
+ The corresponding handler is \c onPressed.
*/
/*!
- \qmlsignal QtQuick::MultiPointTouchArea::onUpdated(list<TouchPoint> touchPoints)
+ \qmlsignal QtQuick::MultiPointTouchArea::updated(list<TouchPoint> touchPoints)
+
+ This signal is emitted when existing touch points are updated. \a touchPoints is a list of these updated points.
- This handler is called when existing touch points are updated. \a touchPoints is a list of these updated points.
+ The corresponding handler is \c onUpdated.
*/
/*!
- \qmlsignal QtQuick::MultiPointTouchArea::onReleased(list<TouchPoint> touchPoints)
+ \qmlsignal QtQuick::MultiPointTouchArea::released(list<TouchPoint> touchPoints)
+
+ This signal is emitted when existing touch points are removed. \a touchPoints is a list of these removed points.
- This handler is called when existing touch points are removed. \a touchPoints is a list of these removed points.
+ The corresponding handler is \c onReleased.
*/
/*!
- \qmlsignal QtQuick::MultiPointTouchArea::onCanceled(list<TouchPoint> touchPoints)
+ \qmlsignal QtQuick::MultiPointTouchArea::canceled(list<TouchPoint> touchPoints)
- This handler is called when new touch events have been canceled because another item stole the touch event handling.
+ This signal is emitted when new touch events have been canceled because another item stole the touch event handling.
This signal is for advanced use: it is useful when there is more than one MultiPointTouchArea
that is handling input, or when there is a MultiPointTouchArea inside a \l Flickable. In the latter
- case, if you execute some logic on the onPressed signal and then start dragging, the
+ case, if you execute some logic in the \c onPressed signal handler and then start dragging, the
\l Flickable may steal the touch handling from the MultiPointTouchArea. In these cases, to reset
the logic when the MultiPointTouchArea has lost the touch handling to the \l Flickable,
- \c onCanceled should be used in addition to onReleased.
+ \c canceled should be handled in addition to \l released.
\a touchPoints is the list of canceled points.
+
+ The corresponding handler is \c onCanceled.
*/
/*!
- \qmlsignal QtQuick::MultiPointTouchArea::onGestureStarted(GestureEvent gesture)
+ \qmlsignal QtQuick::MultiPointTouchArea::gestureStarted(GestureEvent gesture)
- This handler is called when the global drag threshold has been reached.
+ This signal is emitted when the global drag threshold has been reached.
- This function is typically used when a MultiPointTouchAreas has been nested in a Flickable or another MultiPointTouchArea.
- When the threshold has been reached, and the handler called, you can determine whether or not the touch
+ This signal is typically used when a MultiPointTouchArea has been nested in a Flickable or another MultiPointTouchArea.
+ When the threshold has been reached and the signal is handled, you can determine whether or not the touch
area should grab the current touch points. By default they will not be grabbed; to grab them call \c gesture.grab(). If the
gesture is not grabbed, the nesting Flickable, for example, would also have an opportunity to grab.
The gesture object also includes information on the current set of \c touchPoints and the \c dragThreshold.
+
+ The corresponding handler is \c onGestureStarted.
*/
/*!
- \qmlsignal QtQuick::MultiPointTouchArea::onTouchUpdated(list<TouchPoint> touchPoints)
+ \qmlsignal QtQuick::MultiPointTouchArea::touchUpdated(list<TouchPoint> touchPoints)
- This handler is called when the touch points handled by the MultiPointTouchArea change. This includes adding new touch points,
+ This signal is emitted when the touch points handled by the MultiPointTouchArea change. This includes adding new touch points,
removing or canceling previous touch points, as well as updating current touch point data. \a touchPoints is the list of all current touch
points.
+
+ The corresponding handler is \c onTouchUpdated.
*/
/*!
diff --git a/src/quick/items/qquickpathview.cpp b/src/quick/items/qquickpathview.cpp
index 0080f54d20..ec789670ab 100644
--- a/src/quick/items/qquickpathview.cpp
+++ b/src/quick/items/qquickpathview.cpp
@@ -1147,50 +1147,62 @@ bool QQuickPathView::isDragging() const
}
/*!
- \qmlsignal QtQuick::PathView::onMovementStarted()
+ \qmlsignal QtQuick::PathView::movementStarted()
- This handler is called when the view begins moving due to user
+ This signal is emitted when the view begins moving due to user
interaction.
+
+ The corresponding handler is \c onMovementStarted.
*/
/*!
- \qmlsignal QtQuick::PathView::onMovementEnded()
+ \qmlsignal QtQuick::PathView::movementEnded()
- This handler is called when the view stops moving due to user
- interaction. If a flick was generated, this handler will
- be triggered once the flick stops. If a flick was not
- generated, the handler will be triggered when the
+ This signal is emitted when the view stops moving due to user
+ interaction. If a flick was generated, this signal will
+ be emitted once the flick stops. If a flick was not
+ generated, this signal will be emitted when the
user stops dragging - i.e. a mouse or touch release.
+
+ The corresponding handler is \c onMovementEnded.
*/
/*!
- \qmlsignal QtQuick::PathView::onFlickStarted()
+ \qmlsignal QtQuick::PathView::flickStarted()
- This handler is called when the view is flicked. A flick
+ This signal is emitted when the view is flicked. A flick
starts from the point that the mouse or touch is released,
while still in motion.
+
+ The corresponding handler is \c onFlickStarted.
*/
/*!
- \qmlsignal QtQuick::PathView::onFlickEnded()
+ \qmlsignal QtQuick::PathView::flickEnded()
- This handler is called when the view stops moving due to a flick.
+ This signal is emitted when the view stops moving due to a flick.
+
+ The corresponding handler is \c onFlickEnded.
*/
/*!
- \qmlsignal QtQuick::PathView::onDragStarted()
+ \qmlsignal QtQuick::PathView::dragStarted()
- This handler is called when the view starts to be dragged due to user
+ This signal is emitted when the view starts to be dragged due to user
interaction.
+
+ The corresponding handler is \c onDragStarted.
*/
/*!
- \qmlsignal QtQuick::PathView::onDragEnded()
+ \qmlsignal QtQuick::PathView::dragEnded()
- This handler is called when the user stops dragging the view.
+ This signal is emitted when the user stops dragging the view.
If the velocity of the drag is suffient at the time the
touch/mouse button is released then a flick will start.
+
+ The corresponding handler is \c onDragEnded.
*/
/*!
diff --git a/src/quick/items/qquickpincharea.cpp b/src/quick/items/qquickpincharea.cpp
index 98661d8f00..e58dfad5c1 100644
--- a/src/quick/items/qquickpincharea.cpp
+++ b/src/quick/items/qquickpincharea.cpp
@@ -190,33 +190,39 @@ QQuickPinchAreaPrivate::~QQuickPinchAreaPrivate()
*/
/*!
- \qmlsignal QtQuick::PinchArea::onPinchStarted()
+ \qmlsignal QtQuick::PinchArea::pinchStarted()
- This handler is called when the pinch area detects that a pinch gesture has started.
+ This signal is emitted when the pinch area detects that a pinch gesture has started.
The \l {PinchEvent}{pinch} parameter provides information about the pinch gesture,
including the scale, center and angle of the pinch.
To ignore this gesture set the \c pinch.accepted property to false. The gesture
will be canceled and no further events will be sent.
+
+ The corresponding handler is \c onPinchStarted.
*/
/*!
- \qmlsignal QtQuick::PinchArea::onPinchUpdated()
+ \qmlsignal QtQuick::PinchArea::pinchUpdated()
- This handler is called when the pinch area detects that a pinch gesture has changed.
+ This signal is emitted when the pinch area detects that a pinch gesture has changed.
The \l {PinchEvent}{pinch} parameter provides information about the pinch gesture,
including the scale, center and angle of the pinch.
+
+ The corresponding handler is \c onPinchUpdated.
*/
/*!
- \qmlsignal QtQuick::PinchArea::onPinchFinished()
+ \qmlsignal QtQuick::PinchArea::pinchFinished()
- This handler is called when the pinch area detects that a pinch gesture has finished.
+ This signal is emitted when the pinch area detects that a pinch gesture has finished.
The \l {PinchEvent}{pinch} parameter provides information about the pinch gesture,
including the scale, center and angle of the pinch.
+
+ The corresponding handler is \c onPinchFinished.
*/
diff --git a/src/quick/items/qquickrepeater.cpp b/src/quick/items/qquickrepeater.cpp
index 072bfab73c..e226d7ba49 100644
--- a/src/quick/items/qquickrepeater.cpp
+++ b/src/quick/items/qquickrepeater.cpp
@@ -131,22 +131,26 @@ QQuickRepeaterPrivate::~QQuickRepeaterPrivate()
*/
/*!
- \qmlsignal QtQuick::Repeater::onItemAdded(int index, Item item)
+ \qmlsignal QtQuick::Repeater::itemAdded(int index, Item item)
- This handler is called when an item is added to the repeater. The \a index
+ This signal is emitted when an item is added to the repeater. The \a index
parameter holds the index at which the item has been inserted within the
repeater, and the \a item parameter holds the \l Item that has been added.
+
+ The corresponding handler is \c onItemAdded.
*/
/*!
- \qmlsignal QtQuick::Repeater::onItemRemoved(int index, Item item)
+ \qmlsignal QtQuick::Repeater::itemRemoved(int index, Item item)
- This handler is called when an item is removed from the repeater. The \a index
+ This signal is emitted when an item is removed from the repeater. The \a index
parameter holds the index at which the item was removed from the repeater,
and the \a item parameter holds the \l Item that was removed.
Do not keep a reference to \a item if it was created by this repeater, as
- in these cases it will be deleted shortly after the handler is called.
+ in these cases it will be deleted shortly after the signal is handled.
+
+ The corresponding handler is \c onItemRemoved.
*/
QQuickRepeater::QQuickRepeater(QQuickItem *parent)
: QQuickItem(*(new QQuickRepeaterPrivate), parent)
diff --git a/src/quick/items/qquicktext.cpp b/src/quick/items/qquicktext.cpp
index 287173957f..6c3750bcbc 100644
--- a/src/quick/items/qquicktext.cpp
+++ b/src/quick/items/qquicktext.cpp
@@ -1250,9 +1250,9 @@ QQuickText::~QQuickText()
*/
/*!
- \qmlsignal QtQuick::Text::onLineLaidOut(object line)
+ \qmlsignal QtQuick::Text::lineLaidOut(object line)
- This handler is called for each line of text that is laid out during the layout
+ This signal is emitted for each line of text that is laid out during the layout
process. The specified \a line object provides more details about the line that
is currently being laid out.
@@ -1277,12 +1277,14 @@ QQuickText::~QQuickText()
}
}
\endcode
+
+ The corresponding handler is \c onLineLaidOut.
*/
/*!
- \qmlsignal QtQuick::Text::onLinkActivated(string link)
+ \qmlsignal QtQuick::Text::linkActivated(string link)
- This handler is called when the user clicks on a link embedded in the text.
+ 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.
@@ -1293,6 +1295,8 @@ QQuickText::~QQuickText()
Clicking on the highlighted link will output
\tt{http://qt-project.org link activated} to the console.
+
+ The corresponding handler is \c onLinkActivated.
*/
/*!
@@ -2566,13 +2570,15 @@ bool QQuickTextPrivate::isLinkHoveredConnected()
}
/*!
- \qmlsignal QtQuick::Text::onLinkHovered(string link)
+ \qmlsignal QtQuick::Text::linkHovered(string link)
\since 5.2
- This handler is called when the user hovers a link embedded in the
+ This signal is emitted when the user hovers 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 onLinkHovered.
+
\sa hoveredLink, linkAt()
*/
diff --git a/src/quick/items/qquicktextedit.cpp b/src/quick/items/qquicktextedit.cpp
index 6fc1a3f4a5..017066d9a4 100644
--- a/src/quick/items/qquicktextedit.cpp
+++ b/src/quick/items/qquicktextedit.cpp
@@ -116,11 +116,13 @@ TextEdit {
*/
/*!
- \qmlsignal QtQuick::TextEdit::onLinkActivated(string link)
+ \qmlsignal QtQuick::TextEdit::linkActivated(string link)
- This handler is called when the user clicks on a link embedded in the text.
+ 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.
*/
// This is a pretty arbitrary figure. The idea is that we don't want to break down the document
@@ -2509,13 +2511,15 @@ bool QQuickTextEditPrivate::isLinkHoveredConnected()
}
/*!
- \qmlsignal QtQuick::TextEdit::onLinkHovered(string link)
+ \qmlsignal QtQuick::TextEdit::linkHovered(string link)
\since 5.2
- This handler is called when the user hovers a link embedded in the text.
+ This signal is emitted when the user hovers 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 onLinkHovered.
+
\sa hoveredLink, linkAt()
*/
diff --git a/src/quick/items/qquicktextinput.cpp b/src/quick/items/qquicktextinput.cpp
index ad79f0eadf..5195911c5f 100644
--- a/src/quick/items/qquicktextinput.cpp
+++ b/src/quick/items/qquicktextinput.cpp
@@ -1201,23 +1201,27 @@ bool QQuickTextInput::hasAcceptableInput() const
}
/*!
- \qmlsignal QtQuick::TextInput::onAccepted()
+ \qmlsignal QtQuick::TextInput::accepted()
- This handler is called when the Return or Enter key is pressed.
+ This signal is emitted when the Return or Enter key is pressed.
Note that if there is a \l validator or \l inputMask set on the text
- input, the handler will only be emitted if the input is in an acceptable
+ input, the signal will only be emitted if the input is in an acceptable
state.
+
+ The corresponding handler is \c onAccepted.
*/
/*!
- \qmlsignal QtQuick::TextInput::onEditingFinished()
+ \qmlsignal QtQuick::TextInput::editingFinished()
\since 5.2
- This handler is called when the Return or Enter key is pressed or
+ This signal is emitted when the Return or Enter key is pressed or
the text input loses focus. Note that if there is a validator or
inputMask set on the text input and enter/return is pressed, this
- handler will only be called if the input follows
+ signal will only be emitted if the input follows
the inputMask and the validator returns an acceptable state.
+
+ The corresponding handler is \c onEditingFinished.
*/
#ifndef QT_NO_IM
diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp
index 81001e19fa..b501261cbc 100644
--- a/src/quick/items/qquickwindow.cpp
+++ b/src/quick/items/qquickwindow.cpp
@@ -2840,7 +2840,7 @@ QOpenGLContext *QQuickWindow::openglContext() const
*/
/*!
- \qmlsignal closing(CloseEvent close)
+ \qmlsignal QtQuick.Window::Window::closing(CloseEvent close)
\since 5.1
This signal is emitted when the user tries to close the window.
@@ -2849,6 +2849,8 @@ QOpenGLContext *QQuickWindow::openglContext() const
property is true by default so that the window is allowed to close; but you
can implement an onClosing() handler and set close.accepted = false if
you need to do something else before the window can be closed.
+
+ The corresponding handler is \c onClosing.
*/
diff --git a/src/quick/util/qquickanimation.cpp b/src/quick/util/qquickanimation.cpp
index 36316e27c0..e46eb77ce2 100644
--- a/src/quick/util/qquickanimation.cpp
+++ b/src/quick/util/qquickanimation.cpp
@@ -200,19 +200,21 @@ QQmlProperty QQuickAbstractAnimationPrivate::createProperty(QObject *obj, const
}
/*!
- \qmlsignal QtQuick::Animation::onStarted()
+ \qmlsignal QtQuick::Animation::started()
- This signal handler is called when the animation begins.
+ This signal is emitted when the animation begins.
It is only triggered for top-level, standalone animations. It will not be
triggered for animations in a Behavior or Transition, or animations
that are part of an animation group.
+
+ The corresponding handler is \c onStarted.
*/
/*!
- \qmlsignal QtQuick::Animation::onStopped()
+ \qmlsignal QtQuick::Animation::stopped()
- This signal handler is called when the animation ends.
+ This signal is emitted when the animation ends.
The animation may have been stopped manually, or may have run to completion.
@@ -220,8 +222,10 @@ QQmlProperty QQuickAbstractAnimationPrivate::createProperty(QObject *obj, const
triggered for animations in a Behavior or Transition, or animations
that are part of an animation group.
- If \l alwaysRunToEnd is true, onStopped will not be called until the animation
+ If \l alwaysRunToEnd is true, this signal will not be emitted until the animation
has completed its current iteration.
+
+ The corresponding handler is \c onStopped.
*/
void QQuickAbstractAnimation::setRunning(bool r)