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
boolseat_t::can_release()const
Check whether the release function is available with the currently bound version of the protocol.
Definition at line 2875 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
keyboard_tseat_t::get_keyboard()
return keyboard object
Returns
seat keyboard
The ID provided will be initialized to the wl_keyboard interface for this seat.
This request only takes effect if the seat has the keyboard capability, or has had the keyboard
capability in the past. It is a protocol violation to issue this request on a seat that has never had the
keyboard capability. The missing_capability error will be sent in this case.
Examplesegl.cpp, proxy_wrapper.cpp, and shm.cpp.
Definition at line 2856 of file wayland-client-protocol.cpp.
pointer_tseat_t::get_pointer()
return pointer object
Returns
seat pointer
The ID provided will be initialized to the wl_pointer interface for this seat.
This request only takes effect if the seat has the pointer capability, or has had the pointer capability
in the past. It is a protocol violation to issue this request on a seat that has never had the pointer
capability. The missing_capability error will be sent in this case.
Examplesegl.cpp, and shm.cpp.
Definition at line 2849 of file wayland-client-protocol.cpp.
touch_tseat_t::get_touch()
return touch object
Returns
seat touch interface
The ID provided will be initialized to the wl_touch interface for this seat.
This request only takes effect if the seat has the touch capability, or has had the touch capability in
the past. It is a protocol violation to issue this request on a seat that has never had the touch
capability. The missing_capability error will be sent in this case.
Definition at line 2863 of file wayland-client-protocol.cpp.
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(seat_capability)>&seat_t::on_capabilities()
seat capabilities changed
Parameterscapabilities capabilities of the seat
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.
Examplesegl.cpp, and shm.cpp.
Definition at line 2881 of file wayland-client-protocol.cpp.
std::function<void(std::string)>&seat_t::on_name()
unique identifier for this seat
Parametersname seat identifier
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.
Definition at line 2886 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.
voidseat_t::release()
release the seat object Using this request a client can tell the server that it is not going to use the
seat object anymore.
Definition at line 2870 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
