Message

`KeyEvent`

Bases: AttrEnum

Keyboard event message type enumerator to use as KeyMsg type attribute

Key press and release. Isn't assigned by KeyIn but can be sent with KeyOut

KeyMsg(
    type: KeyEvent,
    shortcut_or_keycodes: str | Iterable[Key],
    *,
    source: None | KeyIn = None
)

Bases: Msg

Keyboard event message

Parameters:

type (KeyEvent) –

Keyboard event type
shortcut_or_keycodes (str | Iterable[Key]) –

keyboard shortcut description or event key codes
source (None | KeyIn, default: None ) –

The KeyIn instance that generated the message

Tip

Use log to get the shortcuts you need

ctime: float

Message creation time in "Unix time" format

type: KeyEvent

Keyboard event type

keycodes: list[Key]

Keycodes in the order they were pressed. Use when pressing order matters.

source: None | KeyIn

Input port instance that generated the message

shortcut: str

Keyboard shortcut description like 'ctrl+shift+t'. Stays the same for any key pressing order.

matches(
    type: None | Container[KeyEvent] | KeyEvent = None,
    shortcut: None | Container[str] | str = None,
) -> bool

Checks if message's attributes match all provided attribute conditions:

If condition is None or omitted, it matches anything.
If condition equals attribute, it matches the attribute.
If condition is a container (list, tuple) and contains the attribute, it matches the attribute.

Use Not(condition) to invert condition matching.

Returns: