1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QSHORTCUTMAP_P_H
43#define QSHORTCUTMAP_P_H
44
45//
46// W A R N I N G
47// -------------
48//
49// This file is not part of the Qt API. It exists purely as an
50// implementation detail. This header file may change from version to
51// version without notice, or even be removed.
52//
53// We mean it.
54//
55
56#include "QtGui/qkeysequence.h"
57#include "QtCore/qvector.h"
58#include "QtCore/qscopedpointer.h"
59
60QT_BEGIN_NAMESPACE
61
62#ifndef QT_NO_SHORTCUT
63
64// To enable dump output uncomment below
65//#define Dump_QShortcutMap
66
67class QKeyEvent;
68struct QShortcutEntry;
69class QShortcutMapPrivate;
70class QGraphicsWidget;
71class QWidget;
72class QAction;
73class QObject;
74
75class QShortcutMap
76{
77 Q_DECLARE_PRIVATE(QShortcutMap)
78public:
79 QShortcutMap();
80 ~QShortcutMap();
81
82 int addShortcut(QObject *owner, const QKeySequence &key, Qt::ShortcutContext context);
83 int removeShortcut(int id, QObject *owner, const QKeySequence &key = QKeySequence());
84 int setShortcutEnabled(bool enable, int id, QObject *owner, const QKeySequence &key = QKeySequence());
85 int setShortcutAutoRepeat(bool on, int id, QObject *owner, const QKeySequence &key = QKeySequence());
86
87 void resetState();
88 QKeySequence::SequenceMatch nextState(QKeyEvent *e);
89 QKeySequence::SequenceMatch state();
90 void dispatchEvent(QKeyEvent *e);
91 bool tryShortcutEvent(QObject *o, QKeyEvent *e);
92
93#ifdef Dump_QShortcutMap
94 void dumpMap() const;
95#endif
96
97 bool hasShortcutForKeySequence(const QKeySequence &seq) const;
98
99
100private:
101 bool correctWidgetContext(Qt::ShortcutContext context, QWidget *w, QWidget *active_window) const;
102#ifndef QT_NO_GRAPHICSVIEW
103 bool correctGraphicsWidgetContext(Qt::ShortcutContext context, QGraphicsWidget *w, QWidget *active_window) const;
104#endif
105#ifndef QT_NO_ACTION
106 bool correctContext(Qt::ShortcutContext context,QAction *a, QWidget *active_window) const;
107#endif
108 QScopedPointer<QShortcutMapPrivate> d_ptr;
109
110 QKeySequence::SequenceMatch find(QKeyEvent *e);
111 QKeySequence::SequenceMatch matches(const QKeySequence &seq1, const QKeySequence &seq2) const;
112 QVector<const QShortcutEntry *> matches() const;
113 void createNewSequences(QKeyEvent *e, QVector<QKeySequence> &ksl);
114 void clearSequence(QVector<QKeySequence> &ksl);
115 bool correctContext(const QShortcutEntry &item) const;
116 int translateModifiers(Qt::KeyboardModifiers modifiers);
117};
118
119#endif // QT_NO_SHORTCUT
120
121QT_END_NAMESPACE
122
123#endif // QSHORTCUTMAP_P_H
124