Enum animate::TouchpadGesturePhase

#[non_exhaustive]
pub enum TouchpadGesturePhase {
    Begin,
    Update,
    End,
    Cancel,
    // some variants omitted
}

The phase of a touchpad gesture event. All gestures are guaranteed to begin with an event of type TouchpadGesturePhase::Begin, followed by a number of TouchpadGesturePhase::Update (possibly 0).

A finished gesture may have 2 possible outcomes, an event with phase TouchpadGesturePhase::End will be emitted when the gesture is considered successful, this should be used as the hint to perform any permanent changes.

Cancelled gestures may be so for a variety of reasons, due to hardware, or due to the gesture recognition layers hinting the gesture did not finish resolutely (eg. a 3rd finger being added during a pinch gesture). In these cases, the last event with report the phase TouchpadGesturePhase::Cancel, this should be used as a hint to undo any visible/permanent changes that were done throughout the progress of the gesture.

See also TouchpadPinchEvent and TouchpadPinchEvent.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Begin

The gesture has begun.

Update

The gesture has been updated.

End

The gesture was finished, changes should be permanently applied.

Cancel

The gesture was cancelled, all changes should be undone.

Trait Implementations

impl Clone for TouchpadGesturePhase

fn clone(&self) -> TouchpadGesturePhase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TouchpadGesturePhase

impl Debug for TouchpadGesturePhase

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

Formats the value using the given formatter.

impl Display for TouchpadGesturePhase

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

Formats the value using the given formatter.

impl Eq for TouchpadGesturePhase

impl<'a> FromValue<'a> for TouchpadGesturePhase

unsafe fn from_value(value: &Value) -> Self

Safety

impl<'a> FromValueOptional<'a> for TouchpadGesturePhase

unsafe fn from_value_optional(value: &Value) -> Option<Self>

Safety

impl Hash for TouchpadGesturePhase

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for TouchpadGesturePhase

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<TouchpadGesturePhase> for TouchpadGesturePhase

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

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

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

This method tests for !=.

impl PartialOrd<TouchpadGesturePhase> for TouchpadGesturePhase

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 SetValue for TouchpadGesturePhase

unsafe fn set_value(value: &mut Value, this: &Self)

Safety

impl StaticType for TouchpadGesturePhase

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for TouchpadGesturePhase

impl StructuralPartialEq for TouchpadGesturePhase