boolkeyboard_t::can_repeat_info()const
Check whether the repeat_info function is available with the currently bound version of the protocol.
Definition at line 2822 of file wayland-server-protocol.cpp.
voidkeyboard_t::enter(uint32_tserial,surface_tconst&surface,array_tconst&keys,boolpost=true)
enter event
Parametersserial serial number of the enter event
surface surface gaining keyboard focus
keys the currently pressed keys
Notification that this seat's keyboard focus is on a certain surface.
The compositor must send the wl_keyboard.modifiers event after this event.
Definition at line 2797 of file wayland-server-protocol.cpp.
std::stringwayland::server::resource_t::get_class()[inherited]
Retrieve the interface name (class) of a resource object.
Returns
Interface name of the resource object.
client_twayland::server::resource_t::get_client()const[inherited]
Get the associated client
Returns
the client that owns the resource.
uint32_twayland::server::resource_t::get_id()const[inherited]
Get the internal ID of the resource
Returns
the internal ID of the resource
unsignedintwayland::server::resource_t::get_version()const[inherited]
Get interface version
Returns
Interface version this resource has been constructed with.
voidkeyboard_t::key(uint32_tserial,uint32_ttime,uint32_tkey,keyboard_key_stateconst&state,boolpost=true)
key event
Parametersserial serial number of the key event
time timestamp with millisecond granularity
key key that produced the event
state physical state of the key
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.
Definition at line 2807 of file wayland-server-protocol.cpp.
voidkeyboard_t::keymap(keyboard_keymap_formatconst&format,intfd,uint32_tsize,boolpost=true)
keyboard mapping
Parametersformat keymap format
fd keymap file descriptor
size keymap size, in bytes
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.
Definition at line 2792 of file wayland-server-protocol.cpp.
voidkeyboard_t::leave(uint32_tserial,surface_tconst&surface,boolpost=true)
leave event
Parametersserial serial number of the leave event
surface surface that lost keyboard focus
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.
After this event client must assume that all keys, including modifiers, are lifted and also it must stop
key repeating if there's some going on.
Definition at line 2802 of file wayland-server-protocol.cpp.
voidkeyboard_t::modifiers(uint32_tserial,uint32_tmods_depressed,uint32_tmods_latched,uint32_tmods_locked,uint32_tgroup,boolpost=true)
modifier and group state
Parametersserial serial number of the modifiers event
mods_depressed depressed modifiers
mods_latched latched modifiers
mods_locked locked modifiers
group keyboard layout
Notifies clients that the modifier and/or group state has changed, and it should update its local state.
Definition at line 2812 of file wayland-server-protocol.cpp.
std::function<void()>&keyboard_t::on_release()
release the keyboard object
Definition at line 2786 of file wayland-server-protocol.cpp.
voidwayland::server::resource_t::post_no_memory()const[inherited]
Post 'not enough memory' error to the client
If the compositor has not enough memory to fulfill a certail request of the client, this function can be
called to notify the client of this circumstance.
boolwayland::server::resource_t::proxy_has_object()const[inherited]
Check whether this wrapper actually wraps an object.
Returns
true if there is an underlying object, false if this wrapper is empty
voidkeyboard_t::repeat_info(int32_trate,int32_tdelay,boolpost=true)
repeat rate and delay
Parametersrate the rate of repeating keys in characters per second
delay delay in milliseconds since key down until repeating starts
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.
Definition at line 2817 of file wayland-server-protocol.cpp.