gdk4/auto/

drag.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{
    ContentFormats, ContentProvider, Device, Display, DragAction, DragCancelReason, Surface, ffi,
};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Represents the source of an ongoing DND operation.
    ///
    /// A [`Drag`][crate::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()`][Self::begin()],
    /// the caller gets informed about the status of the ongoing drag operation
    /// with signals on the [`Drag`][crate::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`][crate::ContentProvider].
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `device`
    ///  The [`Device`][crate::Device] that is performing the drag.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `display`
    ///  The [`Display`][crate::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`][trait@crate::prelude::DragExt]
    #[doc(alias = "GdkDrag")]
    pub struct Drag(Object<ffi::GdkDrag>);

    match fn {
        type_ => || ffi::gdk_drag_get_type(),
    }
}

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

    /// 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()`][crate::prelude::DragExt::drag_surface()].
    ///
    /// This function returns a reference to the [`Drag`][crate::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`][crate::DragAction::MOVE], you need to listen for
    /// the [`dnd-finished`][struct@crate::Drag#dnd-finished] signal and delete the data at
    /// the source if [`DragExt::selected_action()`][crate::prelude::DragExt::selected_action()] returns
    /// [`DragAction::MOVE`][crate::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`][crate::Drag]
    #[doc(alias = "gdk_drag_begin")]
    pub fn begin(
        surface: &impl IsA<Surface>,
        device: &impl IsA<Device>,
        content: &impl IsA<ContentProvider>,
        actions: DragAction,
        dx: f64,
        dy: f64,
    ) -> Option<Drag> {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::gdk_drag_begin(
                surface.as_ref().to_glib_none().0,
                device.as_ref().to_glib_none().0,
                content.as_ref().to_glib_none().0,
                actions.into_glib(),
                dx,
                dy,
            ))
        }
    }
}

