1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

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

use crate::ContentFormats;
use crate::Device;
use crate::Display;
use crate::Drag;
use crate::DragAction;
use crate::Surface;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;

glib::wrapper! {
    /// The [`Drop`][crate::Drop] object represents the target of an ongoing DND operation.
    ///
    /// Possible drop sites get informed about the status of the ongoing drag
    /// operation with events of type [`EventType::DragEnter`][crate::EventType::DragEnter], [`EventType::DragLeave`][crate::EventType::DragLeave],
    /// [`EventType::DragMotion`][crate::EventType::DragMotion] and [`EventType::DropStart`][crate::EventType::DropStart]. The [`Drop`][crate::Drop] object can be obtained
    /// from these [`Event`][crate::Event] types using [``DNDEvent::drop()``][crate::`DNDEvent::drop()`].
    ///
    /// The actual data transfer is initiated from the target side via an async
    /// read, using one of the [`Drop`][crate::Drop] methods for this purpose:
    /// [``read_async()``][`Self::read_async()`] or [``read_value_async()``][`Self::read_value_async()`].
    ///
    /// 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.
    #[doc(alias = "GdkDrop")]
    pub struct Drop(Object<ffi::GdkDrop>);

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

impl Drop {
    /// Ends the drag operation after a drop.
    ///
    /// The `action` must be a single action selected from the actions
    /// available via [``actions()``][`Self::actions()`].
    /// ## `action`
    /// the action performed by the destination or 0 if the drop failed
    #[doc(alias = "gdk_drop_finish")]
    pub fn finish(&self, action: DragAction) {
        unsafe {
            ffi::gdk_drop_finish(self.to_glib_none().0, action.into_glib());
        }
    }

    /// Returns the possible actions for this [`Drop`][crate::Drop].
    ///
    /// If this value contains multiple actions - i.e.
    /// [``DragAction::is_unique()``][crate::`DragAction::is_unique()`] returns [`false`] for the result -
    /// [``finish()``][`Self::finish()`] must choose the action to use when
    /// accepting the drop. This will only happen if you passed
    /// [`DragAction::ASK`][crate::DragAction::ASK] as one of the possible actions in
    /// [``status()``][`Self::status()`]. [`DragAction::ASK`][crate::DragAction::ASK] itself will not
    /// be included in the actions returned by this function.
    ///
    /// This value may change over the lifetime of the [`Drop`][crate::Drop]
    /// both as a response to source side actions as well as to calls to
    /// [``status()``][`Self::status()`] or [``finish()``][`Self::finish()`]. The source
    /// side will not change this value anymore once a drop has started.
    ///
    /// # Returns
    ///
    /// The possible `GdkDragActions`
    #[doc(alias = "gdk_drop_get_actions")]
    #[doc(alias = "get_actions")]
    pub fn actions(&self) -> DragAction {
        unsafe { from_glib(ffi::gdk_drop_get_actions(self.to_glib_none().0)) }
    }

    /// Returns the [`Device`][crate::Device] performing the drop.
    ///
    /// # Returns
    ///
    /// The [`Device`][crate::Device] performing the drop.
    #[doc(alias = "gdk_drop_get_device")]
    #[doc(alias = "get_device")]
    pub fn device(&self) -> Option<Device> {
        unsafe { from_glib_none(ffi::gdk_drop_get_device(self.to_glib_none().0)) }
    }

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

    /// If this is an in-app drag-and-drop operation, returns the [`Drag`][crate::Drag]
    /// that corresponds to this drop.
    ///
    /// If it is not, [`None`] is returned.
    ///
    /// # Returns
    ///
    /// the corresponding [`Drag`][crate::Drag]
    #[doc(alias = "gdk_drop_get_drag")]
    #[doc(alias = "get_drag")]
    pub fn drag(&self) -> Option<Drag> {
        unsafe { from_glib_none(ffi::gdk_drop_get_drag(self.to_glib_none().0)) }
    }

    /// Returns the [`ContentFormats`][crate::ContentFormats] that the drop offers the data
    /// to be read in.
    ///
    /// # Returns
    ///
    /// The possible [`ContentFormats`][crate::ContentFormats]
    #[doc(alias = "gdk_drop_get_formats")]
    #[doc(alias = "get_formats")]
    pub fn formats(&self) -> Option<ContentFormats> {
        unsafe { from_glib_none(ffi::gdk_drop_get_formats(self.to_glib_none().0)) }
    }

    /// Returns the [`Surface`][crate::Surface] performing the drop.
    ///
    /// # Returns
    ///
    /// The [`Surface`][crate::Surface] performing the drop.
    #[doc(alias = "gdk_drop_get_surface")]
    #[doc(alias = "get_surface")]
    pub fn surface(&self) -> Option<Surface> {
        unsafe { from_glib_none(ffi::gdk_drop_get_surface(self.to_glib_none().0)) }
    }

    /// Selects all actions that are potentially supported by the destination.
    ///
    /// When calling this function, do not restrict the passed in actions to
    /// the ones provided by [``actions()``][`Self::actions()`]. Those actions may
    /// change in the future, even depending on the actions you provide here.
    ///
    /// The `preferred` action is a hint to the drag-and-drop mechanism about which
    /// action to use when multiple actions are possible.
    ///
    /// This function should be called by drag destinations in response to
    /// [`EventType::DragEnter`][crate::EventType::DragEnter] or [`EventType::DragMotion`][crate::EventType::DragMotion] events. If the destination does
    /// not yet know the exact actions it supports, it should set any possible
    /// actions first and then later call this function again.
    /// ## `actions`
    /// Supported actions of the destination, or 0 to indicate
    ///  that a drop will not be accepted
    /// ## `preferred`
    /// A unique action that's a member of `actions` indicating the
    ///  preferred action
    #[doc(alias = "gdk_drop_status")]
    pub fn status(&self, actions: DragAction, preferred: DragAction) {
        unsafe {
            ffi::gdk_drop_status(
                self.to_glib_none().0,
                actions.into_glib(),
                preferred.into_glib(),
            );
        }
    }

    #[doc(alias = "display")]
    pub fn connect_display_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_display_trampoline<F: Fn(&Drop) + 'static>(
            this: *mut ffi::GdkDrop,
            _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 _,
                b"notify::display\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_display_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl fmt::Display for Drop {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("Drop")
    }
}