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 QtGui 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 QSHORTCUTMAP_P_H
41#define QSHORTCUTMAP_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 <QtGui/private/qtguiglobal_p.h>
55#include "QtGui/qkeysequence.h"
56#include "QtCore/qlist.h"
57#include "QtCore/qscopedpointer.h"
58
59QT_REQUIRE_CONFIG(shortcut);
60
61QT_BEGIN_NAMESPACE
62
63// To enable dump output uncomment below
64//#define Dump_QShortcutMap
65
66class QKeyEvent;
67struct QShortcutEntry;
68class QShortcutMapPrivate;
69class QObject;
70
71class Q_GUI_EXPORT QShortcutMap
72{
73 Q_DECLARE_PRIVATE(QShortcutMap)
74public:
75 QShortcutMap();
76 ~QShortcutMap();
77
78 typedef bool (*ContextMatcher)(QObject *object, Qt::ShortcutContext context);
79
80 int addShortcut(QObject *owner, const QKeySequence &key, Qt::ShortcutContext context, ContextMatcher matcher);
81 int removeShortcut(int id, QObject *owner, const QKeySequence &key = QKeySequence());
82 int setShortcutEnabled(bool enable, int id, QObject *owner, const QKeySequence &key = QKeySequence());
83 int setShortcutAutoRepeat(bool on, int id, QObject *owner, const QKeySequence &key = QKeySequence());
84
85 QKeySequence::SequenceMatch state();
86
87 bool tryShortcut(QKeyEvent *e);
88 bool hasShortcutForKeySequence(const QKeySequence &seq) const;
89
90#ifdef Dump_QShortcutMap
91 void dumpMap() const;
92#endif
93
94private:
95 void resetState();
96 QKeySequence::SequenceMatch nextState(QKeyEvent *e);
97 void dispatchEvent(QKeyEvent *e);
98
99 QKeySequence::SequenceMatch find(QKeyEvent *e, int ignoredModifiers = 0);
100 QKeySequence::SequenceMatch matches(const QKeySequence &seq1, const QKeySequence &seq2) const;
101 QList<const QShortcutEntry *> matches() const;
102 void createNewSequences(QKeyEvent *e, QList<QKeySequence> &ksl, int ignoredModifiers);
103 void clearSequence(QList<QKeySequence> &ksl);
104 int translateModifiers(Qt::KeyboardModifiers modifiers);
105
106 QScopedPointer<QShortcutMapPrivate> d_ptr;
107};
108
109QT_END_NAMESPACE
110
111#endif // QSHORTCUTMAP_P_H
112