org.freedesktop.wayland.client

Interface WlKeyboardEventsV5

All Superinterfaces:

WlKeyboardEvents, WlKeyboardEventsV2, WlKeyboardEventsV3, WlKeyboardEventsV4

public interface WlKeyboardEventsV5
extends WlKeyboardEventsV4

keyboard input device

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION

Method Summary

Modifier and Type	Method and Description
void	enter(WlKeyboardProxy emitter, int serial, WlSurfaceProxy surface, ByteBuffer 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 Detail

VERSION

static final int VERSION

See Also:

Constant Field Values

Method Detail

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 to provide a keyboard mapping description.

Specified by:

keymap in interface WlKeyboardEvents

Specified by:

keymap in interface WlKeyboardEventsV2

Specified by:

keymap in interface WlKeyboardEventsV3

Specified by:

keymap in interface WlKeyboardEventsV4

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
           ByteBuffer keys)

enter event

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

Specified by:

enter in interface WlKeyboardEvents

Specified by:

enter in interface WlKeyboardEventsV2

Specified by:

enter in interface WlKeyboardEventsV3

Specified by:

enter in interface WlKeyboardEventsV4

Parameters:

emitter - The protocol object that emitted the event.

serial - serial number of the enter event

surface - surface gaining keyboard focus

keys - the currently pressed keys

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.

Specified by:

leave in interface WlKeyboardEvents

Specified by:

leave in interface WlKeyboardEventsV2

Specified by:

leave in interface WlKeyboardEventsV3

Specified by:

leave in interface WlKeyboardEventsV4

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.

Specified by:

key in interface WlKeyboardEvents

Specified by:

key in interface WlKeyboardEventsV2

Specified by:

key in interface WlKeyboardEventsV3

Specified by:

key in interface WlKeyboardEventsV4

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.

Specified by:

modifiers in interface WlKeyboardEvents

Specified by:

modifiers in interface WlKeyboardEventsV2

Specified by:

modifiers in interface WlKeyboardEventsV3

Specified by:

modifiers in interface WlKeyboardEventsV4

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.

Specified by:

repeatInfo in interface WlKeyboardEventsV4

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