wayland::data_source_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

🦋 wayland::data_source_t — offer to transfer data 🦋

okay so bestie, this is the Wayland++ manual, section (3), and we're getting into wayland::data_source_t — literally the moment you offer data to somebody else's app. it's giving main-character energy for the clipboard. 💅

🌸 NAME 🌸

wayland::data_source_t — offer to transfer data ✨

🎀 SYNOPSIS 🎀

#include <wayland-client-protocol.hpp>

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. yes bestie, tell everyone what you've got 🍓
  • void set_actions (data_device_manager_dnd_action const &dnd_actions) — set the available drag-and-drop actions, so drag-and-drop knows what's on the menu ✨
  • bool can_set_actions () const — Check whether the set_actions function is available with the currently bound version of the protocol. lowkey important before you call it 👀
  • std::function< void(std::string)> & on_target () — a target accepts an offered mime type. slay, they picked one 💅
  • std::function< void(std::string, int)> & on_send () — send the data. this is the actual handoff, no cap 📦
  • std::function< void()> & on_cancelled () — selection was cancelled. rip, it's over 😭
  • std::function< void()> & on_dnd_drop_performed () — the drag-and-drop operation physically finished 🫶
  • std::function< void()> & on_dnd_finished () — the drag-and-drop operation concluded. periodt, it's done ✨
  • std::function< void(data_device_manager_dnd_action)> & on_action () — notify the selected action, so you know which vibe they chose 🌈
  • 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. (yes, it's giving the same energy twice, but that's what the page says 🫠)
  • 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.
  • static constexpr std::uint32_t set_actions_since_version = 3 — Minimum protocol version required for the set_actions function.

✨ Detailed Description ✨

offer to transfer data 💌

The wl_data_source object is the source side of a wl_data_offer. It is created by the source client in a data transfer and provides a way to describe the offered data and a way to respond to requests to transfer the data.

Definition at line 1002 of file wayland-client-protocol.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. this is the lore, bestie 🧚

💀 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. 🙈 (do not touch, fr fr)
  • 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 117 of file wayland-client.hpp.

✨ MEMBER FUNCTION DOCUMENTATION ✨

okay bestie, here's the function-by-function tea ☕ — every signature, every return value, every cursed edge case, all of it. no skips. 💅

wl_proxy * wayland::proxy_t::c_ptr () const — inherited

Get a pointer to the underlying C struct. 🫶

Returns — the underlying wl_proxy that this proxy_t is wrapping, if it exists. if it doesn't exist? it throws. so like, vibe check your wrapper before you go dereferencing, ngl.

bool data_source_t::can_set_actions () const

Check whether the set_actions function is even available with the protocol version you're currently bound to. icon behaviour fr — don't call stuff that isn't there. ✨

Defined at line 2158 of wayland-client-protocol.cpp.

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. literally its little name tag. 🏷️

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 version, or 0 if the proxy was created with the unversioned API.

a returned value of 0 means no version info is available, so the caller must make safe assumptions about the object's real version. no guessing and then crying about it. 😭

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. 👑

Defined at line 303 of wayland-client-protocol.hpp.

void data_source_t::offer (std::string const & mime_type)

add an offered mime type. 💖

Parameters

  • mime_type — mime type offered by the data source

This request adds a mime type to the set of mime types advertised to targets. can be called several times to offer multiple types — go off, offer them all. 🌈

Defined at line 2147 of wayland-client-protocol.cpp.

std::function< void(data_device_manager_dnd_action)> & data_source_t::on_action ()

notify the selected action. ✨

Parameters

  • dnd_action — action selected by the compositor

This event says which action the compositor picked after matching the source/destination side actions. only one action (or none) gets offered here.

This event can be emitted multiple times during the drag-and-drop operation — mainly in response to destination side changes through wl_data_offer.set_actions, and as the data device enters/leaves surfaces.

It's only possible to receive this event after wl_data_source.dnd_drop_performed if the drag-and-drop operation ended in an "ask" action, in which case the final wl_data_source.action event will happen immediately before wl_data_source.dnd_finished. ⏱️

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. the chosen action may change alongside negotiation (e.g. an "ask" action can turn into a "move" operation), so the effects of the final action must always be applied in wl_data_offer.dnd_finished.

Clients can trigger cursor surface changes from this point, so they reflect the current action. 🖱️

Defined at line 2189 of wayland-client-protocol.cpp.

std::function< void()> & data_source_t::on_cancelled ()

