1/****************************************************************************
2**
3** Copyright (C) 2018 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQuick module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qquickhoverhandler_p.h"
41#include <private/qquicksinglepointhandler_p_p.h>
42
43QT_BEGIN_NAMESPACE
44
45Q_LOGGING_CATEGORY(lcHoverHandler, "qt.quick.handler.hover")
46
47/*!
48 \qmltype HoverHandler
49 \instantiates QQuickHoverHandler
50 \inqmlmodule QtQuick
51 \ingroup qtquick-input-handlers
52 \brief Handler for mouse and tablet hover.
53
54 HoverHandler detects a hovering cursor. Since touchscreens don't generally
55 offer hover events, in practice it detects a hovering mouse or tablet stylus.
56
57 \sa MouseArea
58*/
59
60QQuickHoverHandler::QQuickHoverHandler(QQuickItem *parent)
61 : QQuickSinglePointHandler(parent)
62{
63 // Tell QQuickPointerDeviceHandler::wantsPointerEvent() to ignore button state
64 d_func()->acceptedButtons = Qt::NoButton;
65 // Rule out the touchscreen for now (can be overridden in QML in case a hover-detecting touchscreen exists)
66 setAcceptedDevices(static_cast<QQuickPointerDevice::DeviceType>(
67 static_cast<int>(QQuickPointerDevice::AllDevices) ^ static_cast<int>(QQuickPointerDevice::TouchScreen)));
68}
69
70QQuickHoverHandler::~QQuickHoverHandler()
71{
72 if (auto parent = parentItem())
73 QQuickItemPrivate::get(parent)->setHasHoverInChild(false);
74}
75
76void QQuickHoverHandler::componentComplete()
77{
78 parentItem()->setAcceptHoverEvents(true);
79 QQuickItemPrivate::get(parentItem())->setHasHoverInChild(true);
80}
81
82bool QQuickHoverHandler::wantsPointerEvent(QQuickPointerEvent *event)
83{
84 QQuickEventPoint *point = event->point(0);
85 if (QQuickPointerDeviceHandler::wantsPointerEvent(event) && wantsEventPoint(point) && parentContains(point)) {
86 // assume this is a mouse event, so there's only one point
87 setPointId(point->pointId());
88 return true;
89 }
90 setHovered(false);
91 return false;
92}
93
94void QQuickHoverHandler::handleEventPoint(QQuickEventPoint *point)
95{
96 setHovered(true);
97 setPassiveGrab(point);
98}
99
100void QQuickHoverHandler::setHovered(bool hovered)
101{
102 if (m_hovered != hovered) {
103 qCDebug(lcHoverHandler) << objectName() << "hovered" << m_hovered << "->" << hovered;
104 m_hovered = hovered;
105 emit hoveredChanged();
106 }
107}
108
109QT_END_NAMESPACE
110