Struct gtk4::GestureClick

pub struct GestureClick { /* private fields */ }

GestureClick is a Gesture implementation for clicks.

It is able to recognize multiple clicks on a nearby zone, which can be listened for through the pressed signal. Whenever time or distance between clicks exceed the GTK defaults, stopped is emitted, and the click counter is reset.

Signals

pressed

Emitted whenever a button or touch press happens.

released

Emitted when a button or touch is released.

@n_press will report the number of press that is paired to this event, note that stopped may have been emitted between the press and its release, @n_press will only start over at the next press.

stopped

Emitted whenever any time/distance threshold has been exceeded.

unpaired-release

Emitted whenever the gesture receives a release event that had no previous corresponding press.

Due to implicit grabs, this can only happen on situations where input is grabbed elsewhere mid-press or the pressed widget voluntarily relinquishes its implicit grab.

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, [trait@glib::ObjectExt]

Implementations

impl GestureClick

pub fn new() -> GestureClick

Returns a newly created Gesture that recognizes single and multiple presses.

Returns

a newly created GestureClick

pub fn builder() -> GestureClickBuilder

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

This method returns an instance of GestureClickBuilder which can be used to create GestureClick objects.

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

Emitted whenever a button or touch press happens.

n_press

how many touch/button presses happened with this one

x

The X coordinate, in widget allocation coordinates

y

The Y coordinate, in widget allocation coordinates

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

Emitted when a button or touch is released.

@n_press will report the number of press that is paired to this event, note that stopped may have been emitted between the press and its release, @n_press will only start over at the next press.

n_press

number of press that is paired with this release

x

The X coordinate, in widget allocation coordinates

y

The Y coordinate, in widget allocation coordinates

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

Emitted whenever any time/distance threshold has been exceeded.

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

Emitted whenever the gesture receives a release event that had no previous corresponding press.

Due to implicit grabs, this can only happen on situations where input is grabbed elsewhere mid-press or the pressed widget voluntarily relinquishes its implicit grab.

x

X coordinate of the event

y

Y coordinate of the event

button

Button being released

sequence

Sequence being released

Trait Implementations

impl Clone for GestureClick

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 GestureClick

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

Formats the value using the given formatter.

impl Default for GestureClick

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for GestureClick

type ParamSpec = ParamSpecObject

type SetValue = GestureClick

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GestureClick

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 GestureClick

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for GestureClick

type Parent = GestureSingle

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

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 GestureClick

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 GestureClick

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GestureClick

impl IsA<EventController> for GestureClick

impl IsA<Gesture> for GestureClick

impl IsA<GestureSingle> for GestureClick