Package org.freedesktop.wayland.client

Interface WlKeyboardEventsV4

All Superinterfaces:

WlKeyboardEvents, WlKeyboardEventsV2, WlKeyboardEventsV3

All Known Subinterfaces:

WlKeyboardEventsV5, WlKeyboardEventsV6, WlKeyboardEventsV7, WlKeyboardEventsV8, WlKeyboardEventsV9

public interface WlKeyboardEventsV4
extends WlKeyboardEventsV3

keyboard input device

The wl_keyboard interface represents one or more keyboards associated with a seat.

Each wl_keyboard has the following logical state:

- an active surface (possibly null), - the keys currently logically down, - the active modifiers, - the active group.

By default, the active surface is null, the keys currently logically down are empty, the active modifiers and the active group are 0.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION

Method Summary

Modifier and Type	Method	Description
void	enter(WlKeyboardProxy emitter, int serial, WlSurfaceProxy surface, WlArray keys)	enter event
void	key(WlKeyboardProxy emitter, int serial, int time, int key, int state)	key event
void	keymap(WlKeyboardProxy emitter, int format, int fd, int size)	keyboard mapping
void	leave(WlKeyboardProxy emitter, int serial, WlSurfaceProxy surface)	leave event
void	modifiers(WlKeyboardProxy emitter, int serial, int modsDepressed, int modsLatched, int modsLocked, int group)	modifier and group state
void	repeatInfo(WlKeyboardProxy emitter, int rate, int delay)	repeat rate and delay

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

keymap

void keymap(WlKeyboardProxy emitter,
 int format,
 int fd,
 int size)

keyboard mapping

This event provides a file descriptor to the client which can be memory-mapped in read-only mode to provide a keyboard mapping description.

From version 7 onwards, the fd must be mapped with MAP_PRIVATE by the recipient, as MAP_SHARED may fail.

Specified by:

keymap in interface WlKeyboardEvents

Specified by:

keymap in interface WlKeyboardEventsV2

Specified by:

keymap in interface WlKeyboardEventsV3

Parameters:

emitter - The protocol object that emitted the event.

format - keymap format

fd - keymap file descriptor

size - keymap size, in bytes

enter

void enter(WlKeyboardProxy emitter,
 int serial,
 @Nonnull
 WlSurfaceProxy surface,
 @Nonnull
 WlArray keys)

enter event

Notification that this seat's keyboard focus is on a certain surface.

The compositor must send the wl_keyboard.modifiers event after this event.

In the wl_keyboard logical state, this event sets the active surface to the surface argument and the keys currently logically down to the keys in the keys argument. The compositor must not send this event if the wl_keyboard already had an active surface immediately before this event.

Specified by:

enter in interface WlKeyboardEvents

Specified by:

enter in interface WlKeyboardEventsV2

Specified by:

enter in interface WlKeyboardEventsV3

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the enter event

surface - surface gaining keyboard focus

keys - the keys currently logically down

leave

void leave(WlKeyboardProxy emitter,
 int serial,
 @Nonnull
 WlSurfaceProxy surface)

leave event

Notification that this seat's keyboard focus is no longer on a certain surface.

The leave notification is sent before the enter notification for the new focus.

In the wl_keyboard logical state, this event resets all values to their defaults. The compositor must not send this event if the active surface of the wl_keyboard was not equal to the surface argument immediately before this event.

Specified by:

leave in interface WlKeyboardEvents

Specified by:

leave in interface WlKeyboardEventsV2

Specified by:

leave in interface WlKeyboardEventsV3

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the leave event

surface - surface that lost keyboard focus

key

void key(WlKeyboardProxy emitter,
 int serial,
 int time,
 int key,
 int state)

key event

A key was pressed or released. The time argument is a timestamp with millisecond granularity, with an undefined base.

The key is a platform-specific key code that can be interpreted by feeding it to the keyboard mapping (see the keymap event).

If this event produces a change in modifiers, then the resulting wl_keyboard.modifiers event must be sent after this event.

In the wl_keyboard logical state, this event adds the key to the keys currently logically down (if the state argument is pressed) or removes the key from the keys currently logically down (if the state argument is released). The compositor must not send this event if the wl_keyboard did not have an active surface immediately before this event. The compositor must not send this event if state is pressed (resp. released) and the key was already logically down (resp. was not logically down) immediately before this event.

Specified by:

key in interface WlKeyboardEvents

Specified by:

key in interface WlKeyboardEventsV2

Specified by:

key in interface WlKeyboardEventsV3

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the key event

time - timestamp with millisecond granularity

key - key that produced the event

state - physical state of the key

modifiers

void modifiers(WlKeyboardProxy emitter,
 int serial,
 int modsDepressed,
 int modsLatched,
 int modsLocked,
 int group)

modifier and group state

Notifies clients that the modifier and/or group state has changed, and it should update its local state.

The compositor may send this event without a surface of the client having keyboard focus, for example to tie modifier information to pointer focus instead. If a modifier event with pressed modifiers is sent without a prior enter event, the client can assume the modifier state is valid until it receives the next wl_keyboard.modifiers event. In order to reset the modifier state again, the compositor can send a wl_keyboard.modifiers event with no pressed modifiers.

In the wl_keyboard logical state, this event updates the modifiers and group.

Specified by:

modifiers in interface WlKeyboardEvents

Specified by:

modifiers in interface WlKeyboardEventsV2

Specified by:

modifiers in interface WlKeyboardEventsV3

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the modifiers event

modsDepressed - depressed modifiers

modsLatched - latched modifiers

modsLocked - locked modifiers

group - keyboard layout

repeatInfo

void repeatInfo(WlKeyboardProxy emitter,
 int rate,
 int delay)

repeat rate and delay

Informs the client about the keyboard's repeat rate and delay.

This event is sent as soon as the wl_keyboard object has been created, and is guaranteed to be received by the client before any key press event.

Negative values for either rate or delay are illegal. A rate of zero will disable any repeating (regardless of the value of delay).

This event can be sent later on as well with a new value if necessary, so clients should continue listening for the event past the creation of wl_keyboard.

Parameters:

emitter - The protocol object that emitted the event.

rate - the rate of repeating keys in characters per second

delay - delay in milliseconds since key down until repeating starts