Struct WlDataSource 

pub struct WlDataSource { /* private fields */ }

A wl_data_source object.

See the documentation of the module for the interface description.

Implementations

impl WlDataSource

pub fn set_handler(&self, handler: impl WlDataSourceHandler)

Sets a new handler.

pub fn set_boxed_handler(&self, handler: Box<dyn WlDataSourceHandler>)

Sets a new, already boxed handler.

impl WlDataSource

pub const MSG__OFFER__SINCE: u32 = 1u32

Since when the offer message is available.

pub const MSG__DESTROY__SINCE: u32 = 1u32

Since when the destroy message is available.

pub const MSG__TARGET__SINCE: u32 = 1u32

Since when the target message is available.

pub const MSG__SEND__SINCE: u32 = 1u32

Since when the send message is available.

pub const MSG__CANCELLED__SINCE: u32 = 1u32

Since when the cancelled message is available.

pub const MSG__SET_ACTIONS__SINCE: u32 = 3u32

Since when the set_actions message is available.

pub const MSG__DND_DROP_PERFORMED__SINCE: u32 = 3u32

Since when the dnd_drop_performed message is available.

pub const MSG__DND_FINISHED__SINCE: u32 = 3u32

Since when the dnd_finished message is available.

pub const MSG__ACTION__SINCE: u32 = 3u32

Since when the action message is available.

pub fn try_send_offer(&self, mime_type: &str) -> Result<(), ObjectError>

add an offered 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.

Arguments

• mime_type: mime type offered by the data source

pub fn send_offer(&self, mime_type: &str)

add an offered 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.

Arguments

• mime_type: mime type offered by the data source

pub fn try_send_destroy(&self) -> Result<(), ObjectError>

destroy the data source

Destroy the data source.

pub fn send_destroy(&self)

destroy the data source

Destroy the data source.

pub fn try_send_target( &self, mime_type: Option<&str>, ) -> Result<(), ObjectError>

a target accepts an offered mime type

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.

Arguments

• mime_type: mime type accepted by the target

pub fn send_target(&self, mime_type: Option<&str>)

a target accepts an offered mime type

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.

Arguments

• mime_type: mime type accepted by the target

pub fn try_send_send( &self, mime_type: &str, fd: &Rc<OwnedFd>, ) -> Result<(), ObjectError>

send the data

Request for data from the client. Send the data as the specified mime type over the passed file descriptor, then close it.

Arguments

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

pub fn send_send(&self, mime_type: &str, fd: &Rc<OwnedFd>)

send the data

Request for data from the client. Send the data as the specified mime type over the passed file descriptor, then close it.

Arguments

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

pub fn try_send_cancelled(&self) -> Result<(), ObjectError>

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.

pub fn send_cancelled(&self)

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.

pub fn try_send_set_actions( &self, dnd_actions: WlDataDeviceManagerDndAction, ) -> Result<(), ObjectError>

set the available drag-and-drop actions

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.

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.

Arguments

• dnd_actions: actions supported by the data source

pub fn send_set_actions(&self, dnd_actions: WlDataDeviceManagerDndAction)

set the available drag-and-drop actions

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.

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.

Arguments

• dnd_actions: actions supported by the data source

pub fn try_send_dnd_drop_performed(&self) -> Result<(), ObjectError>

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.

pub fn send_dnd_drop_performed(&self)

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.

pub fn try_send_dnd_finished(&self) -> Result<(), ObjectError>

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.

pub fn send_dnd_finished(&self)

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.

pub fn try_send_action( &self, dnd_action: WlDataDeviceManagerDndAction, ) -> Result<(), ObjectError>

notify the selected action

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, mainly in response to destination side changes through wl_data_offer.set_actions, and as the data device enters/leaves surfaces.

It is 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.

Arguments

• dnd_action: action selected by the compositor

pub fn send_action(&self, dnd_action: WlDataDeviceManagerDndAction)

notify the selected action

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, mainly in response to destination side changes through wl_data_offer.set_actions, and as the data device enters/leaves surfaces.

It is 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.

Arguments

• dnd_action: action selected by the compositor

impl WlDataSource

pub const ENM__ERROR_INVALID_ACTION_MASK__SINCE: u32 = 1u32

Since when the error.invalid_action_mask enum variant is available.

pub const ENM__ERROR_INVALID_SOURCE__SINCE: u32 = 1u32

Since when the error.invalid_source enum variant is available.

Trait Implementations

impl ConcreteObject for WlDataSource

const XML_VERSION: u32 = 3u32

The interface version from the XML file that the interface was generated from.

const INTERFACE: ObjectInterface = ObjectInterface::WlDataSource

The interface of the object.

const INTERFACE_NAME: &str = "wl_data_source"

The interface of the object as a string.

impl Debug for WlDataSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Object for WlDataSource

fn core(&self) -> &ObjectCore

Returns the ObjectCore of this object.

fn unset_handler(&self)

Unsets the handler of this object.

fn get_handler_any_ref( &self, ) -> Result<HandlerRef<'_, dyn Any>, HandlerAccessError>

Returns a shared reference to the handler.

fn get_handler_any_mut( &self, ) -> Result<HandlerMut<'_, dyn Any>, HandlerAccessError>

Returns a mutable reference to the handler.