Enum TouchpadGesturePhase

#[non_exhaustive]
pub enum TouchpadGesturePhase {
    Begin,
    Update,
    End,
    Cancel,
}

Specifies the current state of a touchpad gesture.

All gestures are guaranteed to begin with an event with phase Begin, followed by 0 or several events with phase Update.

A finished gesture may have 2 possible outcomes, an event with phase 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 the compositor, 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 will report the phase Cancel, this should be used as a hint to undo any visible/permanent changes that were done throughout the progress of the gesture.

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.

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

Performs copy-assignment from source.

impl Debug for TouchpadGesturePhase

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

Formats the value using the given formatter.

impl From<TouchpadGesturePhase> for Value

fn from(v: TouchpadGesturePhase) -> Self

Converts to this type from the input type.

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

type Checker = GenericValueTypeChecker<TouchpadGesturePhase>

Value type checker.

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

Get the contained value from a Value.

impl HasParamSpec for TouchpadGesturePhase

type ParamSpec = ParamSpecEnum

type SetValue = TouchpadGesturePhase

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

type BuilderFn = fn(_: &str, _: TouchpadGesturePhase) -> ParamSpecEnumBuilder<'_, TouchpadGesturePhase>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TouchpadGesturePhase

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

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 TouchpadGesturePhase

fn cmp(&self, other: &TouchpadGesturePhase) -> 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,

Restrict a value to a certain interval.

impl PartialEq for TouchpadGesturePhase

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for TouchpadGesturePhase

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for TouchpadGesturePhase

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for TouchpadGesturePhase

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for TouchpadGesturePhase

type Type = TouchpadGesturePhase

Type to get the Type from.

impl Copy for TouchpadGesturePhase

impl Eq for TouchpadGesturePhase

impl StructuralPartialEq for TouchpadGesturePhase