gtk4/auto/

drop_target_async.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::{ffi, EventController, PropagationLimit, PropagationPhase};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// [`DropTargetAsync`][crate::DropTargetAsync] is an event controller to receive Drag-and-Drop
    /// operations, asynchronously.
    ///
    /// It is the more complete but also more complex method of handling drop
    /// operations compared to [`DropTarget`][crate::DropTarget], and you should only use
    /// it if [`DropTarget`][crate::DropTarget] doesn't provide all the features you need.
    ///
    /// To use a [`DropTargetAsync`][crate::DropTargetAsync] to receive drops on a widget, you create
    /// a [`DropTargetAsync`][crate::DropTargetAsync] object, configure which data formats and actions
    /// you support, connect to its signals, and then attach it to the widget
    /// with [`WidgetExt::add_controller()`][crate::prelude::WidgetExt::add_controller()].
    ///
    /// During a drag operation, the first signal that a [`DropTargetAsync`][crate::DropTargetAsync]
    /// emits is [`accept`][struct@crate::DropTargetAsync#accept], which is meant to determine
    /// whether the target is a possible drop site for the ongoing drop. The
    /// default handler for the ::accept signal accepts the drop if it finds
    /// a compatible data format and an action that is supported on both sides.
    ///
    /// If it is, and the widget becomes a target, you will receive a
    /// [`drag-enter`][struct@crate::DropTargetAsync#drag-enter] signal, followed by
    /// [`drag-motion`][struct@crate::DropTargetAsync#drag-motion] signals as the pointer moves,
    /// optionally a [`drop`][struct@crate::DropTargetAsync#drop] signal when a drop happens,
    /// and finally a [`drag-leave`][struct@crate::DropTargetAsync#drag-leave] signal when the
    /// pointer moves off the widget.
    ///
    /// The ::drag-enter and ::drag-motion handler return a [`gdk::DragAction`][crate::gdk::DragAction]
    /// to update the status of the ongoing operation. The ::drop handler
    /// should decide if it ultimately accepts the drop and if it does, it
    /// should initiate the data transfer and finish the operation by calling
    /// [`Drop::finish()`][crate::gdk::Drop::finish()].
    ///
    /// Between the ::drag-enter and ::drag-leave signals the widget is a
    /// current drop target, and will receive the [`StateFlags::DROP_ACTIVE`][crate::StateFlags::DROP_ACTIVE]
    /// state, which can be used by themes to style the widget as a drop target.
    ///
    /// ## Properties
    ///
    ///
    /// #### `actions`
    ///  The `GdkDragActions` that this drop target supports.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `formats`
    ///  The [`gdk::ContentFormats`][crate::gdk::ContentFormats] that determines the supported data formats.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>EventController</h4></summary>
    ///
    ///
    /// #### `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
    /// </details>
    ///
    /// ## Signals
    ///
    ///
    /// #### `accept`
    ///  Emitted on the drop site when a drop operation is about to begin.
    ///
    /// If the drop is not accepted, [`false`] will be returned and the drop target
    /// will ignore the drop. If [`true`] is returned, the drop is accepted for now
    /// but may be rejected later via a call to [`DropTargetAsync::reject_drop()`][crate::DropTargetAsync::reject_drop()]
    /// or ultimately by returning [`false`] from a [`drop`][struct@crate::DropTargetAsync#drop]
    /// handler.
    ///
    /// The default handler for this signal decides whether to accept the drop
    /// based on the formats provided by the @drop.
    ///
    /// If the decision whether the drop will be accepted or rejected needs
    /// further processing, such as inspecting the data, this function should
    /// return [`true`] and proceed as is @drop was accepted and if it decides to
    /// reject the drop later, it should call [`DropTargetAsync::reject_drop()`][crate::DropTargetAsync::reject_drop()].
    ///
    ///
    ///
    ///
    /// #### `drag-enter`
    ///  Emitted on the drop site when the pointer enters the widget.
    ///
    /// It can be used to set up custom highlighting.
    ///
    ///
    ///
    ///
    /// #### `drag-leave`
    ///  Emitted on the drop site when the pointer leaves the widget.
    ///
    /// Its main purpose it to undo things done in
    /// [`DropTargetAsync`][crate::DropTargetAsync]::drag-enter.
    ///
    ///
    ///
    ///
    /// #### `drag-motion`
    ///  Emitted while the pointer is moving over the drop target.
    ///
    ///
    ///
    ///
    /// #### `drop`
    ///  Emitted on the drop site when the user drops the data onto the widget.
    ///
    /// The signal handler must determine whether the pointer position is in a
    /// drop zone or not. If it is not in a drop zone, it returns [`false`] and no
    /// further processing is necessary.
    ///
    /// Otherwise, the handler returns [`true`]. In this case, this handler will
    /// accept the drop. The handler must ensure that [`Drop::finish()`][crate::gdk::Drop::finish()]
    /// is called to let the source know that the drop is done. The call to
    /// [`Drop::finish()`][crate::gdk::Drop::finish()] must only be done when all data has been received.
    ///
    /// To receive the data, use one of the read functions provided by
    /// [`gdk::Drop`][crate::gdk::Drop] such as [`Drop::read_async()`][crate::gdk::Drop::read_async()] or
    /// [`Drop::read_value_async()`][crate::gdk::Drop::read_value_async()].
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkDropTargetAsync")]
    pub struct DropTargetAsync(Object<ffi::GtkDropTargetAsync, ffi::GtkDropTargetAsyncClass>) @extends EventController;

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

