wayland::zwp_primary_selection_offer_v1_t - offer to transfer primary selection contents

Author

       Generated automatically by Doxygen for Wayland++ from the source code.

Version 1.0.0                                Wed May 1 2024 17:27:19wayland::zwp_primary_selection_offer_v1_t(3)

Detailed Description

       offer to transfer primary selection contents

       A wp_primary_selection_offer represents an offer to transfer the contents of the primary selection
       clipboard to the client. Similar to wl_data_offer, the offer also describes the mime types that the data
       can be converted to and provides the mechanisms for transferring the data directly to the client.

       Definition at line 3298 of file wayland-client-protocol-unstable.hpp.

Member Data Documentation

constexprstd::uint32_twayland::zwp_primary_selection_offer_v1_t::receive_since_version=1[static],[constexpr]
       Minimum protocol version required for the receive function.

       Definition at line 3340 of file wayland-client-protocol-unstable.hpp.

Member Enumeration Documentation

enumclasswayland::proxy_t::wrapper_type[strong],[inherited]
Underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event
handling

Enumeratorstandard
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::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(std::string)>&zwp_primary_selection_offer_v1_t::on_offer()
       advertise offered mime type

       Parametersmime_type

       Sent     immediately     after     creating    announcing    the    wp_primary_selection_offer    through
       wp_primary_selection_device.data_offer. One event is sent per offered mime type.

       Definition at line 6490 of file wayland-client-protocol-unstable.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.

   voidzwp_primary_selection_offer_v1_t::receive(std::stringconst&mime_type,intfd)
       request that the data is transferred

       Parametersmime_typefd

       To transfer the contents of the primary selection clipboard, the client issues this request and indicates
       the  mime  type  that  it  wants  to  receive.  The  transfer  happens through the passed file descriptor
       (typically created with the pipe system call). The source  client  writes  the  data  in  the  mime  type
       representation requested and then closes the file descriptor.

       The receiving client reads from the read end of the pipe until EOF and closes its end, at which point the
       transfer is complete.

       Definition at line 6484 of file wayland-client-protocol-unstable.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.

Name

       wayland::zwp_primary_selection_offer_v1_t - offer to transfer primary selection contents

Synopsis

       #include <wayland-client-protocol-unstable.hpp>

       Inherits wayland::proxy_t.

   PublicTypes
       enum class wrapper_type { standard, display, foreign, proxy_wrapper }

   PublicMemberFunctions
       void receive (std::string const &mime_type, int fd)
           request that the data is transferred
       std::function< void(std::string)> & on_offer ()
           advertise offered mime type
       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_typeget_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.
       operatorbool () 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.

   StaticPublicAttributes
       static constexpr std::uint32_t receive_since_version = 1
           Minimum protocol version required for the receive function.