Struct gtk4::DragIcon

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

DragIcon is a Root implementation for drag icons.

A drag icon moves with the pointer during a Drag-and-Drop operation and is destroyed when the drag ends.

To set up a drag icon and associate it with an ongoing drag operation, use for_drag() to get the icon for a drag. You can then use it like any other widget and use set_child() to set whatever widget should be used for the drag icon.

Keep in mind that drag icons do not allow user input.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, RootExt, WidgetExtManual, AccessibleExtManual

Implementations

impl DragIcon

pub fn child(&self) -> Option<Widget>

Gets the widget currently used as drag icon.

Returns

The drag icon

pub fn set_child(&self, child: Option<&impl IsA<Widget>>)

Sets the widget to display as the drag icon.

child

a Widget

pub fn create_widget_for_value(value: &Value) -> Option<Widget>

Creates a widget that can be used as a drag icon for the given @value.

Supported types include strings, gdk::RGBA and TextBuffer. If GTK does not know how to create a widget for a given value, it will return None.

This method is used to set the default drag icon on drag-and-drop operations started by DragSource, so you don’t need to set a drag icon using this function there.

value

a GValue

Returns

A new Widget for displaying @value as a drag icon.

pub fn for_drag(drag: &Drag) -> Widget

Gets the DragIcon in use with @drag.

If no drag icon exists yet, a new one will be created and shown.

drag

a gdk::Drag

Returns

the DragIcon

pub fn set_from_paintable( drag: &Drag, paintable: &impl IsA<Paintable>, hot_x: i32, hot_y: i32 )

Creates a DragIcon that shows @paintable, and associates it with the drag operation.

The hotspot position on the paintable is aligned with the hotspot of the cursor.

drag

a gdk::Drag

paintable

a gdk::Paintable to display

hot_x

X coordinate of the hotspot

hot_y

Y coordinate of the hotspot

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

Trait Implementations

impl Clone for DragIcon

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 DragIcon

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

Formats the value using the given formatter.

impl Display for DragIcon

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

Formats the value using the given formatter.

impl Hash for DragIcon

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 DragIcon

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 DragIcon

type Parent = Widget

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

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 DragIcon

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 DragIcon

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DragIcon

impl IsA<Accessible> for DragIcon

impl IsA<Buildable> for DragIcon

impl IsA<ConstraintTarget> for DragIcon

impl IsA<Native> for DragIcon

impl IsA<Root> for DragIcon

impl IsA<Widget> for DragIcon