Struct gdk4::Drag

pub struct Drag { /* private fields */ }

The Drag object represents the source of an ongoing DND operation.

A Drag is created when a drag is started, and stays alive for duration of the DND operation. After a drag has been started with begin(), the caller gets informed about the status of the ongoing drag operation with signals on the Drag object.

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 of this drag.

Readable | Writeable

content

The ContentProvider.

Readable | Writeable | Construct Only

device

The Device that is performing the drag.

Readable | Writeable | Construct Only

display

The Display that the drag belongs to.

Readable

formats

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

Readable | Writeable | Construct Only

selected-action

The currently selected action of the drag.

Readable | Writeable

surface

The surface where the drag originates.

Readable | Writeable | Construct Only

Signals

cancel

Emitted when the drag operation is cancelled.

dnd-finished

Emitted when the destination side has finished reading all data.

The drag object can now free all miscellaneous data.

drop-performed

Emitted when the drop operation is performed on an accepting client.

Implements

DragExt

Implementations

impl Drag

pub const NONE: Option<&'static Drag> = None

pub fn begin( surface: &impl IsA<Surface>, device: &impl IsA<Device>, content: &impl IsA<ContentProvider>, actions: DragAction, dx: f64, dy: f64 ) -> Option<Drag>

Starts a drag and creates a new drag context for it.

This function is called by the drag source. After this call, you probably want to set up the drag icon using the surface returned by DragExt::drag_surface().

This function returns a reference to the Drag object, but GTK keeps its own reference as well, as long as the DND operation is going on.

Note: if @actions include DragAction::MOVE, you need to listen for the dnd-finished signal and delete the data at the source if DragExt::selected_action() returns DragAction::MOVE.

surface

the source surface for this drag

device

the device that controls this drag

content

the offered content

actions

the actions supported by this drag

dx

the x offset to @device’s position where the drag nominally started

dy

the y offset to @device’s position where the drag nominally started

Returns

a newly created Drag

Trait Implementations

impl Clone for Drag

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 Drag

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

Formats the value using the given formatter.

impl HasParamSpec for Drag

type ParamSpec = ParamSpecObject

type SetValue = Drag

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Drag

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 Drag

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 Drag

type Parent = Object

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

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 Drag

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 Drag

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Drag