QKeyEvent¶
- PyQt6.QtGui.QKeyEvent
Inherits from QInputEvent.
Description¶
The QKeyEvent class describes a key event.
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 KeyPress and KeyRelease, so there is no need to call accept() when acting on a key event. For 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 setEnabled() function can be used to enable or disable mouse and keyboard events for a widget.
The event handlers keyPressEvent(), keyReleaseEvent(), keyPressEvent() and keyReleaseEvent() receive key events.
See also
Methods¶
- __init__(Type, int, KeyboardModifier, text: Optional[str] = '', autorep: bool = False, count: int = 1)
Constructs a key event object.
The type parameter must be KeyPress, KeyRelease, or ShortcutOverride.
Int key is the code for the 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, int, KeyboardModifier, int, int, int, text: Optional[str] = '', autorep: bool = False, count: int = 1, device: QInputDevice = QInputDevice.primaryKeyboard())
Constructs a key event object.
The type parameter must be KeyPress, KeyRelease, or ShortcutOverride.
Int key is the code for the 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.
- clone() QKeyEvent
TODO
- count() 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
- __eq__(StandardKey) bool
TODO
- isAutoRepeat() bool
Returns
trueif this event comes from an auto-repeating key; returnsfalseif 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() int
Returns the code of the key that was pressed or released.
See 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 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
- keyCombination() QKeyCombination
Returns a QKeyCombination object containing both the key() and the modifiers() carried by this event.
- __len__() int
TODO
- matches(StandardKey) bool
Returns
trueif the key event matches the given standard key; otherwise returnsfalse.
- modifiers() KeyboardModifier
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 Shift keys simultaneously and releasing one of them, for example.
See also
- nativeModifiers() 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() 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() 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__(StandardKey) bool
TODO
- text() 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