gdk4/auto/
drag_surface.rs

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
// 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, Surface};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// A [`DragSurface`][crate::DragSurface] is an interface for surfaces used during DND.
    ///
    /// ## Signals
    ///
    ///
    /// #### `compute-size`
    ///  Emitted when the size for the surface needs to be computed, when it is
    /// present.
    ///
    /// This signal will normally be emitted during the native surface layout
    /// cycle when the surface size needs to be recomputed.
    ///
    /// It is the responsibility of the drag surface user to handle this signal
    /// and compute the desired size of the surface, storing the computed size
    /// in the [`DragSurfaceSize`][crate::DragSurfaceSize] object that is passed to the signal
    /// handler, using [`DragSurfaceSize::set_size()`][crate::DragSurfaceSize::set_size()].
    ///
    /// Failing to set a size so will result in an arbitrary size being used as
    /// a result.
    ///
    ///
    /// <details><summary><h4>Surface</h4></summary>
    ///
    ///
    /// #### `enter-monitor`
    ///  Emitted when @surface starts being present on the monitor.
    ///
    ///
    ///
    ///
    /// #### `event`
    ///  Emitted when GDK receives an input event for @surface.
    ///
    ///
    ///
    ///
    /// #### `layout`
    ///  Emitted when the size of @surface is changed, or when relayout should
    /// be performed.
    ///
    /// Surface size is reported in ”application pixels”, not
    /// ”device pixels” (see gdk_surface_get_scale_factor()).
    ///
    ///
    ///
    ///
    /// #### `leave-monitor`
    ///  Emitted when @surface stops being present on the monitor.
    ///
    ///
    ///
    ///
    /// #### `render`
    ///  Emitted when part of the surface needs to be redrawn.
    ///
    ///
    /// </details>
    ///
    /// # Implements
    ///
    /// [`DragSurfaceExt`][trait@crate::prelude::DragSurfaceExt], [`SurfaceExt`][trait@crate::prelude::SurfaceExt], [`DragSurfaceExtManual`][trait@crate::prelude::DragSurfaceExtManual], [`SurfaceExtManual`][trait@crate::prelude::SurfaceExtManual]
    #[doc(alias = "GdkDragSurface")]
    pub struct DragSurface(Interface<ffi::GdkDragSurface, ffi::GdkDragSurfaceInterface>) @requires Surface;

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

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

/// Trait containing all [`struct@DragSurface`] methods.
///
/// # Implementors
///
/// [`DragSurface`][struct@crate::DragSurface]
pub trait DragSurfaceExt: IsA<DragSurface> + 'static {
    /// Present @self.
    /// ## `width`
    /// the unconstrained drag_surface width to layout
    /// ## `height`
    /// the unconstrained drag_surface height to layout
    ///
    /// # Returns
    ///
    /// [`false`] if it failed to be presented, otherwise [`true`].
    #[doc(alias = "gdk_drag_surface_present")]
    fn present(&self, width: i32, height: i32) -> bool {
        unsafe {
            from_glib(ffi::gdk_drag_surface_present(
                self.as_ref().to_glib_none().0,
                width,
                height,
            ))
        }
    }
}

impl<O: IsA<DragSurface>> DragSurfaceExt for O {}