PySide6.QtGui.QKeyEvent

class QKeyEvent

The QKeyEvent class describes a key event. More…

Inheritance diagram of PySide6.QtGui.QKeyEvent

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

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.

__init__(arg__1)
Parameters:

arg__1 – QKeyEvent

__init__(type, key, modifiers[, text=""[, autorep=false[, count=1]]])
Parameters:

  • type – Type

  • key – int

  • modifiers – Combination of KeyboardModifier

  • text – str

  • autorep – bool

  • count – int

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.

__init__(type, key, modifiers, nativeScanCode, nativeVirtualKey, nativeModifiers[, text=""[, autorep=false[, count=1[, device=QInputDevice.primaryKeyboard()]]]])
Parameters:

  • type – Type

  • key – int

  • modifiers – Combination of KeyboardModifier

  • nativeScanCode – int

  • nativeVirtualKey – int

  • nativeModifiers – int

  • text – str

  • autorep – bool

  • count – int

  • device – QInputDevice

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.

__repr__()
Return type:

str

count()
Return type:

int

Returns the number of keys involved in this event. If text() is not empty, this is simply the length of the string.

See also

WA_KeyCompression

isAutoRepeat()
Return type:

bool

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.

key()
Return type:

int

Returns the code of the key that was pressed or released.

See 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

WA_KeyCompression

keyCombination()
Return type:

QKeyCombination

Returns a QKeyCombination object containing both the key() and the modifiers() carried by this event.

matches(key)
Parameters:

key – StandardKey

Return type:

bool

Returns true if the key event matches the given standard key; otherwise returns false.

nativeModifiers()
Return type:

int

Returns the native modifiers of a key event. If the key event does not contain this data 0 is returned.

Note

The native modifiers may be 0, even if the key event contains extended information.

nativeScanCode()
Return type:

int

Returns the native scan code of the key event. If the key event does not contain this data 0 is returned.

Note

The native scan code may be 0, even if the key event contains extended information.

nativeVirtualKey()
Return type:

int

Returns the native virtual key, or key sym of the key event. If the key event does not contain this data 0 is returned.

Note

The native virtual key may be 0, even if the key event contains extended information.

__ne__(standard_key)
Parameters:

standard_key – StandardKey

__eq__(key)
Parameters:

key – StandardKey

Return type:

bool

__eq__(key)
Parameters:

key – StandardKey

Return type:

bool

text()
Return type:

str

Returns the Unicode text that this key generated.

The text is not limited to the printable range of Unicode code points, and may include control characters or characters from other Unicode categories, including QChar::Other_PrivateUse.

The text may also be empty, for example when modifier keys such as Shift, Control, Alt, and Meta are pressed (depending on the platform). The key() function will always return a valid value.

See also

WA_KeyCompression