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 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
// 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::{EventController, EventControllerScrollFlags, PropagationLimit, PropagationPhase};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// [`EventControllerScroll`][crate::EventControllerScroll] is an event controller that handles scroll
/// events.
///
/// It is capable of handling both discrete and continuous scroll
/// events from mice or touchpads, abstracting them both with the
/// [`scroll`][struct@crate::EventControllerScroll#scroll] signal. Deltas in
/// the discrete case are multiples of 1.
///
/// In the case of continuous scroll events, [`EventControllerScroll`][crate::EventControllerScroll]
/// encloses all [`scroll`][struct@crate::EventControllerScroll#scroll] emissions
/// between two [`scroll-begin`][struct@crate::EventControllerScroll#scroll-begin] and
/// [`scroll-end`][struct@crate::EventControllerScroll#scroll-end] signals.
///
/// The behavior of the event controller can be modified by the flags
/// given at creation time, or modified at a later point through
/// [`set_flags()`][Self::set_flags()] (e.g. because the scrolling
/// conditions of the widget changed).
///
/// The controller can be set up to emit motion for either/both vertical
/// and horizontal scroll events through [`EventControllerScrollFlags::VERTICAL`][crate::EventControllerScrollFlags::VERTICAL],
/// [`EventControllerScrollFlags::HORIZONTAL`][crate::EventControllerScrollFlags::HORIZONTAL] and [`EventControllerScrollFlags::BOTH_AXES`][crate::EventControllerScrollFlags::BOTH_AXES].
/// If any axis is disabled, the respective [`scroll`][struct@crate::EventControllerScroll#scroll]
/// delta will be 0. Vertical scroll events will be translated to horizontal
/// motion for the devices incapable of horizontal scrolling.
///
/// The event controller can also be forced to emit discrete events on all
/// devices through [`EventControllerScrollFlags::DISCRETE`][crate::EventControllerScrollFlags::DISCRETE]. This can be used
/// to implement discrete actions triggered through scroll events (e.g.
/// switching across combobox options).
///
/// The [`EventControllerScrollFlags::KINETIC`][crate::EventControllerScrollFlags::KINETIC] flag toggles the emission of the
/// [`decelerate`][struct@crate::EventControllerScroll#decelerate] signal, emitted at the end
/// of scrolling with two X/Y velocity arguments that are consistent with the
/// motion that was received.
///
/// ## Properties
///
///
/// #### `flags`
/// The flags affecting event controller behavior.
///
/// 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
///
///
/// #### `decelerate`
/// Emitted after scroll is finished if the
/// [`EventControllerScrollFlags::KINETIC`][crate::EventControllerScrollFlags::KINETIC] flag is set.
///
/// @vel_x and @vel_y express the initial velocity that was
/// imprinted by the scroll events. @vel_x and @vel_y are expressed in
/// pixels/ms.
///
///
///
///
/// #### `scroll`
/// Signals that the widget should scroll by the
/// amount specified by @dx and @dy.
///
/// For the representation unit of the deltas, see
/// [`EventControllerScroll::unit()`][crate::EventControllerScroll::unit()].
///
///
///
///
/// #### `scroll-begin`
/// Signals that a new scrolling operation has begun.
///
/// It will only be emitted on devices capable of it.
///
///
///
///
/// #### `scroll-end`
/// Signals that a scrolling operation has finished.
///
/// It will only be emitted on devices capable of it.
///
///
///
/// # Implements
///
/// [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`]
#[doc(alias = "GtkEventControllerScroll")]
pub struct EventControllerScroll(Object<ffi::GtkEventControllerScroll, ffi::GtkEventControllerScrollClass>) @extends EventController;
match fn {
type_ => || ffi::gtk_event_controller_scroll_get_type(),
}
}
impl EventControllerScroll {
/// Creates a new event controller that will handle scroll events.
/// ## `flags`
/// flags affecting the controller behavior
///
/// # Returns
///
/// a new [`EventControllerScroll`][crate::EventControllerScroll]
#[doc(alias = "gtk_event_controller_scroll_new")]
pub fn new(flags: EventControllerScrollFlags) -> EventControllerScroll {
assert_initialized_main_thread!();
unsafe {
EventController::from_glib_full(ffi::gtk_event_controller_scroll_new(flags.into_glib()))
.unsafe_cast()
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`EventControllerScroll`] objects.
///
/// This method returns an instance of [`EventControllerScrollBuilder`](crate::builders::EventControllerScrollBuilder) which can be used to create [`EventControllerScroll`] objects.
pub fn builder() -> EventControllerScrollBuilder {
EventControllerScrollBuilder::new()
}
/// Gets the flags conditioning the scroll controller behavior.
///
/// # Returns
///
/// the controller flags.
#[doc(alias = "gtk_event_controller_scroll_get_flags")]
#[doc(alias = "get_flags")]
pub fn flags(&self) -> EventControllerScrollFlags {
unsafe {
from_glib(ffi::gtk_event_controller_scroll_get_flags(
self.to_glib_none().0,
))
}
}
/// Gets the scroll unit of the last
/// [`scroll`][struct@crate::EventControllerScroll#scroll] signal received.
///
/// Always returns [`gdk::ScrollUnit::Wheel`][crate::gdk::ScrollUnit::Wheel] if the
/// [`EventControllerScrollFlags::DISCRETE`][crate::EventControllerScrollFlags::DISCRETE] flag is set.
///
/// # Returns
///
/// the scroll unit.
#[cfg(any(feature = "v4_8", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_8")))]
#[doc(alias = "gtk_event_controller_scroll_get_unit")]
#[doc(alias = "get_unit")]
pub fn unit(&self) -> gdk::ScrollUnit {
unsafe {
from_glib(ffi::gtk_event_controller_scroll_get_unit(
self.to_glib_none().0,
))
}
}
/// Sets the flags conditioning scroll controller behavior.
/// ## `flags`
/// flags affecting the controller behavior
#[doc(alias = "gtk_event_controller_scroll_set_flags")]
pub fn set_flags(&self, flags: EventControllerScrollFlags) {
unsafe {
ffi::gtk_event_controller_scroll_set_flags(self.to_glib_none().0, flags.into_glib());
}
}
/// Emitted after scroll is finished if the
/// [`EventControllerScrollFlags::KINETIC`][crate::EventControllerScrollFlags::KINETIC] flag is set.
///
/// @vel_x and @vel_y express the initial velocity that was
/// imprinted by the scroll events. @vel_x and @vel_y are expressed in
/// pixels/ms.
/// ## `vel_x`
/// X velocity
/// ## `vel_y`
/// Y velocity
#[doc(alias = "decelerate")]
pub fn connect_decelerate<F: Fn(&Self, f64, f64) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn decelerate_trampoline<
F: Fn(&EventControllerScroll, f64, f64) + 'static,
>(
this: *mut ffi::GtkEventControllerScroll,
vel_x: libc::c_double,
vel_y: libc::c_double,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this), vel_x, vel_y)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"decelerate\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
decelerate_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Signals that the widget should scroll by the
/// amount specified by @dx and @dy.
///
/// For the representation unit of the deltas, see
/// [`unit()`][Self::unit()].
/// ## `dx`
/// X delta
/// ## `dy`
/// Y delta
///
/// # Returns
///
/// [`true`] if the scroll event was handled,
/// [`false`] otherwise.
#[doc(alias = "scroll")]
pub fn connect_scroll<F: Fn(&Self, f64, f64) -> glib::signal::Inhibit + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn scroll_trampoline<
F: Fn(&EventControllerScroll, f64, f64) -> glib::signal::Inhibit + 'static,
>(
this: *mut ffi::GtkEventControllerScroll,
dx: libc::c_double,
dy: libc::c_double,
f: glib::ffi::gpointer,
) -> glib::ffi::gboolean {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this), dx, dy).into_glib()
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"scroll\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
scroll_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Signals that a new scrolling operation has begun.
///
/// It will only be emitted on devices capable of it.
#[doc(alias = "scroll-begin")]
pub fn connect_scroll_begin<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn scroll_begin_trampoline<F: Fn(&EventControllerScroll) + 'static>(
this: *mut ffi::GtkEventControllerScroll,
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"scroll-begin\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
scroll_begin_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Signals that a scrolling operation has finished.
///
/// It will only be emitted on devices capable of it.
#[doc(alias = "scroll-end")]
pub fn connect_scroll_end<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn scroll_end_trampoline<F: Fn(&EventControllerScroll) + 'static>(
this: *mut ffi::GtkEventControllerScroll,
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"scroll-end\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
scroll_end_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "flags")]
pub fn connect_flags_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_flags_trampoline<F: Fn(&EventControllerScroll) + 'static>(
this: *mut ffi::GtkEventControllerScroll,
_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::flags\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_flags_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for EventControllerScroll {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`EventControllerScroll`] 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 EventControllerScrollBuilder {
builder: glib::object::ObjectBuilder<'static, EventControllerScroll>,
}
impl EventControllerScrollBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The flags affecting event controller behavior.
pub fn flags(self, flags: EventControllerScrollFlags) -> Self {
Self {
builder: self.builder.property("flags", flags),
}
}
/// 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 [`EventControllerScroll`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> EventControllerScroll {
self.builder.build()
}
}
impl fmt::Display for EventControllerScroll {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("EventControllerScroll")
}
}