1/****************************************************************************
2**
3** Copyright (C) 2016 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#ifndef QQUICKSHORTCUT_P_H
41#define QQUICKSHORTCUT_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/qobject.h>
55#include <QtCore/qvector.h>
56#include <QtCore/qvariant.h>
57#include <QtGui/qkeysequence.h>
58#include <QtQml/qqmlparserstatus.h>
59
60QT_BEGIN_NAMESPACE
61
62class QShortcutEvent;
63
64class QQuickShortcut : public QObject, public QQmlParserStatus
65{
66 Q_OBJECT
67 Q_INTERFACES(QQmlParserStatus)
68 Q_PROPERTY(QVariant sequence READ sequence WRITE setSequence NOTIFY sequenceChanged FINAL)
69 Q_PROPERTY(QVariantList sequences READ sequences WRITE setSequences NOTIFY sequencesChanged FINAL REVISION 9)
70 Q_PROPERTY(QString nativeText READ nativeText NOTIFY sequenceChanged FINAL REVISION 1)
71 Q_PROPERTY(QString portableText READ portableText NOTIFY sequenceChanged FINAL REVISION 1)
72 Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled NOTIFY enabledChanged FINAL)
73 Q_PROPERTY(bool autoRepeat READ autoRepeat WRITE setAutoRepeat NOTIFY autoRepeatChanged FINAL)
74 Q_PROPERTY(Qt::ShortcutContext context READ context WRITE setContext NOTIFY contextChanged FINAL)
75
76public:
77 explicit QQuickShortcut(QObject *parent = nullptr);
78 ~QQuickShortcut();
79
80 QVariant sequence() const;
81 void setSequence(const QVariant &sequence);
82
83 QVariantList sequences() const;
84 void setSequences(const QVariantList &sequences);
85
86 QString nativeText() const;
87 QString portableText() const;
88
89 bool isEnabled() const;
90 void setEnabled(bool enabled);
91
92 bool autoRepeat() const;
93 void setAutoRepeat(bool repeat);
94
95 Qt::ShortcutContext context() const;
96 void setContext(Qt::ShortcutContext context);
97
98Q_SIGNALS:
99 void sequenceChanged();
100 Q_REVISION(9) void sequencesChanged();
101 void enabledChanged();
102 void autoRepeatChanged();
103 void contextChanged();
104
105 void activated();
106 void activatedAmbiguously();
107
108protected:
109 void classBegin() override;
110 void componentComplete() override;
111 bool event(QEvent *event) override;
112
113 struct Shortcut {
114 Shortcut() : id(0) { }
115 bool matches(QShortcutEvent *event) const;
116 int id;
117 QVariant userValue;
118 QKeySequence keySequence;
119 };
120
121 void setEnabled(Shortcut &shortcut, bool enabled);
122 void setAutoRepeat(Shortcut &shortcut, bool repeat);
123
124 void grabShortcut(Shortcut &shortcut, Qt::ShortcutContext context);
125 void ungrabShortcut(Shortcut &shortcut);
126
127private:
128 bool m_enabled;
129 bool m_completed;
130 bool m_autorepeat;
131 Qt::ShortcutContext m_context;
132 Shortcut m_shortcut;
133 QVector<Shortcut> m_shortcuts;
134};
135
136QT_END_NAMESPACE
137
138#endif // QQUICKSHORTCUT_P_H
139