class Adw::SwipeTracker

Overview

A swipe tracker used in #Carousel, #NavigationView and #OverlaySplitView.

The Adw::SwipeTracker object can be used for implementing widgets with swipe gestures. It supports touch-based swipes, pointer dragging, and touchpad scrolling.

The widgets will probably want to expose the SwipeTracker::enabled property. If they expect to use horizontal orientation, SwipeTracker::reversed can be used for supporting RTL text direction.

Included Modules

Defined in:

lib/gi-crystal/src/auto/adw-1/swipe_tracker.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Gtk::Orientable

orientation : Gtk::Orientation orientation, orientation=(orientation : Gtk::Orientation) : Nil orientation=, to_unsafe to_unsafe

Constructor methods inherited from module Gtk::Orientable

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::Orientable

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new(swipeable : Adw::Swipeable) : self #

Creates a new Adw::SwipeTracker for widget.


def self.new #

Initialize a new SwipeTracker.


def self.new(*, allow_long_swipes : Bool | Nil = nil, allow_mouse_drag : Bool | Nil = nil, allow_window_handle : Bool | Nil = nil, enabled : Bool | Nil = nil, lower_overshoot : Bool | Nil = nil, orientation : Gtk::Orientation | Nil = nil, reversed : Bool | Nil = nil, swipeable : Adw::Swipeable | Nil = nil, upper_overshoot : Bool | Nil = nil) #

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def allow_long_swipes : Bool #

Gets whether to allow swiping for more than one snap point at a time.


def allow_long_swipes=(allow_long_swipes : Bool) : Nil #

Sets whether to allow swiping for more than one snap point at a time.

If the value is FALSE, each swipe can only move to the adjacent snap points.


def allow_long_swipes? : Bool #

def allow_mouse_drag : Bool #

Gets whether self can be dragged with mouse pointer.


def allow_mouse_drag=(allow_mouse_drag : Bool) : Nil #

Sets whether self can be dragged with mouse pointer.


def allow_mouse_drag? : Bool #

def allow_window_handle : Bool #

Gets whether to allow touchscreen swiping from Gtk::WindowHandle.


def allow_window_handle=(allow_window_handle : Bool) : Nil #

Sets whether to allow touchscreen swiping from Gtk::WindowHandle.

Setting it to TRUE will make dragging the window impossible.


def allow_window_handle? : Bool #

def begin_swipe_signal #

def enabled : Bool #

Gets whether self is enabled.


def enabled=(enabled : Bool) : Nil #

Sets whether self is enabled.

When it's not enabled, no events will be processed. Usually widgets will want to expose this via a property.


def enabled? : Bool #

def end_swipe_signal #

def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def lower_overshoot : Bool #

Gets whether to allow swiping past the first available snap point.


def lower_overshoot=(overshoot : Bool) : Nil #

Sets whether to allow swiping past the first available snap point.


def lower_overshoot? : Bool #

def prepare_signal #

def reversed : Bool #

Gets whether self is reversing the swipe direction.


def reversed=(reversed : Bool) : Nil #

Sets whether to reverse the swipe direction.

If the swipe tracker is horizontal, it can be used for supporting RTL text direction.


def reversed? : Bool #

def shift_position(delta : Float64) : Nil #

Moves the current progress value by delta.

This can be used to adjust the current position if snap points move during the gesture.


def swipeable : Adw::Swipeable #

Get the widget self is attached to.


def swipeable=(value : Adw::Swipeable | Nil) : Adw::Swipeable | Nil #

def update_swipe_signal #

def upper_overshoot : Bool #

Gets whether to allow swiping past the last available snap point.


def upper_overshoot=(overshoot : Bool) : Nil #

Sets whether to allow swiping past the last available snap point.


def upper_overshoot? : Bool #