/// Trait containing all [`struct@Drag`] methods.
///
/// # Implementors
///
/// [`Drag`][struct@crate::Drag]
pub trait DragExt: IsA<Drag> + 'static {
    /// Informs GDK that the drop ended.
    ///
    /// Passing [`false`] for @success may trigger a drag cancellation
    /// animation.
    ///
    /// This function is called by the drag source, and should be the
    /// last call before dropping the reference to the @self.
    ///
    /// The [`Drag`][crate::Drag] will only take the first [`drop_done()`][Self::drop_done()]
    /// call as effective, if this function is called multiple times,
    /// all subsequent calls will be ignored.
    /// ## `success`
    /// whether the drag was ultimatively successful
    #[doc(alias = "gdk_drag_drop_done")]
    fn drop_done(&self, success: bool) {
        unsafe {
            ffi::gdk_drag_drop_done(self.as_ref().to_glib_none().0, success.into_glib());
        }
    }

    /// Determines the bitmask of possible actions proposed by the source.
    ///
    /// # Returns
    ///
    /// the [`DragAction`][crate::DragAction] flags
    #[doc(alias = "gdk_drag_get_actions")]
    #[doc(alias = "get_actions")]
    fn actions(&self) -> DragAction {
        unsafe { from_glib(ffi::gdk_drag_get_actions(self.as_ref().to_glib_none().0)) }
    }

    /// Returns the [`ContentProvider`][crate::ContentProvider] associated to the [`Drag`][crate::Drag] object.
    ///
    /// # Returns
    ///
    /// The [`ContentProvider`][crate::ContentProvider] associated to @self.
    #[doc(alias = "gdk_drag_get_content")]
    #[doc(alias = "get_content")]
    fn content(&self) -> ContentProvider {
        unsafe { from_glib_none(ffi::gdk_drag_get_content(self.as_ref().to_glib_none().0)) }
    }

    /// Returns the [`Device`][crate::Device] associated to the [`Drag`][crate::Drag] object.
    ///
    /// # Returns
    ///
    /// The [`Device`][crate::Device] associated to @self.
    #[doc(alias = "gdk_drag_get_device")]
    #[doc(alias = "get_device")]
    fn device(&self) -> Device {
        unsafe { from_glib_none(ffi::gdk_drag_get_device(self.as_ref().to_glib_none().0)) }
    }

    /// Gets the [`Display`][crate::Display] that the drag object was created for.
    ///
    /// # Returns
    ///
    /// a [`Display`][crate::Display]
    #[doc(alias = "gdk_drag_get_display")]
    #[doc(alias = "get_display")]
    fn display(&self) -> Display {
        unsafe { from_glib_none(ffi::gdk_drag_get_display(self.as_ref().to_glib_none().0)) }
    }

    /// Returns the surface on which the drag icon should be rendered
    /// during the drag operation.
    ///
    /// Note that the surface may not be available until the drag operation
    /// has begun. GDK will move the surface in accordance with the ongoing
    /// drag operation. The surface is owned by @self and will be destroyed
    /// when the drag operation is over.
    ///
    /// # Returns
    ///
    /// the drag surface
    #[doc(alias = "gdk_drag_get_drag_surface")]
    #[doc(alias = "get_drag_surface")]
    fn drag_surface(&self) -> Option<Surface> {
        unsafe {
            from_glib_none(ffi::gdk_drag_get_drag_surface(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves the formats supported by this [`Drag`][crate::Drag] object.
    ///
    /// # Returns
    ///
    /// a [`ContentFormats`][crate::ContentFormats]
    #[doc(alias = "gdk_drag_get_formats")]
    #[doc(alias = "get_formats")]
    fn formats(&self) -> ContentFormats {
        unsafe { from_glib_none(ffi::gdk_drag_get_formats(self.as_ref().to_glib_none().0)) }
    }

    /// Determines the action chosen by the drag destination.
    ///
    /// # Returns
    ///
    /// a [`DragAction`][crate::DragAction] value
    #[doc(alias = "gdk_drag_get_selected_action")]
    #[doc(alias = "get_selected_action")]
    #[doc(alias = "selected-action")]
    fn selected_action(&self) -> DragAction {
        unsafe {
            from_glib(ffi::gdk_drag_get_selected_action(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Returns the [`Surface`][crate::Surface] where the drag originates.
    ///
    /// # Returns
    ///
    /// The [`Surface`][crate::Surface] where the drag originates
    #[doc(alias = "gdk_drag_get_surface")]
    #[doc(alias = "get_surface")]
    fn surface(&self) -> Surface {
        unsafe { from_glib_none(ffi::gdk_drag_get_surface(self.as_ref().to_glib_none().0)) }
    }

    /// Sets the position of the drag surface that will be kept
    /// under the cursor hotspot.
    ///
    /// Initially, the hotspot is at the top left corner of the drag surface.
    /// ## `hot_x`
    /// x coordinate of the drag surface hotspot
    /// ## `hot_y`
    /// y coordinate of the drag surface hotspot
    #[doc(alias = "gdk_drag_set_hotspot")]
    fn set_hotspot(&self, hot_x: i32, hot_y: i32) {
        unsafe {
            ffi::gdk_drag_set_hotspot(self.as_ref().to_glib_none().0, hot_x, hot_y);
        }
    }

    /// The possible actions of this drag.
    fn set_actions(&self, actions: DragAction) {
        ObjectExt::set_property(self.as_ref(), "actions", actions)
    }

    /// The currently selected action of the drag.
    #[doc(alias = "selected-action")]
    fn set_selected_action(&self, selected_action: DragAction) {
        ObjectExt::set_property(self.as_ref(), "selected-action", selected_action)
    }

    /// Emitted when the drag operation is cancelled.
    /// ## `reason`
    /// The reason the drag was cancelled
    #[doc(alias = "cancel")]
    fn connect_cancel<F: Fn(&Self, DragCancelReason) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn cancel_trampoline<
            P: IsA<Drag>,
            F: Fn(&P, DragCancelReason) + 'static,
        >(
            this: *mut ffi::GdkDrag,
            reason: ffi::GdkDragCancelReason,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    Drag::from_glib_borrow(this).unsafe_cast_ref(),
                    from_glib(reason),
                )
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"cancel".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    cancel_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when the destination side has finished reading all data.
    ///
    /// The drag object can now free all miscellaneous data.
    #[doc(alias = "dnd-finished")]
    fn connect_dnd_finished<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn dnd_finished_trampoline<P: IsA<Drag>, F: Fn(&P) + 'static>(
            this: *mut ffi::GdkDrag,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Drag::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"dnd-finished".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    dnd_finished_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted when the drop operation is performed on an accepting client.
    #[doc(alias = "drop-performed")]
    fn connect_drop_performed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn drop_performed_trampoline<P: IsA<Drag>, F: Fn(&P) + 'static>(
            this: *mut ffi::GdkDrag,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Drag::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drop-performed".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drop_performed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "actions")]
    fn connect_actions_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_actions_trampoline<P: IsA<Drag>, F: Fn(&P) + 'static>(
            this: *mut ffi::GdkDrag,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Drag::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::actions".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_actions_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "display")]
    fn connect_display_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_display_trampoline<P: IsA<Drag>, F: Fn(&P) + 'static>(
            this: *mut ffi::GdkDrag,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Drag::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::display".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_display_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "selected-action")]
    fn connect_selected_action_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_selected_action_trampoline<
            P: IsA<Drag>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GdkDrag,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(Drag::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::selected-action".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_selected_action_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<Drag>> DragExt for O {}