Struct gtk4::DropControllerMotion

#[repr(transparent)]
pub struct DropControllerMotion { /* private fields */ }

DropControllerMotion is an event controller tracking the pointer during Drag-and-Drop operations.

It is modeled after EventControllerMotion so if you have used that, this should feel really familiar.

This controller is not able to accept drops, use DropTarget for that purpose.

Properties

contains-pointer

Whether the pointer of a Drag-and-Drop operation is in the controller’s widget or a descendant.

See also is-pointer.

When handling crossing events, this property is updated before enter, but after leave is emitted.

Readable

drop

The ongoing drop operation over the controller’s widget or its descendant.

If no drop operation is going on, this property returns None.

The event controller should not modify the @drop, but it might want to query its properties.

When handling crossing events, this property is updated before enter, but after leave is emitted.

Readable

is-pointer

Whether the pointer is in the controllers widget itself, as opposed to in a descendent widget.

See also contains-pointer.

When handling crossing events, this property is updated before enter, but after leave is emitted.

Readable

EventController

name

The name for this controller, typically used for debugging purposes.

Readable | Writeable

propagation-limit

The limit for which events this controller will handle.

Readable | Writeable

propagation-phase

The propagation phase at which this controller will handle events.

Readable | Writeable

widget

The widget receiving the GdkEvents that the controller will handle.

Readable

Signals

enter

Signals that the pointer has entered the widget.

leave

Signals that the pointer has left the widget.

motion

Emitted when the pointer moves inside the widget.

Implements

EventControllerExt, glib::ObjectExt

Implementations

impl DropControllerMotion

pub fn new() -> DropControllerMotion

Creates a new event controller that will handle pointer motion events during drag and drop.

Returns

a new DropControllerMotion

pub fn builder() -> DropControllerMotionBuilder

Creates a new builder-pattern struct instance to construct DropControllerMotion objects.

This method returns an instance of DropControllerMotionBuilder which can be used to create DropControllerMotion objects.

pub fn contains_pointer(&self) -> bool

Returns if a Drag-and-Drop operation is within the widget @self or one of its children.

Returns

true if a dragging pointer is within @self or one of its children.

pub fn drop(&self) -> Option<Drop>

Returns the gdk::Drop of a current Drag-and-Drop operation over the widget of @self.

Returns

The gdk::Drop currently happening within @self

pub fn is_pointer(&self) -> bool

Returns if a Drag-and-Drop operation is within the widget @self, not one of its children.

Returns

true if a dragging pointer is within @self but not one of its children

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

Signals that the pointer has entered the widget.

x

coordinates of pointer location

y

coordinates of pointer location

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

Signals that the pointer has left the widget.

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

Emitted when the pointer moves inside the widget.

x

the x coordinate

y

the y coordinate

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

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

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

Trait Implementations

impl Clone for DropControllerMotion

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 DropControllerMotion

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

Formats the value using the given formatter.

impl Default for DropControllerMotion

fn default() -> Self

Returns the “default value” for a type.

impl Display for DropControllerMotion

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

Formats the value using the given formatter.

impl HasParamSpec for DropControllerMotion

type ParamSpec = ParamSpecObject

type SetValue = DropControllerMotion

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DropControllerMotion

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 DropControllerMotion

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for DropControllerMotion

type Parent = EventController

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

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 DropControllerMotion

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 DropControllerMotion

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DropControllerMotion

impl IsA<EventController> for DropControllerMotion