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
// 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, Gesture, GestureDrag, GestureSingle, Orientation, PanDirection,
PropagationLimit, PropagationPhase,
};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// [`GesturePan`][crate::GesturePan] is a [`Gesture`][crate::Gesture] for pan gestures.
///
/// These are drags that are locked to happen along one axis. The axis
/// that a [`GesturePan`][crate::GesturePan] handles is defined at construct time, and
/// can be changed through [`set_orientation()`][Self::set_orientation()].
///
/// When the gesture starts to be recognized, [`GesturePan`][crate::GesturePan] will
/// attempt to determine as early as possible whether the sequence
/// is moving in the expected direction, and denying the sequence if
/// this does not happen.
///
/// Once a panning gesture along the expected axis is recognized,
/// the [`pan`][struct@crate::GesturePan#pan] signal will be emitted as input
/// events are received, containing the offset in the given axis.
///
/// ## Properties
///
///
/// #### `orientation`
/// The expected orientation of pan gestures.
///
/// Readable | Writeable
/// <details><summary><h4>GestureSingle</h4></summary>
///
///
/// #### `button`
/// Mouse button number to listen to, or 0 to listen for any button.
///
/// Readable | Writeable
///
///
/// #### `exclusive`
/// Whether the gesture is exclusive.
///
/// Exclusive gestures only listen to pointer and pointer emulated events.
///
/// Readable | Writeable
///
///
/// #### `touch-only`
/// Whether the gesture handles only touch events.
///
/// Readable | Writeable
/// </details>
/// <details><summary><h4>Gesture</h4></summary>
///
///
/// #### `n-points`
/// The number of touch points that trigger
/// recognition on this gesture.
///
/// Readable | Writeable | Construct Only
/// </details>
/// <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
///
///
/// #### `pan`
/// Emitted once a panning gesture along the expected axis is detected.
///
///
/// <details><summary><h4>GestureDrag</h4></summary>
///
///
/// #### `drag-begin`
/// Emitted whenever dragging starts.
///
///
///
///
/// #### `drag-end`
/// Emitted whenever the dragging is finished.
///
///
///
///
/// #### `drag-update`
/// Emitted whenever the dragging point moves.
///
///
/// </details>
/// <details><summary><h4>Gesture</h4></summary>
///
///
/// #### `begin`
/// Emitted when the gesture is recognized.
///
/// This means the number of touch sequences matches
/// [`n-points`][struct@crate::Gesture#n-points].
///
/// Note: These conditions may also happen when an extra touch
/// (eg. a third touch on a 2-touches gesture) is lifted, in that
/// situation @sequence won't pertain to the current set of active
/// touches, so don't rely on this being true.
///
///
///
///
/// #### `cancel`
/// Emitted whenever a sequence is cancelled.
///
/// This usually happens on active touches when
/// [`EventControllerExt::reset()`][crate::prelude::EventControllerExt::reset()] is called on @gesture
/// (manually, due to grabs...), or the individual @sequence
/// was claimed by parent widgets' controllers (see
/// [`GestureExt::set_sequence_state()`][crate::prelude::GestureExt::set_sequence_state()]).
///
/// @gesture must forget everything about @sequence as in
/// response to this signal.
///
///
///
///
/// #### `end`
/// Emitted when @gesture either stopped recognizing the event
/// sequences as something to be handled, or the number of touch
/// sequences became higher or lower than [`n-points`][struct@crate::Gesture#n-points].
///
/// Note: @sequence might not pertain to the group of sequences that
/// were previously triggering recognition on @gesture (ie. a just
/// pressed touch sequence that exceeds [`n-points`][struct@crate::Gesture#n-points]).
/// This situation may be detected by checking through
/// [`GestureExt::handles_sequence()`][crate::prelude::GestureExt::handles_sequence()].
///
///
///
///
/// #### `sequence-state-changed`
/// Emitted whenever a sequence state changes.
///
/// See [`GestureExt::set_sequence_state()`][crate::prelude::GestureExt::set_sequence_state()] to know
/// more about the expectable sequence lifetimes.
///
///
///
///
/// #### `update`
/// Emitted whenever an event is handled while the gesture is recognized.
///
/// @sequence is guaranteed to pertain to the set of active touches.
///
///
/// </details>
///
/// # Implements
///
/// [`GestureDragExt`][trait@crate::prelude::GestureDragExt], [`GestureSingleExt`][trait@crate::prelude::GestureSingleExt], [`GestureExt`][trait@crate::prelude::GestureExt], [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`]
#[doc(alias = "GtkGesturePan")]
pub struct GesturePan(Object<ffi::GtkGesturePan, ffi::GtkGesturePanClass>) @extends GestureDrag, GestureSingle, Gesture, EventController;
match fn {
type_ => || ffi::gtk_gesture_pan_get_type(),
}
}
impl GesturePan {
/// Returns a newly created [`Gesture`][crate::Gesture] that recognizes pan gestures.
/// ## `orientation`
/// expected orientation
///
/// # Returns
///
/// a newly created [`GesturePan`][crate::GesturePan]
#[doc(alias = "gtk_gesture_pan_new")]
pub fn new(orientation: Orientation) -> GesturePan {
assert_initialized_main_thread!();
unsafe {
Gesture::from_glib_full(ffi::gtk_gesture_pan_new(orientation.into_glib())).unsafe_cast()
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`GesturePan`] objects.
///
/// This method returns an instance of [`GesturePanBuilder`](crate::builders::GesturePanBuilder) which can be used to create [`GesturePan`] objects.
pub fn builder() -> GesturePanBuilder {
GesturePanBuilder::new()
}
/// Returns the orientation of the pan gestures that this @self expects.
///
/// # Returns
///
/// the expected orientation for pan gestures
#[doc(alias = "gtk_gesture_pan_get_orientation")]
#[doc(alias = "get_orientation")]
pub fn orientation(&self) -> Orientation {
unsafe { from_glib(ffi::gtk_gesture_pan_get_orientation(self.to_glib_none().0)) }
}
/// Sets the orientation to be expected on pan gestures.
/// ## `orientation`
/// expected orientation
#[doc(alias = "gtk_gesture_pan_set_orientation")]
pub fn set_orientation(&self, orientation: Orientation) {
unsafe {
ffi::gtk_gesture_pan_set_orientation(self.to_glib_none().0, orientation.into_glib());
}
}
/// Emitted once a panning gesture along the expected axis is detected.
/// ## `direction`
/// current direction of the pan gesture
/// ## `offset`
/// Offset along the gesture orientation
#[doc(alias = "pan")]
pub fn connect_pan<F: Fn(&Self, PanDirection, f64) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn pan_trampoline<F: Fn(&GesturePan, PanDirection, f64) + 'static>(
this: *mut ffi::GtkGesturePan,
direction: ffi::GtkPanDirection,
offset: libc::c_double,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this), from_glib(direction), offset)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"pan\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
pan_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "orientation")]
pub fn connect_orientation_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_orientation_trampoline<F: Fn(&GesturePan) + 'static>(
this: *mut ffi::GtkGesturePan,
_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::orientation\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_orientation_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for GesturePan {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`GesturePan`] 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 GesturePanBuilder {
builder: glib::object::ObjectBuilder<'static, GesturePan>,
}
impl GesturePanBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The expected orientation of pan gestures.
pub fn orientation(self, orientation: Orientation) -> Self {
Self {
builder: self.builder.property("orientation", orientation),
}
}
/// Mouse button number to listen to, or 0 to listen for any button.
pub fn button(self, button: u32) -> Self {
Self {
builder: self.builder.property("button", button),
}
}
/// Whether the gesture is exclusive.
///
/// Exclusive gestures only listen to pointer and pointer emulated events.
pub fn exclusive(self, exclusive: bool) -> Self {
Self {
builder: self.builder.property("exclusive", exclusive),
}
}
/// Whether the gesture handles only touch events.
pub fn touch_only(self, touch_only: bool) -> Self {
Self {
builder: self.builder.property("touch-only", touch_only),
}
}
/// The number of touch points that trigger
/// recognition on this gesture.
pub fn n_points(self, n_points: u32) -> Self {
Self {
builder: self.builder.property("n-points", n_points),
}
}
/// 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 [`GesturePan`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> GesturePan {
self.builder.build()
}
}
impl fmt::Display for GesturePan {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("GesturePan")
}
}