Doc: Fix broken \qmlsignal links

Fix the breaks caused by the re-categorizing of \qmlsignal pages

Task-number: QTBUG-35846
Change-Id: I528ae16ec522fc902133e22d8f53c87a7f0d56ad
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This commit is contained in:
Sze Howe Koh 2014-03-16 12:20:26 +08:00 committed by The Qt Project
parent 303db2e8a1
commit 5a9b5148a1
13 changed files with 36 additions and 37 deletions

View File

@ -143,11 +143,11 @@ Those signals can be handled by signal handler functions, which can be defined
by clients to implement custom program logic.
Suppose that a button represented by a Rectangle type has a MouseArea and a
Text label. The MouseArea will emit its "pressed" signal when the user presses
the defined interactive area, which will automatically trigger the
\l{MouseArea::}{onPressed} handler, which can be defined by clients. The QML
engine will execute the JavaScript expressions defined in the onPressed and
onReleased handlers, as required. Typically, a signal handler is bound to
Text label. The MouseArea will emit its \l{MouseArea::}{pressed} signal when the
user presses the defined interactive area, which will automatically trigger the
\c onPressed handler, which can be defined by clients. The QML
engine will execute the JavaScript expressions defined in the \c onPressed and
\c onReleased handlers, as required. Typically, a signal handler is bound to
JavaScript expressions to initiate other events or to simply assign property
values.

View File

@ -633,7 +633,7 @@ defined by its implementation.
A signal is a notification from an object that some event has occurred: for
example, a property has changed, an animation has started or stopped, or
when an image has been downloaded. The \l MouseArea type, for example, has
a \l {MouseArea::onClicked}{clicked} signal that is emitted when the user clicks
a \l {MouseArea::}{clicked} signal that is emitted when the user clicks
within the mouse area.
An object can be notified through a \l{Signal handler attributes}

View File

@ -65,7 +65,7 @@ Rectangle {
}
\endqml
Looking at the \l MouseArea documentation, you can see the \l {MouseArea::onClicked}{clicked} signal is emitted with a parameter named \c mouse which is a \l MouseEvent object that contains further details about the mouse click event. This name can be referred to in our \c onClicked handler to access this parameter. For example, the \l MouseEvent type has \c x and \c y coordinates that allows us to print out the exact location where the mouse was clicked:
Looking at the \l MouseArea documentation, you can see the \l {MouseArea::}{clicked} signal is emitted with a parameter named \c mouse which is a \l MouseEvent object that contains further details about the mouse click event. This name can be referred to in our \c onClicked handler to access this parameter. For example, the \l MouseEvent type has \c x and \c y coordinates that allows us to print out the exact location where the mouse was clicked:
\qml
import QtQuick 2.0

View File

@ -1520,11 +1520,11 @@ QQmlListModelParser::ListInstruction *QQmlListModelParser::ListModelData::instru
The timer in the main example sends messages to the worker script by calling
\l WorkerScript::sendMessage(). When this message is received,
\l{WorkerScript::onMessage}{WorkerScript.onMessage()} is invoked in \c dataloader.js,
\c WorkerScript.onMessage() is invoked in \c dataloader.js,
which appends the current time to the list model.
Note the call to sync() from the \l{WorkerScript::onMessage}{WorkerScript.onMessage()}
handler. You must call sync() or else the changes made to the list from the external
Note the call to sync() from the external thread.
You must call sync() or else the changes made to the list from that
thread will not be reflected in the list model in the main thread.
\sa {qml-data-models}{Data Models}, {declarative/threading/threadedlistmodel}{Threaded ListModel example}, {Qt QML}

View File

@ -584,7 +584,7 @@ void QQuickWorkerScriptEngine::run()
that the main GUI thread is not blocked.
Messages can be passed between the new thread and the parent thread
using \l sendMessage() and the \l {WorkerScript::onMessage}{onMessage()} handler.
using \l sendMessage() and the \c onMessage() handler.
An example:

View File

