wl_proxy*wayland::proxy_t::c_ptr()const[inherited]
Get a pointer to the underlying C struct.
Returns
The underlying wl_proxy wrapped by this proxy_t if it exists, otherwise an exception is thrown
boolkeyboard_t::can_release()const
Check whether the release function is available with the currently bound version of the protocol.
Definition at line 3124 of file wayland-client-protocol.cpp.
std::stringwayland::proxy_t::get_class()const[inherited]
Get the interface name (class) of a proxy object.
Returns
The interface name of the object associated with the proxy
uint32_twayland::proxy_t::get_id()const[inherited]
Get the id of a proxy object.
Returns
The id the object associated with the proxy
uint32_twayland::proxy_t::get_version()const[inherited]
Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or
0 if the proxy was created with unversioned API.
A returned value of 0 means that no version information is available, so the caller must make safe
assumptions about the object's real version.
display_t will always return version 0.
Returns
The protocol object version of the proxy or 0
wrapper_typewayland::proxy_t::get_wrapper_type()const[inline],[inherited]
Get the type of a proxy object.
Definition at line 302 of file wayland-client.hpp.
std::function<void(uint32_t,surface_t,array_t)>&keyboard_t::on_enter()
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 3135 of file wayland-client-protocol.cpp.
std::function<void(uint32_t,uint32_t,uint32_t,keyboard_key_state)>&keyboard_t::on_key()
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.
Examplesegl.cpp, and shm.cpp.
Definition at line 3145 of file wayland-client-protocol.cpp.
std::function<void(keyboard_keymap_format,int,uint32_t)>&keyboard_t::on_keymap()
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.
Examplesproxy_wrapper.cpp.
Definition at line 3130 of file wayland-client-protocol.cpp.
std::function<void(uint32_t,surface_t)>&keyboard_t::on_leave()
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 3140 of file wayland-client-protocol.cpp.
std::function<void(uint32_t,uint32_t,uint32_t,uint32_t,uint32_t)>&keyboard_t::on_modifiers()
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 3150 of file wayland-client-protocol.cpp.
std::function<void(int32_t,int32_t)>&keyboard_t::on_repeat_info()
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 3155 of file wayland-client-protocol.cpp.
wayland::proxy_t::operatorbool()const[inherited]
Check whether this wrapper actually wraps an object.
Returns
true if there is an underlying object, false if this wrapper is empty
boolwayland::proxy_t::operator!=(constproxy_t&right)const[inherited]
Check whether two wrappers refer to different objects.
boolwayland::proxy_t::operator==(constproxy_t&right)const[inherited]
Check whether two wrappers refer to the same object.
boolwayland::proxy_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
voidwayland::proxy_t::proxy_release()[inherited]
Release the wrapped object (if any), making this an empty wrapper. Note that display_t instances cannot
be released this way. Attempts to do so are ignored.
Examplesforeign_display.cpp.
voidkeyboard_t::release()
release the keyboard object
Definition at line 3119 of file wayland-client-protocol.cpp.
voidwayland::proxy_t::set_queue(event_queue_tqueue)[inherited]
Assign a proxy to an event queue.
Parametersqueue The event queue that will handle this proxy
Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's
main queue.
See also: display_t::dispatch_queue().
Examplesproxy_wrapper.cpp.
Install Now
Emojis
PNG Icons
