xwayland_keyboard_grab_unstable_v1 Module¶
ZwpXwaylandKeyboardGrabManagerV1¶
-
class
pywayland.protocol.xwayland_keyboard_grab_unstable_v1.ZwpXwaylandKeyboardGrabManagerV1¶ Context object for keyboard grab manager
A global interface used for grabbing the keyboard.
-
destroy()¶ Request – opcode 0 (attached to
Resourceinstance)Destroy the keyboard grab manager
Destroy the keyboard grab manager.
-
grab_keyboard(surface, seat)¶ Request – opcode 1 (attached to
Resourceinstance)Grab the keyboard to a surface
The grab_keyboard request asks for a grab of the keyboard, forcing the keyboard focus for the given seat upon the given surface.
The protocol provides no guarantee that the grab is ever satisfied, and does not require the compositor to send an error if the grab cannot ever be satisfied. It is thus possible to request a keyboard grab that will never be effective.
The protocol:
- does not guarantee that the grab itself is applied for a surface, the grab request may be silently ignored by the compositor,
- does not guarantee that any events are sent to this client even if the grab is applied to a surface,
- does not guarantee that events sent to this client are exhaustive, a compositor may filter some events for its own consumption,
- does not guarantee that events sent to this client are continuous, a compositor may change and reroute keyboard events while the grab is nominally active.
Parameters: Returns:
-