@ -109,8 +109,8 @@ the view and cannot be moved by other means.
Dragging the content item is enabled by binding it to the MouseArea's
\l {QtQuick::MouseArea::drag.target}{drag.target} property. Because we still want the view to be
flickable we wait until the MouseArea's \l {QtQuick::MouseArea::onPressAndHold}{onPressAndHold}
handler is triggered before binding the drag target. This way when mouse moves before the hold
flickable we wait until the MouseArea's \l {QtQuick::MouseArea::}{pressAndHold}
signal is emitted before binding the drag target. This way when mouse moves before the hold
timeout has expired it is interpreted as moving the list and if it moves after it is interpreted as
dragging an item. To make it more obvious to the user when an item can be dragged we'll change the
background color of the content item when the timeout has expired.

View File

@ -216,7 +216,7 @@ relative to its start.
\list
\li \c Text.RightElide is now supported where text spans multiple lines.
\li New \l{Text::}{linkColor} property controls the color of linked text.
\li New \l{Text::}{onLineLaidOut} handler is called for every line during the layout process to
\li New \l{Text::}{lineLaidOut} signal is emitted for every line during the layout process to
give the option of positioning and/or resizing lines as they are laid out.
\li New \l{Text::}{doLayout()} method will trigger the text layout from Javascript.
\li New \l{Text::}{fontSizeMode} property allows text to be fitted to the item size.
@ -250,9 +250,9 @@ the window loses focus.
\list
\li Wheel events are now supported; events are provided through the new WheelEvent type.
\li New \l{MouseArea::}{propagateComposedEvents} property sets whether composed events are
propagated to other mouse areas. If this property is true and the l{MouseArea::onClicked}{clicked},
\l{MouseArea::onDoubleClicked}{doubleClicked} or \l{MouseArea::onPressAndHold}{pressAndHold}
handlers reject a mouse event, the event will be propagated to overlapping MouseArea items
propagated to other mouse areas. If this property is true and the handlers of the
\l{MouseArea::}{clicked}, \l{MouseArea::}{doubleClicked} or \l{MouseArea::}{pressAndHold}
signals reject a mouse event, the event will be propagated to overlapping MouseArea items
in the same area that are lower in the stacking order.
\li New \l{MouseArea::}{cursorShape} property controls the cursor shape.
\endlist

View File

