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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
// 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::EventController;
use crate::PropagationLimit;
use crate::PropagationPhase;
use glib::object::Cast;
use glib::object::ObjectType as ObjectType_;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;

glib::wrapper! {
    /// [`EventControllerFocus`][crate::EventControllerFocus] is an event controller to keep track of
    /// keyboard focus.
    ///
    /// The event controller offers `signal::EventControllerFocus::enter`
    /// and `signal::EventControllerFocus::leave` signals, as well as
    /// `property::EventControllerFocus::is-focus` and
    /// `property::EventControllerFocus::contains-focus` properties
    /// which are updated to reflect focus changes inside the widget hierarchy
    /// that is rooted at the controllers widget.
    ///
    /// # Implements
    ///
    /// [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkEventControllerFocus")]
    pub struct EventControllerFocus(Object<ffi::GtkEventControllerFocus, ffi::GtkEventControllerFocusClass>) @extends EventController;

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

impl EventControllerFocus {
    /// Creates a new event controller that will handle focus events.
    ///
    /// # Returns
    ///
    /// a new [`EventControllerFocus`][crate::EventControllerFocus]
    #[doc(alias = "gtk_event_controller_focus_new")]
    pub fn new() -> EventControllerFocus {
        assert_initialized_main_thread!();
        unsafe {
            EventController::from_glib_full(ffi::gtk_event_controller_focus_new()).unsafe_cast()
        }
    }

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

    /// Returns [`true`] if focus is within @self or one of its children.
    ///
    /// # Returns
    ///
    /// [`true`] if focus is within @self or one of its children
    #[doc(alias = "gtk_event_controller_focus_contains_focus")]
    pub fn contains_focus(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_event_controller_focus_contains_focus(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns [`true`] if focus is within @self, but not one of its children.
    ///
    /// # Returns
    ///
    /// [`true`] if focus is within @self, but not one of its children
    #[doc(alias = "gtk_event_controller_focus_is_focus")]
    pub fn is_focus(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_event_controller_focus_is_focus(
                self.to_glib_none().0,
            ))
        }
    }

    /// Emitted whenever the focus enters into the widget or one
    /// of its descendents.
    ///
    /// Note that this means you may not get an ::enter signal
    /// even though the widget becomes the focus location, in
    /// certain cases (such as when the focus moves from a descendent
    /// of the widget to the widget itself). If you are interested
    /// in these cases, you can monitor the
    /// `property::EventControllerFocus::is-focus`
    /// property for changes.
    #[doc(alias = "enter")]
    pub fn connect_enter<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn enter_trampoline<F: Fn(&EventControllerFocus) + 'static>(
            this: *mut ffi::GtkEventControllerFocus,
            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"enter\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    enter_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted whenever the focus leaves the widget hierarchy
    /// that is rooted at the widget that the controller is attached to.
    ///
    /// Note that this means you may not get a ::leave signal
    /// even though the focus moves away from the widget, in
    /// certain cases (such as when the focus moves from the widget
    /// to a descendent). If you are interested in these cases, you
    /// can monitor the `property::EventControllerFocus::is-focus`
    /// property for changes.
    #[doc(alias = "leave")]
    pub fn connect_leave<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn leave_trampoline<F: Fn(&EventControllerFocus) + 'static>(
            this: *mut ffi::GtkEventControllerFocus,
            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"leave\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    leave_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "contains-focus")]
    pub fn connect_contains_focus_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_contains_focus_trampoline<
            F: Fn(&EventControllerFocus) + 'static,
        >(
            this: *mut ffi::GtkEventControllerFocus,
            _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::contains-focus\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_contains_focus_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-focus")]
    pub fn connect_is_focus_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_focus_trampoline<F: Fn(&EventControllerFocus) + 'static>(
            this: *mut ffi::GtkEventControllerFocus,
            _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::is-focus\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_is_focus_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for EventControllerFocus {
    fn default() -> Self {
        Self::new()
    }
}

#[derive(Clone, Default)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`EventControllerFocus`] 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 EventControllerFocusBuilder {
    name: Option<String>,
    propagation_limit: Option<PropagationLimit>,
    propagation_phase: Option<PropagationPhase>,
}

impl EventControllerFocusBuilder {
    // rustdoc-stripper-ignore-next
    /// Create a new [`EventControllerFocusBuilder`].
    pub fn new() -> Self {
        Self::default()
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`EventControllerFocus`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> EventControllerFocus {
        let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
        if let Some(ref name) = self.name {
            properties.push(("name", name));
        }
        if let Some(ref propagation_limit) = self.propagation_limit {
            properties.push(("propagation-limit", propagation_limit));
        }
        if let Some(ref propagation_phase) = self.propagation_phase {
            properties.push(("propagation-phase", propagation_phase));
        }
        glib::Object::new::<EventControllerFocus>(&properties)
            .expect("Failed to create an instance of EventControllerFocus")
    }

    /// The name for this controller, typically used for debugging purposes.
    pub fn name(mut self, name: &str) -> Self {
        self.name = Some(name.to_string());
        self
    }

    /// The limit for which events this controller will handle.
    pub fn propagation_limit(mut self, propagation_limit: PropagationLimit) -> Self {
        self.propagation_limit = Some(propagation_limit);
        self
    }

    /// The propagation phase at which this controller will handle events.
    pub fn propagation_phase(mut self, propagation_phase: PropagationPhase) -> Self {
        self.propagation_phase = Some(propagation_phase);
        self
    }
}

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