From 3856f9509fc7c236df3837e653fb994d08be7e58 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Fri, 11 Aug 2017 11:15:04 +0200 Subject: Doc: Fix PointerHandler QML docs qquickpinchhandler.cpp:138: warning: Missing property type for QQuickPinchHandler::minimumX qquickpinchhandler.cpp:151: warning: Missing property type for QQuickPinchHandler::maximumX qquickpinchhandler.cpp:164: warning: Missing property type for QQuickPinchHandler::minimumY qquickpinchhandler.cpp:177: warning: Missing property type for QQuickPinchHandler::maximumY qquickpinchhandler.cpp:194: warning: Missing property type for QQuickPinchHandler::minimumTouchPoints qquickpinchhandler.cpp:198: warning: Missing property type for QQuickPinchHandler::active qquickpointerdevicehandler.cpp:107: warning: Missing property type for QQuickPointerDeviceHandler::acceptedModifiers qquickpointerhandler.cpp:47: warning: C++ class QQuickPointerHandler not found: \instantiates QQuickPointerHandler qquickpointerhandler.cpp:176: warning: Missing property type for QQuickPointerHandler::enabled qquickpointerhandler.cpp:255: warning: Missing property type for QQuickPointerHandler::parent qquicktaphandler.cpp:175: warning: Missing property type for longPressThreshold qquicktaphandler.cpp:235: warning: Missing property type for gesturePolicy qquicktaphandler.cpp:252: warning: Missing property type for pressed qquicktaphandler.cpp:329: warning: Missing '\endqml' qquicktaphandler.cpp:340: warning: Missing property type for tapCount qquicktaphandler.cpp:353: warning: Missing property type for timeHeld Change-Id: I8a5bd0ec7c5603573f39f5b5f1f24d5735ba98dd Reviewed-by: Shawn Rutledge --- src/quick/handlers/qquicktaphandler.cpp | 71 ++++++++++++++++++--------------- 1 file changed, 39 insertions(+), 32 deletions(-) (limited to 'src/quick/handlers/qquicktaphandler.cpp') diff --git a/src/quick/handlers/qquicktaphandler.cpp b/src/quick/handlers/qquicktaphandler.cpp index 272c6de000..1bcf42a073 100644 --- a/src/quick/handlers/qquicktaphandler.cpp +++ b/src/quick/handlers/qquicktaphandler.cpp @@ -56,7 +56,7 @@ int QQuickTapHandler::m_touchMultiTapDistanceSquared(-1); \instantiates QQuickTapHandler \inqmlmodule QtQuick \ingroup qtquick-handlers - \brief Handler for taps and clicks + \brief Handler for taps and clicks. TapHandler is a handler for taps on a touchscreen or clicks on a mouse. @@ -65,9 +65,9 @@ int QQuickTapHandler::m_touchMultiTapDistanceSquared(-1); whether the press and release occur close together: if you press the button and then change your mind, you need to drag all the way off the edge of the button in order to cancel the click. Therefore the default - \l gesturePolicy is \l ReleaseWithinBounds. If you want to require + \l gesturePolicy is \c TapHandler.ReleaseWithinBounds. If you want to require that the press and release are close together in both space and time, - set it to \l DragThreshold. + set it to \c TapHandler.DragThreshold. For multi-tap gestures (double-tap, triple-tap etc.), the distance moved must not exceed QPlatformTheme::MouseDoubleClickDistance with mouse and @@ -164,7 +164,7 @@ void QQuickTapHandler::handleEventPoint(QQuickEventPoint *point) } /*! - \qmlproperty longPressThreshold + \qmlproperty real TapHandler::longPressThreshold The time in seconds that an event point must be pressed in order to trigger a long press gesture and emit the \l longPressed() signal. @@ -202,7 +202,7 @@ void QQuickTapHandler::timerEvent(QTimerEvent *event) } /*! - \qmlproperty gesturePolicy + \qmlproperty enumeration TapHandler::gesturePolicy The spatial constraint for a tap or long press gesture to be recognized, in addition to the constraint that the release must occur before @@ -211,26 +211,30 @@ void QQuickTapHandler::timerEvent(QTimerEvent *event) If the spatial constraint is violated, \l isPressed transitions immediately from true to false, regardless of the time held. - \c DragThreshold means that the event point must not move significantly. - If the mouse, finger or stylus moves past the system-wide drag threshold - (QStyleHints::startDragDistance), the tap gesture is canceled, even if - the button or finger is still pressed. This policy can be useful whenever - TapHandler needs to cooperate with other pointer handlers (for example - \l DragHandler), because in this case TapHandler will never grab. - - \c WithinBounds means that if the event point leaves the bounds of the - \l target item, the tap gesture is canceled. The TapHandler will grab on - press, but release the grab as soon as the boundary constraint is no - longer satisfied. - - \c ReleaseWithinBounds (the default value) means that at the time of release - (the mouse button is released or the finger is lifted), if the event point - is outside the bounds of the \l target item, a tap gesture is not - recognized. This is the default value, because it corresponds to typical - button behavior: you can cancel a click by dragging outside the button, and - you can also change your mind by dragging back inside the button before - release. Note that it's necessary for TapHandler to grab on press and - retain it until release (greedy grab) in order to detect this gesture. + \value TapHandler.DragThreshold + The event point must not move significantly. If the mouse, finger + or stylus moves past the system-wide drag threshold + (QStyleHints::startDragDistance), the tap gesture is canceled, even + if the button or finger is still pressed. This policy can be useful + whenever TapHandler needs to cooperate with other pointer handlers + (for example \l DragHandler), because in this case TapHandler will + never grab. + + \value TapHandler.WithinBounds + If the event point leaves the bounds of the \l target item, the tap + gesture is canceled. The TapHandler will grab on press, but release + the grab as soon as the boundary constraint is no longer satisfied. + + \value TapHandler.ReleaseWithinBounds + (the default value) At the time of release (the mouse button is + released or the finger is lifted), if the event point is outside + the bounds of the \l target item, a tap gesture is not recognized. + This is the default value, because it corresponds to typical button + behavior: you can cancel a click by dragging outside the button, + and you can also change your mind by dragging back inside the button + before release. Note that it's necessary for TapHandler to grab on + press and retain it until release (greedy grab) in order to detect + this gesture. */ void QQuickTapHandler::setGesturePolicy(QQuickTapHandler::GesturePolicy gesturePolicy) { @@ -242,12 +246,13 @@ void QQuickTapHandler::setGesturePolicy(QQuickTapHandler::GesturePolicy gestureP } /*! - \qmlproperty pressed + \qmlproperty bool TapHandler::pressed + \readonly - This property will be true whenever the mouse or touch point is pressed, + Holds true whenever the mouse or touch point is pressed, and any movement since the press is compliant with the current \l gesturePolicy. When the event point is released or the policy is - violated, pressed will change to false. + violated, \e pressed will change to false. */ void QQuickTapHandler::setPressed(bool press, bool cancel, QQuickEventPoint *point) { @@ -320,11 +325,11 @@ void QQuickTapHandler::updateTimeHeld() } /*! - \qmlproperty tapCount + \qmlproperty int TapHandler::tapCount The number of taps which have occurred within the time and space constraints to be considered a single gesture. For example, to detect - a double-tap, you can write + a double-tap, you can write: \qml Rectangle { @@ -335,10 +340,11 @@ void QQuickTapHandler::updateTimeHeld() onTapped: if (tapCount == 2) doubleTap() } } + \endqml */ /*! - \qmlproperty timeHeld + \qmlproperty real TapHandler::timeHeld The amount of time in seconds that a pressed point has been held, without moving beyond the drag threshold. It will be updated at least once per @@ -347,7 +353,8 @@ void QQuickTapHandler::updateTimeHeld() possible to trigger one of a series of actions depending on how long the press is held. - A value less than zero means no point is being held within this handler's Item. + A value of less than zero means no point is being held within this + handler's \l [QML] Item. */ QT_END_NAMESPACE -- cgit v1.2.3