@ -271,10 +271,10 @@ QQuickCanvasItemPrivate::~QQuickCanvasItemPrivate()
\li Replace all HTML event handlers with the MouseArea item.
\li Change setInterval/setTimeout function calls with the \l Timer item or
the use of requestAnimationFrame().
\li Place painting code into the onPaint handler and trigger
\li Place painting code into the \c onPaint handler and trigger
painting by calling the markDirty() or requestPaint() methods.
\li To draw images, load them by calling the Canvas's loadImage() method and then request to paint
them in the onImageLoaded handler.
them in the \c onImageLoaded handler.
\endlist
\sa Context2D
@ -843,10 +843,9 @@ void QQuickCanvasItem::requestPaint()
\qmlmethod QtQuick::Canvas::markDirty(rect area)
Mark the given \a area as dirty, so that when this area is visible the
canvas renderer will redraw it. This will trigger the onPaint signal
handler function.
canvas renderer will redraw it. This will trigger the \c paint signal.
\sa onPaint, requestPaint()
\sa paint, requestPaint()
*/
void QQuickCanvasItem::markDirty(const QRectF& rect)
@ -909,11 +908,11 @@ QQmlRefPointer<QQuickCanvasPixmap> QQuickCanvasItem::loadedPixmap(const QUrl& ur
\qmlmethod QtQuick::Canvas::loadImage(url image)
Loads the given \c image asynchronously.
When the image is ready, onImageLoaded will be emitted.
When the image is ready, \l imageLoaded will be emitted.
The loaded image can be unloaded by the unloadImage() method.
Note: Only loaded images can be painted on the Canvas item.
\sa unloadImage, onImageLoaded, isImageLoaded(),
\sa unloadImage, imageLoaded, isImageLoaded(),
Context2D::createImageData(), Context2D::drawImage()
*/
void QQuickCanvasItem::loadImage(const QUrl& url)
@ -940,7 +939,7 @@ void QQuickCanvasItem::loadImage(const QUrl& url)
Once an image is unloaded it cannot be painted by the canvas context
unless it is loaded again.
\sa loadImage(), onImageLoaded, isImageLoaded(),
\sa loadImage(), imageLoaded, isImageLoaded(),
Context2D::createImageData(), Context2D::drawImage
*/
void QQuickCanvasItem::unloadImage(const QUrl& url)

View File

@ -2916,7 +2916,7 @@ QV4::ReturnedValue QQuickJSContext2DPrototype::method_measureText(QV4::CallConte
\sa Image
\sa Canvas::loadImage
\sa Canvas::isImageLoaded
\sa Canvas::onImageLoaded
\sa Canvas::imageLoaded
\sa {http://www.w3.org/TR/2dcontext/#dom-context-2d-drawimage}{W3C 2d context standard for drawImage}
*/
@ -2936,7 +2936,7 @@ QV4::ReturnedValue QQuickJSContext2DPrototype::method_measureText(QV4::CallConte
\sa Image
\sa Canvas::loadImage()
\sa Canvas::isImageLoaded
\sa Canvas::onImageLoaded
\sa Canvas::imageLoaded
\sa {http://www.w3.org/TR/2dcontext/#dom-context-2d-drawimage}{W3C 2d context standard for drawImage}
*/
@ -2957,7 +2957,7 @@ QV4::ReturnedValue QQuickJSContext2DPrototype::method_measureText(QV4::CallConte
\sa Image
\sa Canvas::loadImage()
\sa Canvas::isImageLoaded
\sa Canvas::onImageLoaded
\sa Canvas::imageLoaded
\sa {http://www.w3.org/TR/2dcontext/#dom-context-2d-drawimage}{W3C 2d context standard for drawImage}
*/

View File

@ -1744,12 +1744,12 @@ void QQuickItemPrivate::updateSubFocusItem(QQuickItem *scope, bool focus)
\section2 Key Handling
Key handling is available to all Item-based visual types via the \l Keys
attached property. The \e Keys attached property provides basic handlers
such as \l {Keys::}{onPressed} and \l {Keys}{::onReleased}, as well as
handlers for specific keys, such as \l {Keys::}{onSpacePressed}. The
attached property. The \e Keys attached property provides basic signals
such as \l {Keys::}{pressed} and \l {Keys::}{released}, as well as
signals for specific keys, such as \l {Keys::}{spacePressed}. The
example below assigns \l {Keyboard Focus in Qt Quick}{keyboard focus} to
the item and handles the left key via the general \e onPressed handler
and the return key via the onReturnPressed handler:
the item and handles the left key via the general \c onPressed handler
and the return key via the \c onReturnPressed handler:
\qml
import QtQuick 2.0

View File

@ -373,7 +373,7 @@ bool QQuickMouseAreaPrivate::propagateHelper(QQuickMouseEvent *ev, QQuickItem *i
The corresponding handler is \c onReleased.
\sa onCanceled
\sa canceled
*/
/*!
@ -1237,7 +1237,7 @@ void QQuickMouseArea::setCursorShape(Qt::CursorShape shape)
\c drag.axis. For example, if \c anchors.left or \c anchors.right was set
for \c rect in the above example, it cannot be dragged along the X-axis.
This can be avoided by settng the anchor value to \c undefined in
an \l onPressed handler.
an \l {pressed}{onPressed} handler.
If \c drag.filterChildren is set to true, a drag can override descendant MouseAreas. This
enables a parent MouseArea to handle drags, for example, while descendants handle clicks:

View File

@ -2590,7 +2590,7 @@ bool QQuickTextPrivate::isLinkHoveredConnected()
embedded in the text. The link must be in rich text or HTML format
and the \a hoveredLink string provides access to the particular link.
\sa onLinkHovered, linkAt()
\sa linkHovered, linkAt()
*/
QString QQuickText::hoveredLink() const

View File

@ -2531,7 +2531,7 @@ bool QQuickTextEditPrivate::isLinkHoveredConnected()
embedded in the text. The link must be in rich text or HTML format
and the link string provides access to the particular link.
\sa onLinkHovered, linkAt()
\sa linkHovered, linkAt()
*/
QString QQuickTextEdit::hoveredLink() const