Struct gdk4::Drop

pub struct Drop { /* private fields */ }

The Drop object represents the target of an ongoing DND operation.

Possible drop sites get informed about the status of the ongoing drag operation with events of type EventType::DragEnter, EventType::DragLeave, EventType::DragMotion and EventType::DropStart. The Drop object can be obtained from these Event types using DNDEvent::drop().

The actual data transfer is initiated from the target side via an async read, using one of the Drop methods for this purpose: read_async() or read_value_async().

GTK provides a higher level abstraction based on top of these functions, and so they are not normally needed in GTK applications. See the “Drag and Drop” section of the GTK documentation for more information.

This is an Abstract Base Class, you cannot instantiate it.

Properties

actions

The possible actions for this drop

Readable | Writeable | Construct Only

device

The Device performing the drop

Readable | Writeable | Construct Only

display

The Display that the drop belongs to.

Readable

drag

The Drag that initiated this drop

Readable | Writeable | Construct Only

formats

The possible formats that the drop can provide its data in.

Readable | Writeable | Construct Only

surface

The Surface the drop happens on

Readable | Writeable | Construct Only

Implementations

impl Drop

pub fn finish(&self, action: DragAction)

Ends the drag operation after a drop.

The @action must be a single action selected from the actions available via actions().

action

the action performed by the destination or 0 if the drop failed

pub fn actions(&self) -> DragAction

Returns the possible actions for this Drop.

If this value contains multiple actions - i.e. DragAction::is_unique() returns false for the result - finish() must choose the action to use when accepting the drop. This will only happen if you passed DragAction::ASK as one of the possible actions in status(). DragAction::ASK itself will not be included in the actions returned by this function.

This value may change over the lifetime of the Drop both as a response to source side actions as well as to calls to status() or finish(). The source side will not change this value anymore once a drop has started.

Returns

The possible GdkDragActions

pub fn device(&self) -> Device

Returns the Device performing the drop.

Returns

The Device performing the drop.

pub fn display(&self) -> Display

Gets the Display that @self was created for.

Returns

a Display

pub fn drag(&self) -> Option<Drag>

If this is an in-app drag-and-drop operation, returns the Drag that corresponds to this drop.

If it is not, None is returned.

Returns

the corresponding Drag

pub fn formats(&self) -> ContentFormats

Returns the ContentFormats that the drop offers the data to be read in.

Returns

The possible ContentFormats

pub fn surface(&self) -> Surface

Returns the Surface performing the drop.

Returns

The Surface performing the drop.

pub fn read_value_async<P: FnOnce(Result<Value, Error>) + 'static>( &self, type_: Type, io_priority: Priority, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

Asynchronously request the drag operation’s contents converted to the given @type_.

When the operation is finished @callback will be called. You must then call Gdk::Drop::read_value_finish() to get the resulting GValue.

For local drag-and-drop operations that are available in the given GType, the value will be copied directly. Otherwise, GDK will try to use content_deserialize_async() to convert the data.

type_

a GType to read

io_priority

the I/O priority of the request.

cancellable

optional GCancellable object, None to ignore.

callback

callback to call when the request is satisfied

pub fn read_value_future( &self, type_: Type, io_priority: Priority ) -> Pin<Box_<dyn Future<Output = Result<Value, Error>> + 'static>>

pub fn status(&self, actions: DragAction, preferred: DragAction)

Selects all actions that are potentially supported by the destination.

When calling this function, do not restrict the passed in actions to the ones provided by actions(). Those actions may change in the future, even depending on the actions you provide here.

The @preferred action is a hint to the drag-and-drop mechanism about which action to use when multiple actions are possible.

This function should be called by drag destinations in response to EventType::DragEnter or EventType::DragMotion events. If the destination does not yet know the exact actions it supports, it should set any possible actions first and then later call this function again.

actions

Supported actions of the destination, or 0 to indicate that a drop will not be accepted

preferred

A unique action that’s a member of @actions indicating the preferred action

pub fn connect_display_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl Drop

pub fn read_async<Q: FnOnce(Result<(InputStream, GString), Error>) + 'static>( &self, mime_types: &[&str], io_priority: Priority, cancellable: Option<&impl IsA<Cancellable>>, callback: Q )

Asynchronously read the dropped data from a Drop in a format that complies with one of the mime types.

mime_types

pointer to an array of mime types

io_priority

the I/O priority for the read operation

cancellable

optional GCancellable object

callback

a GAsyncReadyCallback to call when the request is satisfied

pub fn read_future( &self, mime_types: &[&str], io_priority: Priority ) -> Pin<Box<dyn Future<Output = Result<(InputStream, GString), Error>> + 'static>>

Trait Implementations

impl Clone for Drop

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Drop

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

Formats the value using the given formatter.

impl HasParamSpec for Drop

type ParamSpec = ParamSpecObject

type SetValue = Drop

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Drop>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Drop

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Drop

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Drop

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Drop

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Drop

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Drop

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Drop