Struct gtk4::GestureLongPress

#[repr(transparent)]
pub struct GestureLongPress { /* private fields */ }

GestureLongPress is a Gesture for long presses.

This gesture is also known as “Press and Hold”.

When the timeout is exceeded, the gesture is triggering the pressed signal.

If the touchpoint is lifted before the timeout passes, or if it drifts too far of the initial press point, the cancelled signal will be emitted.

How long the timeout is before the ::pressed signal gets emitted is determined by the gtk-long-press-time setting. It can be modified by the delay-factor property.

Properties

delay-factor

Factor by which to modify the default timeout.

Readable | Writeable

GestureSingle

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

Gesture

n-points

The number of touch points that trigger recognition on this gesture.

Readable | Writeable | Construct Only

EventController

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

Signals

cancelled

Emitted whenever a press moved too far, or was released before pressed happened.

pressed

Emitted whenever a press goes unmoved/unreleased longer than what the GTK defaults tell.

Gesture

begin

Emitted when the gesture is recognized.

This means the number of touch sequences matches 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() is called on @gesture (manually, due to grabs…), or the individual @sequence was claimed by parent widgets’ controllers (see 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.

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). This situation may be detected by checking through GestureExt::handles_sequence().

sequence-state-changed

Emitted whenever a sequence state changes.

See 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.

Implements

GestureSingleExt, GestureExt, EventControllerExt, glib::ObjectExt

Implementations

impl GestureLongPress

pub fn new() -> GestureLongPress

Returns a newly created Gesture that recognizes long presses.

Returns

a newly created GestureLongPress.

pub fn builder() -> GestureLongPressBuilder

Creates a new builder-pattern struct instance to construct GestureLongPress objects.

This method returns an instance of GestureLongPressBuilder which can be used to create GestureLongPress objects.

pub fn delay_factor(&self) -> f64

Returns the delay factor.

Returns

the delay factor

pub fn set_delay_factor(&self, delay_factor: f64)

Applies the given delay factor.

The default long press time will be multiplied by this value. Valid values are in the range [0.5..2.0].

delay_factor

The delay factor to apply

pub fn connect_cancelled<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted whenever a press moved too far, or was released before pressed happened.

pub fn connect_pressed<F: Fn(&Self, f64, f64) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted whenever a press goes unmoved/unreleased longer than what the GTK defaults tell.

x

the X coordinate where the press happened, relative to the widget allocation

y

the Y coordinate where the press happened, relative to the widget allocation

pub fn connect_delay_factor_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for GestureLongPress

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GestureLongPress

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GestureLongPress

fn default() -> Self

Returns the “default value” for a type.

impl Display for GestureLongPress

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for GestureLongPress

type ParamSpec = ParamSpecObject

type SetValue = GestureLongPress

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, GestureLongPress>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GestureLongPress

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GestureLongPress

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for GestureLongPress

type Parent = GestureSingle

impl<OT: ObjectType> PartialEq<OT> for GestureLongPress

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for GestureLongPress

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for GestureLongPress

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GestureLongPress

impl IsA<EventController> for GestureLongPress

impl IsA<Gesture> for GestureLongPress

impl IsA<GestureSingle> for GestureLongPress