The QKeyEvent class describes a key event. More...
#include <qevent.h>
Protected Attributes | |
| QString | m_text |
| int | m_key |
| quint32 | m_scanCode |
| quint32 | m_virtualKey |
| quint32 | m_nativeModifiers |
| quint16 | m_count: 15 |
| quint16 | m_autoRepeat: 1 |
 Protected Attributes inherited from QInputEvent | |
| const QInputDevice * | m_dev = nullptr |
| quint64 | m_timeStamp = 0 |
| Qt::KeyboardModifiers | m_modState = Qt::NoModifier |
| quint32 | m_reserved = 0 |
| Protected Attributes inherited from QEvent | |
| quint16 | t |
Detailed Description
The QKeyEvent class describes a key event.
\inmodule QtGui
Key events are sent to the widget with keyboard input focus when keys are pressed or released.
A key event contains a special accept flag that indicates whether the receiver will handle the key event. This flag is set by default for QEvent::KeyPress and QEvent::KeyRelease, so there is no need to call accept() when acting on a key event. For QEvent::ShortcutOverride the receiver needs to explicitly accept the event to trigger the override. Calling ignore() on a key event will propagate it to the parent widget. The event is propagated up the parent widget chain until a widget accepts it or an event filter consumes it.
The QWidget::setEnabled() function can be used to enable or disable mouse and keyboard events for a widget.
The event handlers QWidget::keyPressEvent(), QWidget::keyReleaseEvent(), QGraphicsItem::keyPressEvent() and QGraphicsItem::keyReleaseEvent() receive key events.
- See also
- QFocusEvent, QWidget::grabKeyboard()
Constructor & Destructor Documentation
◆ QKeyEvent() [1/2]
| QKeyEvent::QKeyEvent | ( | Type | type, |
| int | key, | ||
| Qt::KeyboardModifiers | modifiers, | ||
| const QString & | text = QString(), |
||
| bool | autorep = false, |
||
| quint16 | count = 1 |
||
| ) |
Constructs a key event object.
The type parameter must be QEvent::KeyPress, QEvent::KeyRelease, or QEvent::ShortcutOverride.
Int key is the code for the Qt::Key that the event loop should listen for. If key is 0, the event is not a result of a known key; for example, it may be the result of a compose sequence or keyboard macro. The modifiers holds the keyboard modifiers, and the given text is the Unicode text that the key generated. If autorep is true, isAutoRepeat() will be true. count is the number of keys involved in the event.
Definition at line 1379 of file qevent.cpp.
◆ QKeyEvent() [2/2]
| QKeyEvent::QKeyEvent | ( | Type | type, |
| int | key, | ||
| Qt::KeyboardModifiers | modifiers, | ||
| quint32 | nativeScanCode, | ||
| quint32 | nativeVirtualKey, | ||
| quint32 | nativeModifiers, | ||
| const QString & | text = QString(), |
||
| bool | autorep = false, |
||
| quint16 | count = 1, |
||
| const QInputDevice * | device = QInputDevice::primaryKeyboard() |
||
| ) |
Constructs a key event object.
The type parameter must be QEvent::KeyPress, QEvent::KeyRelease, or QEvent::ShortcutOverride.
Int key is the code for the Qt::Key that the event loop should listen for. If key is 0, the event is not a result of a known key; for example, it may be the result of a compose sequence or keyboard macro. The modifiers holds the keyboard modifiers, and the given text is the Unicode text that the key generated. If autorep is true, isAutoRepeat() will be true. count is the number of keys involved in the event.
In addition to the normal key event data, also contains nativeScanCode, nativeVirtualKey and nativeModifiers. This extra data is used by the shortcut system, to determine which shortcuts to trigger.
Definition at line 1407 of file qevent.cpp.
◆ ~QKeyEvent()
| QKeyEvent::~QKeyEvent | ( | ) |
Definition at line 1422 of file qevent.cpp.
Member Function Documentation
◆ clone()
|
inlineoverridevirtual |
◆ count()
|
inline |
Returns the number of keys involved in this event. If text() is not empty, this is simply the length of the string.
- See also
- Qt::WA_KeyCompression
◆ isAutoRepeat()
|
inline |
Returns true if this event comes from an auto-repeating key; returns false if it comes from an initial key press.
Note that if the event is a multiple-key compressed event that is partly due to auto-repeat, this function could return either true or false indeterminately.
Definition at line 494 of file qevent.h.
◆ key()
|
inline |
Returns the code of the key that was pressed or released.
See \l Qt::Key for the list of keyboard codes. These codes are independent of the underlying window system. Note that this function does not distinguish between capital and non-capital letters, use the text() function (returning the Unicode text the key generated) for this purpose.
A value of either 0 or Qt::Key_unknown means that the event is not the result of a known key; for example, it may be the result of a compose sequence, a keyboard macro, or due to key event compression.
- See also
- Qt::WA_KeyCompression
Definition at line 484 of file qevent.h.
◆ keyCombination()
|
inline |
Returns a QKeyCombination object containing both the key() and the modifiers() carried by this event.
- Since
- 6.0
◆ modifiers()
| Qt::KeyboardModifiers QKeyEvent::modifiers | ( | ) | const |
Returns the keyboard modifier flags that existed immediately after the event occurred.
- Warning
- This function cannot always be trusted. The user can confuse it by pressing both \uicontrol{Shift} keys simultaneously and releasing one of them, for example.
Definition at line 1502 of file qevent.cpp.
◆ nativeModifiers()
|
inline |
◆ nativeScanCode()
|
inline |
◆ nativeVirtualKey()
|
inline |
◆ text()
|
inline |
Returns the Unicode text that this key generated.
Return values when modifier keys such as Shift, Control, Alt, and Meta are pressed differ among platforms and could return an empty string.
- Note
- \l key() will always return a valid value, independent of modifier keys.
- See also
- Qt::WA_KeyCompression
Definition at line 493 of file qevent.h.
Member Data Documentation
◆ m_autoRepeat
◆ m_count
◆ m_key
◆ m_nativeModifiers
◆ m_scanCode
◆ m_text
◆ m_virtualKey
The documentation for this class was generated from the following files:
- src/gui/kernel/qevent.h
- src/gui/kernel/qevent.cpp
