voiddata_offer_t::accept(uint32_tserial,std::stringconst&mime_type)
accept one of the offered mime types
Parametersserial serial number of the accept request
mime_type mime type accepted by the client
Indicate that the client can accept the given mime type, or NULL for not accepted.
For objects of version 2 or older, this request is used by the client to give feedback whether the client
can receive the given mime type, or NULL if none is accepted; the feedback does not determine whether the
drag-and-drop operation succeeds or not.
For objects of version 3 or newer, this request determines the final result of the drag-and-drop
operation. If the end result is that no mime types were accepted, the drag-and-drop operation will be
cancelled and the corresponding drag source will receive wl_data_source.cancelled. Clients may still use
this event in conjunction with wl_data_source.action for feedback.
Definition at line 2028 of file wayland-client-protocol.cpp.
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
booldata_offer_t::can_finish()const
Check whether the finish function is available with the currently bound version of the protocol.
Definition at line 2045 of file wayland-client-protocol.cpp.
booldata_offer_t::can_set_actions()const
Check whether the set_actions function is available with the currently bound version of the protocol.
Definition at line 2056 of file wayland-client-protocol.cpp.
voiddata_offer_t::finish()
the offer will no longer be used Notifies the compositor that the drag destination successfully finished
the drag-and-drop operation.
Upon receiving this request, the compositor will emit wl_data_source.dnd_finished on the drag source
client.
It is a client error to perform other requests than wl_data_offer.destroy after this one. It is also an
error to perform this request after a NULL mime type has been set in wl_data_offer.accept or no action
was received through wl_data_offer.action.
If wl_data_offer.finish request is received for a non drag and drop operation, the invalid_finish
protocol error is raised.
Definition at line 2040 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
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(data_device_manager_dnd_action)>&data_offer_t::on_action()
notify the selected action
Parametersdnd_action action selected by the compositor
This event indicates the action selected by the compositor after matching the source/destination side
actions. Only one action (or none) will be offered here.
This event can be emitted multiple times during the drag-and-drop operation in response to destination
side action changes through wl_data_offer.set_actions.
This event will no longer be emitted after wl_data_device.drop happened on the drag-and-drop destination,
the client must honor the last action received, or the last preferred one set through
wl_data_offer.set_actions when handling an 'ask' action.
Compositors may also change the selected action on the fly, mainly in response to keyboard modifier
changes during the drag-and-drop operation.
The most recent action received is always the valid one. Prior to receiving wl_data_device.drop, the
chosen action may change (e.g. due to keyboard modifiers being pressed). At the time of receiving
wl_data_device.drop the drag-and-drop destination must honor the last action received.
Action changes may still happen after wl_data_device.drop, especially on 'ask' actions, where the drag-
and-drop destination may choose another action afterwards. Action changes happening at this stage are
always the result of inter-client negotiation, the compositor shall no longer be able to induce a
different action.
Upon 'ask' actions, it is expected that the drag-and-drop destination may potentially choose a different
action and/or mime type, based on wl_data_offer.source_actions and finally chosen by the user (e.g.
popping up a menu with the available options). The final wl_data_offer.set_actions and
wl_data_offer.accept requests must happen before the call to wl_data_offer.finish.
Definition at line 2072 of file wayland-client-protocol.cpp.
std::function<void(std::string)>&data_offer_t::on_offer()
advertise offered mime type
Parametersmime_type offered mime type
Sent immediately after creating the wl_data_offer object. One event per offered mime type.
Definition at line 2062 of file wayland-client-protocol.cpp.
std::function<void(data_device_manager_dnd_action)>&data_offer_t::on_source_actions()
notify the source-side available actions
Parameterssource_actions actions offered by the data source
This event indicates the actions offered by the data source. It will be sent right after
wl_data_device.enter, or anytime the source side changes its offered actions through
wl_data_source.set_actions.
Definition at line 2067 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.
voiddata_offer_t::receive(std::stringconst&mime_type,intfd)
request that the data is transferred
Parametersmime_type mime type desired by receiver
fd file descriptor for data transfer
To transfer the offered data, the client issues this request and indicates the mime type 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 then closes its end, at which
point the transfer is complete.
This request may happen multiple times for different mime types, both before and after
wl_data_device.drop. Drag-and-drop destination clients may preemptively fetch data or examine it more
closely to determine acceptance.
Definition at line 2034 of file wayland-client-protocol.cpp.
voiddata_offer_t::set_actions(data_device_manager_dnd_actionconst&dnd_actions,data_device_manager_dnd_actionconst&preferred_action)
set the available/preferred drag-and-drop actions
Parametersdnd_actions actions supported by the destination client
preferred_action action preferred by the destination client
Sets the actions that the destination side client supports for this operation. This request may trigger
the emission of wl_data_source.action and wl_data_offer.action events if the compositor needs to change
the selected action.
This request can be called multiple times throughout the drag-and-drop operation, typically in response
to wl_data_device.enter or wl_data_device.motion events.
This request determines the final result of the drag-and-drop operation. If the end result is that no
action is accepted, the drag source will receive wl_data_source.cancelled.
The dnd_actions argument must contain only values expressed in the wl_data_device_manager.dnd_actions
enum, and the preferred_action argument must only contain one of those values set, otherwise it will
result in a protocol error.
While managing an 'ask' action, the destination drag-and-drop client may perform further
wl_data_offer.receive requests, and is expected to perform one last wl_data_offer.set_actions request
with a preferred action other than 'ask' (and optionally wl_data_offer.accept) before requesting
wl_data_offer.finish, in order to convey the action selected by the user. If the preferred action is not
in the wl_data_offer.source_actions mask, an error will be raised.
If the 'ask' action is dismissed (e.g. user cancellation), the client is expected to perform
wl_data_offer.destroy right away.
This request can only be made on drag-and-drop offers, a protocol error will be raised otherwise.
Definition at line 2051 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
PNG Icons
