.TH "wayland::server::zwp_primary_selection_offer_v1_t" 3 "Wed May 1 2024 17:27:19" "Version 1.0.0" "Wayland++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
wayland::server::zwp_primary_selection_offer_v1_t \- offer to transfer primary selection contents  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <wayland\-server\-protocol\-unstable\&.hpp>\fP
.PP
Inherits wayland::server::resource_t\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "std::function< void(std::string, int)> & \fBon_receive\fP ()"
.br
.RI "request that the data is transferred "
.ti -1c
.RI "std::function< void()> & \fBon_destroy\fP ()"
.br
.RI "destroy the primary selection offer "
.ti -1c
.RI "void \fBoffer\fP (std::string const &mime_type, bool post=true)"
.br
.RI "advertise offered mime type "
.ti -1c
.RI "bool \fBproxy_has_object\fP () const"
.br
.RI "Check whether this wrapper actually wraps an object\&. "
.ti -1c
.RI "void \fBpost_no_memory\fP () const"
.br
.ti -1c
.RI "uint32_t \fBget_id\fP () const"
.br
.ti -1c
.RI "client_t \fBget_client\fP () const"
.br
.ti -1c
.RI "unsigned int \fBget_version\fP () const"
.br
.ti -1c
.RI "std::string \fBget_class\fP ()"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr std::uint32_t \fBoffer_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBoffer\fP function\&. "
.in -1c
.SH "Detailed Description"
.PP 
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\&. 
.PP
Definition at line \fB3678\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "std::string wayland::server::resource_t::get_class ()\fC [inherited]\fP"
Retrieve the interface name (class) of a resource object\&.
.PP
\fBReturns\fP
.RS 4
Interface name of the resource object\&. 
.RE
.PP

.SS "client_t wayland::server::resource_t::get_client () const\fC [inherited]\fP"
Get the associated client
.PP
\fBReturns\fP
.RS 4
the client that owns the resource\&. 
.RE
.PP

.SS "uint32_t wayland::server::resource_t::get_id () const\fC [inherited]\fP"
Get the internal ID of the resource
.PP
\fBReturns\fP
.RS 4
the internal ID of the resource 
.RE
.PP

.SS "unsigned int wayland::server::resource_t::get_version () const\fC [inherited]\fP"
Get interface version
.PP
\fBReturns\fP
.RS 4
Interface version this resource has been constructed with\&. 
.RE
.PP

.SS "void zwp_primary_selection_offer_v1_t::offer (std::string const & mime_type, bool post = \fCtrue\fP)"

.PP
advertise offered mime type 
.PP
\fBParameters\fP
.RS 4
\fImime_type\fP 
.RE
.PP
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\&. 
.PP
Definition at line \fB5901\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void()> & zwp_primary_selection_offer_v1_t::on_destroy ()"

.PP
destroy the primary selection offer Destroy the primary selection offer\&. 
.PP
Definition at line \fB5895\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(std::string, int)> & zwp_primary_selection_offer_v1_t::on_receive ()"

.PP
request that the data is transferred 
.PP
\fBParameters\fP
.RS 4
\fImime_type\fP 
.br
\fIfd\fP 
.RE
.PP
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\&.
.PP
The receiving client reads from the read end of the pipe until EOF and closes its end, at which point the transfer is complete\&. 
.PP
Definition at line \fB5889\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "void wayland::server::resource_t::post_no_memory () const\fC [inherited]\fP"
Post 'not enough memory' error to the client
.PP
If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance\&. 
.SS "bool wayland::server::resource_t::proxy_has_object () const\fC [inherited]\fP"

.PP
Check whether this wrapper actually wraps an object\&. 
.PP
\fBReturns\fP
.RS 4
true if there is an underlying object, false if this wrapper is empty 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "constexpr std::uint32_t wayland::server::zwp_primary_selection_offer_v1_t::offer_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBoffer\fP function\&. 
.PP
Definition at line \fB3742\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Wayland++ from the source code\&.