Struct wayland_server::protocol::wl_data_offer::WlDataOffer
[−]
[src]
pub struct WlDataOffer { /* fields omitted */ }
Methods
impl WlDataOffer
[src]
fn offer(&self, mime_type: String) -> EventResult<()>
[src]
advertise offered mime type
Sent immediately after creating the wl_data_offer object. One event per offered mime type.
fn source_actions(&self, source_actions: u32) -> EventResult<()>
[src]
notify the source-side available actions
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.
This event is only available since version 3 of the interface
fn action(&self, dnd_action: u32) -> EventResult<()>
[src]
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 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.
This event is only available since version 3 of the interface
Trait Implementations
impl Send for WlDataOffer
[src]
impl Sync for WlDataOffer
[src]
impl Resource for WlDataOffer
[src]
fn ptr(&self) -> *mut wl_resource
[src]
Pointer to the underlying wayland proxy object
unsafe fn from_ptr_new(ptr: *mut wl_resource) -> WlDataOffer
[src]
Create an instance from a wayland pointer Read more
unsafe fn from_ptr_initialized(ptr: *mut wl_resource) -> WlDataOffer
[src]
Create an instance from a wayland pointer Read more
fn interface_ptr() -> *const wl_interface
[src]
Pointer to the interface representation
fn interface_name() -> &'static str
[src]
Internal wayland name of this interface
fn supported_version() -> u32
[src]
Max version of this interface supported
fn version(&self) -> i32
[src]
Current version of the interface this resource is instantiated with
fn status(&self) -> Liveness
[src]
Check if the resource behind this handle is actually still alive
fn equals(&self, other: &WlDataOffer) -> bool
[src]
Check of two handles are actually the same wayland object Read more
fn set_user_data(&self, ptr: *mut ())
[src]
Set a pointer associated as user data on this resource Read more
fn get_user_data(&self) -> *mut ()
[src]
Get the pointer associated as user data on this resource Read more
unsafe fn clone_unchecked(&self) -> WlDataOffer
[src]
Unsafely clone this resource handle Read more
fn post_error(&self, error_code: u32, msg: String)
[src]
Posts a protocol error to this resource Read more
fn clone(&self) -> Option<Self> where
Self: Sized,
[src]
Self: Sized,
Clone this resource handle Read more
fn same_client_as<R: Resource>(&self, other: &R) -> bool
[src]
Checks wether this resource and the other are from the same client Read more
impl<ID: 'static> Implementable<ID> for WlDataOffer
[src]
type Implementation = Implementation<ID>
The type containing the implementation for the event callbacks
unsafe fn __dispatch_msg(
&self,
client: &Client,
opcode: u32,
args: *const wl_argument
) -> Result<(), ()>
[src]
&self,
client: &Client,
opcode: u32,
args: *const wl_argument
) -> Result<(), ()>