aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@qt.io>2018-02-19 15:10:10 +0100
committerMartin Smith <martin.smith@qt.io>2018-02-23 13:05:16 +0000
commit485e183062043b39c0b6ec57caee7032dfffc5b0 (patch)
tree6a15414169658b1548b061b0a6970c2ca09f78d8 /src
parent5475f84af82668e25d40a31ad9c6ede438bf7dfe (diff)
doc: Correct mostly linking errors
This update corrects many qdoc warnings, mostly of the "Can't link to..." variety, but there were also a few qdoc comments added. As of this update, the qdoc warning count is 46 in QtDeclarative. Change-Id: Icf2d34c7ce7010ebfd9b474feacfe8af42f3fd5f Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/qml/doc/src/includes/qqmlcomponent.qdoc4
-rw-r--r--src/qml/doc/src/qmlfunctions.qdoc2
-rw-r--r--src/qml/qml/qqmlcontext.cpp2
-rw-r--r--src/qml/qml/qqmlextensionplugin.cpp2
-rw-r--r--src/quick/handlers/qquickdraghandler.cpp9
-rw-r--r--src/quick/handlers/qquickpointerdevicehandler.cpp6
-rw-r--r--src/quick/handlers/qquickpointerhandler.cpp6
-rw-r--r--src/quick/handlers/qquickpointhandler.cpp39
-rw-r--r--src/quick/handlers/qquicksinglepointhandler.cpp7
-rw-r--r--src/quick/items/qquickevents.cpp133
10 files changed, 130 insertions, 80 deletions
diff --git a/src/qml/doc/src/includes/qqmlcomponent.qdoc b/src/qml/doc/src/includes/qqmlcomponent.qdoc
index 0eb60ed743..6949d8823a 100644
--- a/src/qml/doc/src/includes/qqmlcomponent.qdoc
+++ b/src/qml/doc/src/includes/qqmlcomponent.qdoc
@@ -52,7 +52,7 @@
Ensure that the URL provided is full and correct, in particular, use
\l QUrl::fromLocalFile() when loading a file from the local filesystem.
-Relative paths will be resolved against the engine's
-\l {QQmlEngine::baseUrl}{baseUrl()}, which is the current working directory
+Relative paths will be resolved against
+\l {QQmlEngine::baseUrl}{QQmlEngine::baseUrl()}, which is the current working directory
unless specified.
//! [url-note]
diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc
index f939ddbcf3..ede213b84a 100644
--- a/src/qml/doc/src/qmlfunctions.qdoc
+++ b/src/qml/doc/src/qmlfunctions.qdoc
@@ -349,7 +349,7 @@
*/
/*!
- \fn Object *qmlAttachedPropertiesObject(const QObject *attachee, bool create = true)
+ \fn template<typename T> QObject *qmlAttachedPropertiesObject(const QObject *attachee, bool create = true)
\relates QQmlEngine
The form of this template function is:
diff --git a/src/qml/qml/qqmlcontext.cpp b/src/qml/qml/qqmlcontext.cpp
index 0b0132fab7..82b8d06dc4 100644
--- a/src/qml/qml/qqmlcontext.cpp
+++ b/src/qml/qml/qqmlcontext.cpp
@@ -370,7 +370,7 @@ void QQmlContext::setContextProperties(const QVector<PropertyPair> &properties)
This struct contains a property name and a property value.
It is used as a parameter for the \c setContextProperties function.
- \sa QQQmlContext::setContextProperties()
+ \sa QQmlContext::setContextProperties()
*/
/*!
diff --git a/src/qml/qml/qqmlextensionplugin.cpp b/src/qml/qml/qqmlextensionplugin.cpp
index b0e6a24616..818ff7c34f 100644
--- a/src/qml/qml/qqmlextensionplugin.cpp
+++ b/src/qml/qml/qqmlextensionplugin.cpp
@@ -121,7 +121,9 @@ void QQmlExtensionPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
\class QQmlExtensionInterface
\internal
\inmodule QtQml
+*/
+/*!
\class QQmlTypesExtensionInterface
\internal
\inmodule QtQml
diff --git a/src/quick/handlers/qquickdraghandler.cpp b/src/quick/handlers/qquickdraghandler.cpp
index 5180a840ca..a4c3d3dfb1 100644
--- a/src/quick/handlers/qquickdraghandler.cpp
+++ b/src/quick/handlers/qquickdraghandler.cpp
@@ -59,14 +59,15 @@ QT_BEGIN_NAMESPACE
It has properties to restrict the range of dragging.
- If it is declared within one Item but is assigned a different \l target,
- then it handles events within the bounds of the \l parent Item but
+ If it is declared within one Item but is assigned a different
+ \l {PointerHandler::target}, then it handles events within the
+ bounds of the \l {PointerHandler::parent} Item but
manipulates the \c target Item instead:
\snippet pointerHandlers/dragHandlerDifferentTarget.qml 0
- A third way to use it is to set \l target to \c null and react to property
- changes in some other way:
+ A third way to use it is to set \l {PointerHandler::target} to
+ \c null and react to property changes in some other way:
\snippet pointerHandlers/dragHandlerNullTarget.qml 0
diff --git a/src/quick/handlers/qquickpointerdevicehandler.cpp b/src/quick/handlers/qquickpointerdevicehandler.cpp
index 1521b58d57..06831613b6 100644
--- a/src/quick/handlers/qquickpointerdevicehandler.cpp
+++ b/src/quick/handlers/qquickpointerdevicehandler.cpp
@@ -75,7 +75,8 @@ QQuickPointerDeviceHandler::~QQuickPointerDeviceHandler()
The types of pointing devices that can activate this Pointer Handler.
- By default, this property is set to \l PointerDevice.AllDevices.
+ By default, this property is set to
+ \l{QtQuick::PointerDevice::type} {PointerDevice.AllDevices}.
If you set it to an OR combination of device types, it will ignore events
from non-matching devices.
@@ -110,7 +111,8 @@ void QQuickPointerDeviceHandler::setAcceptedDevices(QQuickPointerDevice::DeviceT
The types of pointing instruments (finger, stylus, eraser, etc.)
that can activate this Pointer Handler.
- By default, this property is set to \l PointerDevice.AllPointerTypes.
+ By default, this property is set to
+ \l {QtQuick::PointerDevice::pointerType} {PointerDevice.AllPointerTypes}.
If you set it to an OR combination of device types, it will ignore events
from non-matching events.
diff --git a/src/quick/handlers/qquickpointerhandler.cpp b/src/quick/handlers/qquickpointerhandler.cpp
index d6d3a52d95..959030b8fe 100644
--- a/src/quick/handlers/qquickpointerhandler.cpp
+++ b/src/quick/handlers/qquickpointerhandler.cpp
@@ -319,7 +319,7 @@ void QQuickPointerHandler::setEnabled(bool enabled)
The Item which this handler will manipulate.
- By default, it is the same as the \l parent: the Item within which
+ By default, it is the same as the \l [QML] {parent}, the Item within which
the handler is declared. However, it can sometimes be useful to set the
target to a different Item, in order to handle events within one item
but manipulate another; or to \c null, to disable the default behavior
@@ -402,10 +402,10 @@ void QQuickPointerHandler::handlePointerEventImpl(QQuickPointerEvent *event)
The \l Item which is the scope of the handler; the Item in which it was declared.
The handler will handle events on behalf of this Item, which means a
pointer event is relevant if at least one of its event points occurs within
- the Item's interior. Initially \l target() is the same, but target()
+ the Item's interior. Initially \l [QML] {target} {target()} is the same, but it
can be reassigned.
- \sa QQuick::PointerHandler::target(), QObject::parent()
+ \sa {target}, QObject::parent()
*/
/*!
diff --git a/src/quick/handlers/qquickpointhandler.cpp b/src/quick/handlers/qquickpointhandler.cpp
index ed03685252..7e2d40452c 100644
--- a/src/quick/handlers/qquickpointhandler.cpp
+++ b/src/quick/handlers/qquickpointhandler.cpp
@@ -54,19 +54,22 @@ QT_BEGIN_NAMESPACE
PointHandler can be used to show feedback about a touchpoint or the mouse
position, or to otherwise react to pointer events.
- When a press event occurs, each instance of PointHandler chooses a single
- point which is not yet "taken" at that moment: if the press occurs within
- the bounds of the \l parent, and no sibling PointHandler within the same
- \l parent has yet acquired a passive grab on that point, and if the other
- constraints such as \l acceptedMouseButtons, \l acceptedDevices etc. are
- satisfied, it's eligible, and the PointHandler then acquires a passive
- grab. In this way, the \l parent acts like an exclusive group: there can be
- multiple instances of PointHandler, and the set of pressed touchpoints will
- be distributed among them. Each PointHandler which has chosen a point to
- track has its \l active property \c true. It then continues to track its
- chosen point until release: the properties of the \l point will be kept
- up-to-date. Any Item can bind to these properties, and thereby follow the
- point's movements.
+ When a press event occurs, each instance of PointHandler chooses a
+ single point which is not yet "taken" at that moment: if the press
+ occurs within the bounds of the \l {PointerHandler::parent}, and
+ no sibling PointHandler within the same \l {PointerHandler::parent}
+ has yet acquired a passive grab on that point, and if the other
+ constraints such as \l {SinglePointHandler::acceptedButtons},
+ \l {PointerDeviceHandler::acceptedDevices} etc. are satisfied, it's
+ eligible, and the PointHandler then acquires a passive grab. In
+ this way, the \l {PointerHandler::parent} acts like an exclusive
+ group: there can be multiple instances of PointHandler, and the
+ set of pressed touchpoints will be distributed among them. Each
+ PointHandler which has chosen a point to track has its \l active
+ property \c true. It then continues to track its chosen point
+ until release: the properties of the \l point will be kept
+ up-to-date. Any Item can bind to these properties, and thereby
+ follow the point's movements.
By being only a passive grabber, it has the ability to keep independent
oversight of all movements. The passive grab cannot be stolen or overridden
@@ -81,11 +84,11 @@ QT_BEGIN_NAMESPACE
types, and thus sets itself up as a potential event delivery bottleneck.
One possible use case is to add this handler to a transparent Item which is
- on top of the rest of the scene (by having a high \l z value), so that when
- a point is freshly pressed, it will be delivered to that Item and its
- handlers first, providing the opportunity to take the passive grab as early
- as possible. Such an item (like a pane of glass over the whole UI) can be a
- convenient parent for other Items which visualize the kind of reactive
+ on top of the rest of the scene (by having a high \l{Item::z} {z} value),
+ so that when a point is freshly pressed, it will be delivered to that Item
+ and its handlers first, providing the opportunity to take the passive grab
+ as early as possible. Such an item (like a pane of glass over the whole UI)
+ can be a convenient parent for other Items which visualize the kind of reactive
feedback which must always be on top; and likewise it can be the parent for
popups, popovers, dialogs and so on. If it will be used in that way, it can
be helpful for your main.cpp to use QQmlContext::setContextProperty() to
diff --git a/src/quick/handlers/qquicksinglepointhandler.cpp b/src/quick/handlers/qquicksinglepointhandler.cpp
index dee168a8e4..8b1d8c11b9 100644
--- a/src/quick/handlers/qquicksinglepointhandler.cpp
+++ b/src/quick/handlers/qquicksinglepointhandler.cpp
@@ -217,7 +217,7 @@ void QQuickSinglePointHandler::moveTarget(QPointF pos, QQuickEventPoint *point)
The mouse buttons which can activate this Pointer Handler.
- By default, this property is set to \l Qt.LeftButton.
+ By default, this property is set to \l {QtQuick::MouseEvent::button} {Qt.LeftButton}.
It can be set to an OR combination of mouse buttons, and will ignore events
from other buttons.
@@ -360,7 +360,8 @@ void QQuickHandlerPoint::reset()
\qmlproperty QPointF QtQuick::HandlerPoint::position
\brief The position within the \c parent Item
- This is the position of the event point relative to the bounds of the \l parent.
+ This is the position of the event point relative to the bounds of
+ the \l {PointerHandler::parent} {parent}.
*/
/*!
@@ -378,7 +379,7 @@ void QQuickHandlerPoint::reset()
\brief The pressed position within the \c parent Item
This is the position at which this point was pressed, relative to the
- bounds of the \l parent.
+ bounds of the \l {PointerHandler::parent} {parent}.
*/
/*!
diff --git a/src/quick/items/qquickevents.cpp b/src/quick/items/qquickevents.cpp
index 827ec78b9e..40d1fab3dc 100644
--- a/src/quick/items/qquickevents.cpp
+++ b/src/quick/items/qquickevents.cpp
@@ -134,13 +134,13 @@ Item {
It contains a bitwise combination of:
\list
- \li Qt.NoModifier - No modifier key is pressed.
- \li Qt.ShiftModifier - A Shift key on the keyboard is pressed.
- \li Qt.ControlModifier - A Ctrl key on the keyboard is pressed.
- \li Qt.AltModifier - An Alt key on the keyboard is pressed.
- \li Qt.MetaModifier - A Meta key on the keyboard is pressed.
- \li Qt.KeypadModifier - A keypad button is pressed.
- \li Qt.GroupSwitchModifier - X11 only. A Mode_switch key on the keyboard is pressed.
+ \li \l {Qt::NoModifier} {Qt.NoModifier} - No modifier key is pressed.
+ \li \l {Qt::ShiftModifier} {Qt.ShiftModifier} - A Shift key on the keyboard is pressed.
+ \li \l {Qt::ControlModifier} {Qt.ControlModifier} - A Ctrl key on the keyboard is pressed.
+ \li \l {Qt::AltModifier} {Qt.AltModifier} - An Alt key on the keyboard is pressed.
+ \li \l {Qt::MetaModifier} {Qt.MetaModifier} - A Meta key on the keyboard is pressed.
+ \li \l {Qt::KeypadModifier} {Qt.KeypadModifier} - A keypad button is pressed.
+ \li \l {Qt::GroupSwitchModifier} {Qt.GroupSwitchModifier} - X11 only. A Mode_switch key on the keyboard is pressed.
\endlist
For example, to react to a Shift key + Enter key combination:
@@ -184,7 +184,7 @@ Item {
\brief Provides information about a mouse event
- The position of the mouse can be found via the \l x and \l y properties.
+ The position of the mouse can be found via the \l {Item::x} {x} and \l {Item::y} {y} properties.
The button that caused the event is available via the \l button property.
\sa MouseArea
@@ -218,17 +218,17 @@ Item {
This property holds the button that caused the event. It can be one of:
\list
- \li Qt.LeftButton
- \li Qt.RightButton
- \li Qt.MiddleButton
+ \li \l {Qt::LeftButton} {Qt.LeftButton}
+ \li \l {Qt::RightButton} {Qt.RightButton}
+ \li \l {Qt::MiddleButton} {Qt.MiddleButton}
\endlist
*/
/*!
\qmlproperty bool QtQuick::MouseEvent::wasHeld
- This property is true if the mouse button has been held pressed longer the
- threshold (800ms).
+ This property is true if the mouse button has been held pressed longer
+ than the threshold (800ms).
*/
/*!
@@ -241,9 +241,9 @@ Item {
It contains a bitwise combination of:
\list
- \li Qt.LeftButton
- \li Qt.RightButton
- \li Qt.MiddleButton
+ \li \l {Qt::LeftButton} {Qt.LeftButton}
+ \li \l {Qt::RightButton} {Qt.RightButton}
+ \li \l {Qt::MiddleButton} {Qt.MiddleButton}
\endlist
*/
@@ -255,12 +255,12 @@ Item {
It contains a bitwise combination of:
\list
- \li Qt.NoModifier - No modifier key is pressed.
- \li Qt.ShiftModifier - A Shift key on the keyboard is pressed.
- \li Qt.ControlModifier - A Ctrl key on the keyboard is pressed.
- \li Qt.AltModifier - An Alt key on the keyboard is pressed.
- \li Qt.MetaModifier - A Meta key on the keyboard is pressed.
- \li Qt.KeypadModifier - A keypad button is pressed.
+ \li \l {Qt::NoModifier} {Qt.NoModifier} - No modifier key is pressed.
+ \li \l {Qt::ShiftModifier} {Qt.ShiftModifier} - A Shift key on the keyboard is pressed.
+ \li \l {Qt::ControlModifier} {Qt.ControlModifier} - A Ctrl key on the keyboard is pressed.
+ \li \l {Qt::AltModifier} {Qt.AltModifier} - An Alt key on the keyboard is pressed.
+ \li \l {Qt::MetaModifier} {Qt.MetaModifier} - A Meta key on the keyboard is pressed.
+ \li \l {Qt::KeypadModifier} {Qt.KeypadModifier} - A keypad button is pressed.
\endlist
For example, to react to a Shift key + Left mouse button click:
@@ -288,20 +288,24 @@ Item {
The value can be one of:
- \value Qt.MouseEventNotSynthesized The most common value. On platforms where
- such information is available, this value indicates that the event
- represents a genuine mouse event from the system.
+ \list
+ \li \l{Qt::MouseEventNotSynthesized} {Qt.MouseEventNotSynthesized}
+ - The most common value. On platforms where such information is
+ available, this value indicates that the event represents a genuine
+ mouse event from the system.
- \value Qt.MouseEventSynthesizedBySystem Indicates that the mouse event was
+ \li \l{Qt::MouseEventSynthesizedBySystem} {Qt.MouseEventSynthesizedBySystem} - Indicates that the mouse event was
synthesized from a touch or tablet event by the platform.
- \value Qt.MouseEventSynthesizedByQt Indicates that the mouse event was
- synthesized from an unhandled touch or tablet event by Qt.
+ \li \l{Qt::MouseEventSynthesizedByQt} {Qt.MouseEventSynthesizedByQt}
+ - Indicates that the mouse event was synthesized from an unhandled
+ touch or tablet event by Qt.
- \value Qt.MouseEventSynthesizedByApplication Indicates that the mouse event
- was synthesized by the application. This allows distinguishing
- application-generated mouse events from the ones that are coming from the
- system or are synthesized by Qt.
+ \li \l{Qt::MouseEventSynthesizedByApplication} {Qt.MouseEventSynthesizedByApplication}
+ - Indicates that the mouse event was synthesized by the application.
+ This allows distinguishing application-generated mouse events from
+ the ones that are coming from the system or are synthesized by Qt.
+ \endlist
For example, to react only to events which come from an actual mouse:
\qml
@@ -332,9 +336,12 @@ Item {
This property holds the flags that provide additional information about the
mouse event.
- \value Qt.MouseEventCreatedDoubleClick Indicates that Qt has created a
- double click event from this event. This flag is set in the event originating
- from a button press, and not in the resulting double click event.
+ \list
+ \li \l {Qt::MouseEventCreatedDoubleClick} {Qt.MouseEventCreatedDoubleClick}
+ - Indicates that Qt has created a double click event from this event.
+ This flag is set in the event originating from a button press, and not
+ in the resulting double click event.
+ \endlist
*/
/*!
@@ -344,7 +351,8 @@ Item {
\ingroup qtquick-input-events
\brief Provides information about a mouse wheel event
- The position of the mouse can be found via the \l x and \l y properties.
+ The position of the mouse can be found via the
+ \l {Item::x} {x} and \l {Item::y} {y} properties.
\sa MouseArea
*/
@@ -378,9 +386,9 @@ Item {
It contains a bitwise combination of:
\list
- \li Qt.LeftButton
- \li Qt.RightButton
- \li Qt.MiddleButton
+ \li \l {Qt::LeftButton} {Qt.LeftButton}
+ \li \l {Qt::RightButton} {Qt.RightButton}
+ \li \l {Qt::MiddleButton} {Qt.MiddleButton}
\endlist
*/
@@ -418,12 +426,12 @@ Item {
It contains a bitwise combination of:
\list
- \li Qt.NoModifier - No modifier key is pressed.
- \li Qt.ShiftModifier - A Shift key on the keyboard is pressed.
- \li Qt.ControlModifier - A Ctrl key on the keyboard is pressed.
- \li Qt.AltModifier - An Alt key on the keyboard is pressed.
- \li Qt.MetaModifier - A Meta key on the keyboard is pressed.
- \li Qt.KeypadModifier - A keypad button is pressed.
+ \li \l {Qt::NoModifier} {Qt.NoModifier} - No modifier key is pressed.
+ \li \l {Qt::ShiftModifier} {Qt.ShiftModifier} - A Shift key on the keyboard is pressed.
+ \li \l {Qt::ControlModifier} {Qt.ControlModifier} - A Ctrl key on the keyboard is pressed.
+ \li \l {Qt::AltModifier} {Qt.AltModifier} - An Alt key on the keyboard is pressed.
+ \li \l {Qt::MetaModifier} {Qt.MetaModifier} - A Meta key on the keyboard is pressed.
+ \li \l {Qt::KeypadModifier} {Qt.KeypadModifier} - A keypad button is pressed.
\endlist
For example, to react to a Control key pressed during the wheel event:
@@ -497,13 +505,46 @@ Item {
\l {QTabletEvent::tangentialPressure}{tangentialPressure}
\value DeviceType.Puck
a device that is similar to a flat mouse with a
- transparent circle with cross-hairs (same as \l QTabletEvent::Puck)
+ transparent circle with cross-hairs
+ (same as \l {QTabletEvent::Puck} {Puck})
+ \value DeviceType.AllDevices
+ any of the above; used as a default value for construction
\sa QTouchDevice::DeviceType
*/
/*!
\readonly
+ \qmlproperty enumeration QtQuick::PointerDevice::pointerType
+
+ This property holds a value indicating what is interacting with
+ the device. Think of the device as having a planar 2D surface, and
+ the value of this property as identifying what interacts with the
+ device.
+
+ There is some redundancy between this property and \l {PointerDevice::type}.
+ If a tocuchscreen is used, then the device is TouchScreen and
+ pointerType is Finger (always).
+
+ Valid values are:
+
+ \value PointerDevice.GenericPointer
+ a mouse or something acting like a mouse (the core pointer on X11)
+ \value PointerDevice.Finger
+ the user's finger
+ \value PointerDevice.Pen
+ the drawing end of a stylus
+ \value PointerDevice.Eraser
+ the other end of the stylus (if it has a virtual eraser on the other end)
+ \value PointerDevice.Cursor
+ a cursor in the pre-computer sense of the word
+ \value PointerDevice.AllPointerTypes
+ any of the above (used as a default value in constructors)
+*/
+
+
+/*!
+ \readonly
\qmlproperty enumeration QtQuick::PointerDevice::capabilities
This property holds a bitwise combination of the capabilities of the