Package org.freedesktop.wayland.client

Interface WlSeatEventsV6

All Superinterfaces:

WlSeatEvents, WlSeatEventsV2, WlSeatEventsV3, WlSeatEventsV4, WlSeatEventsV5

All Known Subinterfaces:

WlSeatEventsV7, WlSeatEventsV8, WlSeatEventsV9

public interface WlSeatEventsV6
extends WlSeatEventsV5

group of input devices

A seat is a group of keyboards, pointer and touch devices. This object is published as a global during start up, or when such a device is hot plugged. A seat typically has a pointer and maintains a keyboard focus and a pointer focus.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION

Method Summary

Modifier and Type	Method	Description
void	capabilities(WlSeatProxy emitter, int capabilities)	seat capabilities changed
void	name(WlSeatProxy emitter, String name)	unique identifier for this seat

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

capabilities

void capabilities(WlSeatProxy emitter,
 int capabilities)

seat capabilities changed

This is emitted whenever a seat gains or loses the pointer, keyboard or touch capabilities. The argument is a capability enum containing the complete set of capabilities this seat has.

When the pointer capability is added, a client may create a wl_pointer object using the wl_seat.get_pointer request. This object will receive pointer events until the capability is removed in the future.

When the pointer capability is removed, a client should destroy the wl_pointer objects associated with the seat where the capability was removed, using the wl_pointer.release request. No further pointer events will be received on these objects.

In some compositors, if a seat regains the pointer capability and a client has a previously obtained wl_pointer object of version 4 or less, that object may start sending pointer events again. This behavior is considered a misinterpretation of the intended behavior and must not be relied upon by the client. wl_pointer objects of version 5 or later must not send events if created before the most recent event notifying the client of an added pointer capability.

The above behavior also applies to wl_keyboard and wl_touch with the keyboard and touch capabilities, respectively.

Specified by:

capabilities in interface WlSeatEvents

Specified by:

capabilities in interface WlSeatEventsV2

Specified by:

capabilities in interface WlSeatEventsV3

Specified by:

capabilities in interface WlSeatEventsV4

Specified by:

capabilities in interface WlSeatEventsV5

Parameters:

emitter - The protocol object that emitted the event.

capabilities - capabilities of the seat

name

void name(WlSeatProxy emitter,
 @Nonnull
 String name)

unique identifier for this seat

In a multi-seat configuration the seat name can be used by clients to help identify which physical devices the seat represents.

The seat name is a UTF-8 string with no convention defined for its contents. Each name is unique among all wl_seat globals. The name is only guaranteed to be unique for the current compositor instance.

The same seat names are used for all clients. Thus, the name can be shared across processes to refer to a specific wl_seat global.

The name event is sent after binding to the seat global. This event is only sent once per seat object, and the name does not change over the lifetime of the wl_seat global.

Compositors may re-use the same seat name if the wl_seat global is destroyed and re-created later.

Specified by:

name in interface WlSeatEventsV2

Specified by:

name in interface WlSeatEventsV3

Specified by:

name in interface WlSeatEventsV4

Specified by:

name in interface WlSeatEventsV5

Parameters:

emitter - The protocol object that emitted the event.

name - seat identifier