selection was cancelled — this data source is no longer valid. 💀 there are several reasons why this could happen:

  • The data source has been replaced by another data source.
  • The drag-and-drop operation was performed, but the drop destination did not accept any of the mime types offered through wl_data_source.target.
  • The drag-and-drop operation was performed, but the drop destination did not select any of the actions present in the mask offered through wl_data_source.action.
  • The drag-and-drop operation was performed but didn't happen over a surface.
  • The compositor cancelled the drag-and-drop operation (e.g. compositor dependent timeouts to avoid stale drag-and-drop transfers).

The client should clean up and destroy this data source. 🧹

For objects of version 2 or older, wl_data_source.cancelled will only be emitted if the data source was replaced by another data source.

Defined at line 2174 of wayland-client-protocol.cpp.

std::function< void()> & data_source_t::on_dnd_drop_performed ()

the drag-and-drop operation physically finished. 🫳 the user performed the drop action. this event does not indicate acceptance — wl_data_source.cancelled may still be emitted afterwards if the drop destination does not accept any mime type.

However, this event might however not be received if the compositor cancelled the drag-and-drop operation before this event could happen. 🙈

Note that the data_source may still be used in the future and should not be destroyed here. no premature destroying, bestie, that's giving undefined chaos.

Defined at line 2179 of wayland-client-protocol.cpp.

std::function< void()> & data_source_t::on_dnd_finished ()

the drag-and-drop operation concluded. 🎬 the drop destination finished interoperating with this data source, so the client is now free to destroy this data source and free all associated data.

If the action used to perform the operation was "move", the source can now delete the transferred data. 📦

Defined at line 2184 of wayland-client-protocol.cpp.

std::function< void(std::string, int)> & data_source_t::on_send ()

send the data. 📤

Parameters

  • mime_type — mime type for the data
  • fd — file descriptor for the data

Request for data from the client. send the data as the specified mime type over the passed file descriptor, then close it. closing it is not optional, iykyk. ✨

Defined at line 2169 of wayland-client-protocol.cpp.

std::function< void(std::string)> & data_source_t::on_target ()

a target accepts an offered mime type. 🎯

Parameters

  • mime_type — mime type accepted by the target

Sent when a target accepts pointer_focus or motion events. if a target does not accept any of the offered types, type is NULL.

Used for feedback during drag-and-drop. 💫

Defined at line 2164 of wayland-client-protocol.cpp.

wayland::proxy_t::operator bool () const — inherited

Check whether this wrapper actually wraps an object. the realest vibe check in the whole file tbh. 🪞

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. same energy as operator bool, just saying it plainly.

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. 🍃

heads up: display_t instances cannot be released this way. attempts to do so are just ignored — no error, no drama, nothing happens.

Examples: foreign_display.cpp.

void data_source_t::set_actions (data_device_manager_dnd_action const & dnd_actions)

set the available drag-and-drop actions. 🎮

Parameters

  • dnd_actions — actions supported by the data source

Sets the actions that the source side client supports for this operation. this request may trigger wl_data_source.action and wl_data_offer.action events if the compositor needs to change the selected action.

the dnd_actions argument must contain only values expressed in the wl_data_device_manager.dnd_actions enum, otherwise it will result in a protocol error. ⚠️ no freestyle enum values, bestie.

This request must be made once only, and can only be made on sources used in drag-and-drop, so it must be performed before wl_data_device.start_drag. attempting to use the source other than for drag-and-drop will raise a protocol error. 😭

Defined at line 2153 of wayland-client-protocol.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 🌸

std::uint32_t wayland::data_source_t::offer_since_version = 1 — [static], [constexpr]

Minimum protocol version required for the offer function. that's a 1, so it's basically always there for you. 🥰

Defined at line 1042 of wayland-client-protocol.hpp.

std::uint32_t wayland::data_source_t::set_actions_since_version = 3 — [static], [constexpr]

Minimum protocol version required for the set_actions function. it's a 3, hence why can_set_actions exists to check for you. 👑

Defined at line 1066 of wayland-client-protocol.hpp.

👑 AUTHOR 👑

Generated automatically by Doxygen for Wayland++ from the source code. not a human, just a very diligent little document generator doing its thing. 🤖💜

and that's the whole page, bestie — you ate it all up. 🍓 version 1.0.1, dated Fri Mar 27 2026 13:15:00, wayland::data_source_t(3), slay, periodt. 🎀✨🦋

📦 where this page comes from