Qt 4.8
qshortcutmap_p.h
Go to the documentation of this file.
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 
61 
62 #ifndef QT_NO_SHORTCUT
63 
64 // To enable dump output uncomment below
65 //#define Dump_QShortcutMap
66 
67 class QKeyEvent;
68 struct QShortcutEntry;
70 class QGraphicsWidget;
71 class QWidget;
72 class QAction;
73 class QObject;
74 
76 {
78 public:
79  QShortcutMap();
80  ~QShortcutMap();
81 
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();
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 
100 private:
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
109 
111  QKeySequence::SequenceMatch matches(const QKeySequence &seq1, const QKeySequence &seq2) const;
115  bool correctContext(const QShortcutEntry &item) const;
116  int translateModifiers(Qt::KeyboardModifiers modifiers);
117 };
118 
119 #endif // QT_NO_SHORTCUT
120 
122 
123 #endif // QSHORTCUTMAP_P_H
The QKeyEvent class describes a key event.
Definition: qevent.h:224
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
int setShortcutEnabled(bool enable, int id, QObject *owner, const QKeySequence &key=QKeySequence())
Changes the enable state of a shortcut to enable.
void dispatchEvent(QKeyEvent *e)
Dispatches QShortcutEvents to widgets who grabbed the matched key sequence.
bool correctWidgetContext(Qt::ShortcutContext context, QWidget *w, QWidget *active_window) const
The QWidget class is the base class of all user interface objects.
Definition: qwidget.h:150
bool hasShortcutForKeySequence(const QKeySequence &seq) const
Determines if an enabled shortcut has a matcing key sequence.
long ASN1_INTEGER_get ASN1_INTEGER * a
QShortcutMap()
QShortcutMap constructor.
static QWidget * owner
The QVector class is a template class that provides a dynamic array.
Definition: qdatastream.h:64
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
QScopedPointer< QShortcutMapPrivate > d_ptr
QVector< const QShortcutEntry * > matches() const
Returns the vector of QShortcutEntry&#39;s matching the last Identical state.
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
QKeySequence::SequenceMatch nextState(QKeyEvent *e)
void createNewSequences(QKeyEvent *e, QVector< QKeySequence > &ksl)
Alters seq to the new sequence state, based on the current sequence state, and the new key event e...
QKeySequence::SequenceMatch find(QKeyEvent *e)
Returns the next state of the statemachine, based on the new key event e.
~QShortcutMap()
QShortcutMap destructor.
int setShortcutAutoRepeat(bool on, int id, QObject *owner, const QKeySequence &key=QKeySequence())
Changes the auto repeat state of a shortcut to enable.
int translateModifiers(Qt::KeyboardModifiers modifiers)
bool tryShortcutEvent(QObject *o, QKeyEvent *e)
Uses ShortcutOverride event to see if any widgets want to override the event.
The QKeySequence class encapsulates a key sequence as used by shortcuts.
Definition: qkeysequence.h:72
QKeySequence::SequenceMatch state()
int key
void clearSequence(QVector< QKeySequence > &ksl)
Clears seq to an empty QKeySequence.
int removeShortcut(int id, QObject *owner, const QKeySequence &key=QKeySequence())
Removes a shortcut from the global map.
bool correctContext(Qt::ShortcutContext context, QAction *a, QWidget *active_window) const
bool correctGraphicsWidgetContext(Qt::ShortcutContext context, QGraphicsWidget *w, QWidget *active_window) const
int addShortcut(QObject *owner, const QKeySequence &key, Qt::ShortcutContext context)
Adds a shortcut to the global map.
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
ShortcutContext
Definition: qnamespace.h:1478
The QAction class provides an abstract user interface action that can be inserted into widgets...
Definition: qaction.h:64
The QGraphicsWidget class is the base class for all widget items in a QGraphicsScene.