Skip to content

Key

The Key event is sent to a widget when the user presses a key on the keyboard.

  • Bubbles
  • Verbose

Attributes

attribute type purpose
key str Name of the key that was pressed.
char str or None The character that was pressed, or None it isn't printable.

Code

Key

Bases: InputEvent

Sent when the user hits a key on the keyboard.

Parameters:

Name Type Description Default
key str

The key that was pressed.

required
character str | None

A printable character or None if it is not printable.

required

Attributes:

Name Type Description
aliases list[str]

The aliases for the key, including the key itself.

is_printable: bool property

Check if the key is printable (produces a unicode character).

Returns:

Type Description
bool

True if the key is printable.

name: str property

Name of a key suitable for use as a Python identifier.

name_aliases: list[str] property

The corresponding name for every alias in aliases list.