wayland::zwp_primary_selection_source_v1_t − offer to replace the contents of the primary selection
#include <wayland−client−protocol−unstable.hpp>
Inherits wayland::proxy_t.
enum class wrapper_type { standard, display, foreign, proxy_wrapper }
void
offer (std::string const &mime_type)
add an offered mime type
std::function< void(std::string, int)> &
on_send ()
send the primary selection contents
std::function< void()> & on_cancelled ()
request for primary selection contents was canceled
uint32_t get_id () const
Get the id of a proxy object.
std::string get_class () const
Get the interface name (class) of a proxy object.
uint32_t get_version () const
Get the protocol object version of a proxy object.
wrapper_type get_wrapper_type () const
Get the type of a proxy object.
void set_queue (event_queue_t queue)
Assign a proxy to an event queue.
wl_proxy * c_ptr () const
Get a pointer to the underlying C struct.
bool proxy_has_object () const
Check whether this wrapper actually wraps an object.
operator bool () const
Check whether this wrapper actually wraps an object.
bool operator== (const proxy_t &right)
const
Check whether two wrappers refer to the same object.
bool operator!= (const proxy_t &right)
const
Check whether two wrappers refer to different objects.
void proxy_release ()
Release the wrapped object (if any), making this an empty
wrapper.
static
constexpr std::uint32_t offer_since_version = 1
Minimum protocol version required for the offer
function.
offer to replace the contents of the primary selection
The source side of a wp_primary_selection_offer, it provides a way to describe the offered data and respond to requests to transfer the requested contents of the primary selection clipboard.
Definition at line 3364 of file wayland−client−protocol−unstable.hpp.
Underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling
Enumerator
standard
C pointer is a standard type compatible with wl_proxy*. Events are dispatched and it is destructed when the proxy_t is destructed. User data is set.
display
C pointer is a wl_display*. No events are dispatched, wl_display_disconnect is called when the proxy_t is destructed. User data is set.
foreign
C pointer is a standard type compatible with wl_proxy*, but another library owns it and it should not be touched in a way that could affect the operation of the other library. No events are dispatched, wl_proxy_destroy is not called when the proxy_t is destructed, user data is not touched. Consequently, there is no reference counting for the proxy_t. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl_proxy.
proxy_wrapper
C pointer is a wl_proxy* that was constructed with wl_proxy_create_wrapper. No events are dispatched, wl_proxy_wrapper_destroy is called when the proxy_t is destroyed. Reference counting is active. A reference to the proxy_t creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.
Definition at line 116 of file wayland−client.hpp.
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
Get the interface name (class) of a proxy object.
Returns
The interface name of the object associated with the proxy
Get the id of a proxy object.
Returns
The id the object associated with the proxy
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
Get the type of a proxy object.
Definition at line 302 of file wayland−client.hpp.
add an offered mime type
Parameters
mime_type
This request adds a mime type to the set of mime types advertised to targets. Can be called several times to offer multiple types.
Definition at line 6558 of file wayland−client−protocol−unstable.cpp.
request for primary selection contents was canceled This primary selection source is no longer valid. The client should clean up and destroy this primary selection source.
Definition at line 6569 of file wayland−client−protocol−unstable.cpp.
send the primary selection contents
Parameters
mime_type
fd
Request for the current primary selection contents from the client. Send the specified mime type over the passed file descriptor, then close it.
Definition at line 6564 of file wayland−client−protocol−unstable.cpp.
Check whether this wrapper actually wraps an object.
Returns
true if there is an underlying object, false if this wrapper is empty
Check whether two wrappers refer to different objects.
Check whether two wrappers refer to the same object.
Check whether this wrapper actually wraps an object.
Returns
true if there is an underlying object, false if this wrapper is empty
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.
Examples
foreign_display.cpp.
Assign a proxy to an event queue.
Parameters
queue 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().
Examples
proxy_wrapper.cpp.
Minimum protocol version required for the offer function.
Definition at line 3399 of file wayland−client−protocol−unstable.hpp.
Generated automatically by Doxygen for Wayland++ from the source code.