--- name: "wayland_zwp_primary_selection_source_v1_t" section: "3" platform: "linux" package: "waylandpp-dev" version: "1.0.0-6+b2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/wayland_zwp_primary_selection_source_v1_t" --- # wayland\_zwp\_primary\_selection\_source\_v1\_t(3) offer to replace the contents of the primary selection ## NAME wayland::zwp\_primary\_selection\_source\_v1\_t - offer to replace the contents of the primary selection ## SYNOPSIS `#include ` Inherits **wayland::proxy\_t**. ### Public Types enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\ ### Public Member Functions 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 Public Attributes static constexpr std::uint32\_t **offer\_since\_version** = 1\ Minimum protocol version required for the **offer** function. ## Detailed Description 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 **3363** of file **wayland-client-protocol-unstable.hpp**. ## Member Enumeration Documentation ### enum class wayland::proxy\_t::wrapper\_type` [strong]`, ` [inherited]` 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***.* ## Member Function Documentation ### 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* ### std::string wayland::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\_t wayland::proxy\_t::get\_id () const` [inherited]` *Get the id of a proxy object.* **Returns** *The id the object associated with the proxy* ### uint32\_t wayland::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\_type wayland::proxy\_t::get\_wrapper\_type () const` [inline]`, ` [inherited]` *Get the type of a proxy object.* *Definition at line* **302** *of file* **wayland-client.hpp***.* ### void zwp\_primary\_selection\_source\_v1\_t::offer (std::string const & mime\_type) *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***.* ### std::function\< void()\> & zwp\_primary\_selection\_source\_v1\_t::on\_cancelled () *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***.* ### std::function\< void(std::string, int)\> & zwp\_primary\_selection\_source\_v1\_t::on\_send () *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***.* ### wayland::proxy\_t::operator bool () const` [inherited]` *Check whether this wrapper actually wraps an object.* **Returns** *true if there is an underlying object, false if this wrapper is empty* ### bool wayland::proxy\_t::operator!= (const proxy\_t & right) const` [inherited]` *Check whether two wrappers refer to different objects.* ### bool wayland::proxy\_t::operator== (const proxy\_t & right) const` [inherited]` *Check whether two wrappers refer to the same object.* ### bool wayland::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* ### void wayland::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.* **Examples** **foreign\_display.cpp***.* ### void wayland::proxy\_t::set\_queue (event\_queue\_t queue)` [inherited]` *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***.* ## Member Data Documentation ### constexpr std::uint32\_t wayland::zwp\_primary\_selection\_source\_v1\_t::offer\_since\_version = 1` [static]`, ` [constexpr]` *Minimum protocol version required for the* **offer** *function.* *Definition at line* **3398** *of file* **wayland-client-protocol-unstable.hpp***.* ## Author *Generated automatically by Doxygen for Wayland++ from the source code.*