impl DropTargetAsync {
    /// Creates a new [`DropTargetAsync`][crate::DropTargetAsync] object.
    /// ## `formats`
    /// the supported data formats
    /// ## `actions`
    /// the supported actions
    ///
    /// # Returns
    ///
    /// the new [`DropTargetAsync`][crate::DropTargetAsync]
    #[doc(alias = "gtk_drop_target_async_new")]
    pub fn new(formats: Option<gdk::ContentFormats>, actions: gdk::DragAction) -> DropTargetAsync {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gtk_drop_target_async_new(
                formats.into_glib_ptr(),
                actions.into_glib(),
            ))
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`DropTargetAsync`] objects.
    ///
    /// This method returns an instance of [`DropTargetAsyncBuilder`](crate::builders::DropTargetAsyncBuilder) which can be used to create [`DropTargetAsync`] objects.
    pub fn builder() -> DropTargetAsyncBuilder {
        DropTargetAsyncBuilder::new()
    }

    /// Gets the actions that this drop target supports.
    ///
    /// # Returns
    ///
    /// the actions that this drop target supports
    #[doc(alias = "gtk_drop_target_async_get_actions")]
    #[doc(alias = "get_actions")]
    pub fn actions(&self) -> gdk::DragAction {
        unsafe {
            from_glib(ffi::gtk_drop_target_async_get_actions(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the data formats that this drop target accepts.
    ///
    /// If the result is [`None`], all formats are expected to be supported.
    ///
    /// # Returns
    ///
    /// the supported data formats
    #[doc(alias = "gtk_drop_target_async_get_formats")]
    #[doc(alias = "get_formats")]
    pub fn formats(&self) -> Option<gdk::ContentFormats> {
        unsafe {
            from_glib_full(ffi::gtk_drop_target_async_get_formats(
                self.to_glib_none().0,
            ))
        }
    }

    /// Sets the @drop as not accepted on this drag site.
    ///
    /// This function should be used when delaying the decision
    /// on whether to accept a drag or not until after reading
    /// the data.
    /// ## `drop`
    /// the [`gdk::Drop`][crate::gdk::Drop] of an ongoing drag operation
    #[doc(alias = "gtk_drop_target_async_reject_drop")]
    pub fn reject_drop(&self, drop: &gdk::Drop) {
        unsafe {
            ffi::gtk_drop_target_async_reject_drop(self.to_glib_none().0, drop.to_glib_none().0);
        }
    }

    /// Sets the actions that this drop target supports.
    /// ## `actions`
    /// the supported actions
    #[doc(alias = "gtk_drop_target_async_set_actions")]
    #[doc(alias = "actions")]
    pub fn set_actions(&self, actions: gdk::DragAction) {
        unsafe {
            ffi::gtk_drop_target_async_set_actions(self.to_glib_none().0, actions.into_glib());
        }
    }

    /// Sets the data formats that this drop target will accept.
    /// ## `formats`
    /// the supported data formats or [`None`] for any format
    #[doc(alias = "gtk_drop_target_async_set_formats")]
    #[doc(alias = "formats")]
    pub fn set_formats(&self, formats: Option<&gdk::ContentFormats>) {
        unsafe {
            ffi::gtk_drop_target_async_set_formats(self.to_glib_none().0, formats.to_glib_none().0);
        }
    }

    /// Emitted on the drop site when a drop operation is about to begin.
    ///
    /// If the drop is not accepted, [`false`] will be returned and the drop target
    /// will ignore the drop. If [`true`] is returned, the drop is accepted for now
    /// but may be rejected later via a call to [`reject_drop()`][Self::reject_drop()]
    /// or ultimately by returning [`false`] from a [`drop`][struct@crate::DropTargetAsync#drop]
    /// handler.
    ///
    /// The default handler for this signal decides whether to accept the drop
    /// based on the formats provided by the @drop.
    ///
    /// If the decision whether the drop will be accepted or rejected needs
    /// further processing, such as inspecting the data, this function should
    /// return [`true`] and proceed as is @drop was accepted and if it decides to
    /// reject the drop later, it should call [`reject_drop()`][Self::reject_drop()].
    /// ## `drop`
    /// the [`gdk::Drop`][crate::gdk::Drop]
    ///
    /// # Returns
    ///
    /// [`true`] if @drop is accepted
    #[doc(alias = "accept")]
    pub fn connect_accept<F: Fn(&Self, &gdk::Drop) -> bool + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn accept_trampoline<
            F: Fn(&DropTargetAsync, &gdk::Drop) -> bool + 'static,
        >(
            this: *mut ffi::GtkDropTargetAsync,
            drop: *mut gdk::ffi::GdkDrop,
            f: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(drop)).into_glib()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"accept".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    accept_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted on the drop site when the pointer enters the widget.
    ///
    /// It can be used to set up custom highlighting.
    /// ## `drop`
    /// the [`gdk::Drop`][crate::gdk::Drop]
    /// ## `x`
    /// the x coordinate of the current pointer position
    /// ## `y`
    /// the y coordinate of the current pointer position
    ///
    /// # Returns
    ///
    /// Preferred action for this drag operation.
    #[doc(alias = "drag-enter")]
    pub fn connect_drag_enter<F: Fn(&Self, &gdk::Drop, f64, f64) -> gdk::DragAction + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn drag_enter_trampoline<
            F: Fn(&DropTargetAsync, &gdk::Drop, f64, f64) -> gdk::DragAction + 'static,
        >(
            this: *mut ffi::GtkDropTargetAsync,
            drop: *mut gdk::ffi::GdkDrop,
            x: std::ffi::c_double,
            y: std::ffi::c_double,
            f: glib::ffi::gpointer,
        ) -> gdk::ffi::GdkDragAction {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(drop), x, y).into_glib()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drag-enter".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drag_enter_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted on the drop site when the pointer leaves the widget.
    ///
    /// Its main purpose it to undo things done in
    /// [`DropTargetAsync`][crate::DropTargetAsync]::drag-enter.
    /// ## `drop`
    /// the [`gdk::Drop`][crate::gdk::Drop]
    #[doc(alias = "drag-leave")]
    pub fn connect_drag_leave<F: Fn(&Self, &gdk::Drop) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn drag_leave_trampoline<
            F: Fn(&DropTargetAsync, &gdk::Drop) + 'static,
        >(
            this: *mut ffi::GtkDropTargetAsync,
            drop: *mut gdk::ffi::GdkDrop,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(drop))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drag-leave".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drag_leave_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted while the pointer is moving over the drop target.
    /// ## `drop`
    /// the [`gdk::Drop`][crate::gdk::Drop]
    /// ## `x`
    /// the x coordinate of the current pointer position
    /// ## `y`
    /// the y coordinate of the current pointer position
    ///
    /// # Returns
    ///
    /// Preferred action for this drag operation.
    #[doc(alias = "drag-motion")]
    pub fn connect_drag_motion<F: Fn(&Self, &gdk::Drop, f64, f64) -> gdk::DragAction + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn drag_motion_trampoline<
            F: Fn(&DropTargetAsync, &gdk::Drop, f64, f64) -> gdk::DragAction + 'static,
        >(
            this: *mut ffi::GtkDropTargetAsync,
            drop: *mut gdk::ffi::GdkDrop,
            x: std::ffi::c_double,
            y: std::ffi::c_double,
            f: glib::ffi::gpointer,
        ) -> gdk::ffi::GdkDragAction {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(drop), x, y).into_glib()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drag-motion".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drag_motion_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted on the drop site when the user drops the data onto the widget.
    ///
    /// The signal handler must determine whether the pointer position is in a
    /// drop zone or not. If it is not in a drop zone, it returns [`false`] and no
    /// further processing is necessary.
    ///
    /// Otherwise, the handler returns [`true`]. In this case, this handler will
    /// accept the drop. The handler must ensure that [`Drop::finish()`][crate::gdk::Drop::finish()]
    /// is called to let the source know that the drop is done. The call to
    /// [`Drop::finish()`][crate::gdk::Drop::finish()] must only be done when all data has been received.
    ///
    /// To receive the data, use one of the read functions provided by
    /// [`gdk::Drop`][crate::gdk::Drop] such as [`Drop::read_async()`][crate::gdk::Drop::read_async()] or
    /// [`Drop::read_value_async()`][crate::gdk::Drop::read_value_async()].
    /// ## `drop`
    /// the [`gdk::Drop`][crate::gdk::Drop]
    /// ## `x`
    /// the x coordinate of the current pointer position
    /// ## `y`
    /// the y coordinate of the current pointer position
    ///
    /// # Returns
    ///
    /// whether the drop is accepted at the given pointer position
    #[doc(alias = "drop")]
    pub fn connect_drop<F: Fn(&Self, &gdk::Drop, f64, f64) -> bool + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn drop_trampoline<
            F: Fn(&DropTargetAsync, &gdk::Drop, f64, f64) -> bool + 'static,
        >(
            this: *mut ffi::GtkDropTargetAsync,
            drop: *mut gdk::ffi::GdkDrop,
            x: std::ffi::c_double,
            y: std::ffi::c_double,
            f: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), &from_glib_borrow(drop), x, y).into_glib()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"drop".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    drop_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "actions")]
    pub fn connect_actions_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_actions_trampoline<F: Fn(&DropTargetAsync) + 'static>(
            this: *mut ffi::GtkDropTargetAsync,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        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::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "formats")]
    pub fn connect_formats_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_formats_trampoline<F: Fn(&DropTargetAsync) + 'static>(
            this: *mut ffi::GtkDropTargetAsync,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::formats".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_formats_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for DropTargetAsync {
    fn default() -> Self {
        glib::object::Object::new::<Self>()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`DropTargetAsync`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct DropTargetAsyncBuilder {
    builder: glib::object::ObjectBuilder<'static, DropTargetAsync>,
}

impl DropTargetAsyncBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The `GdkDragActions` that this drop target supports.
    pub fn actions(self, actions: gdk::DragAction) -> Self {
        Self {
            builder: self.builder.property("actions", actions),
        }
    }

    /// The [`gdk::ContentFormats`][crate::gdk::ContentFormats] that determines the supported data formats.
    pub fn formats(self, formats: &gdk::ContentFormats) -> Self {
        Self {
            builder: self.builder.property("formats", formats.clone()),
        }
    }

    /// The name for this controller, typically used for debugging purposes.
    pub fn name(self, name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("name", name.into()),
        }
    }

    /// The limit for which events this controller will handle.
    pub fn propagation_limit(self, propagation_limit: PropagationLimit) -> Self {
        Self {
            builder: self
                .builder
                .property("propagation-limit", propagation_limit),
        }
    }

    /// The propagation phase at which this controller will handle events.
    pub fn propagation_phase(self, propagation_phase: PropagationPhase) -> Self {
        Self {
            builder: self
                .builder
                .property("propagation-phase", propagation_phase),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`DropTargetAsync`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> DropTargetAsync {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}