Enum gstreamer_video::NavigationEventType

#[non_exhaustive]
pub enum NavigationEventType {
    Invalid,
    KeyPress,
    KeyRelease,
    MouseButtonPress,
    MouseButtonRelease,
    MouseMove,
    Command,
    MouseScroll,
    TouchDown,
    TouchMotion,
    TouchUp,
    TouchFrame,
    TouchCancel,
    MouseDoubleClick,
}

Enum values for the various events that an element implementing the GstNavigation interface might send up the pipeline. Touch events have been inspired by the libinput API, and have the same meaning here.

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.

Invalid

Returned from [Navigation::event_get_type()][crate::Navigation::event_get_type()] when the passed event is not a navigation event.

KeyPress

A key press event. Use [Navigation::event_parse_key_event()][crate::Navigation::event_parse_key_event()] to extract the details from the event.

KeyRelease

A key release event. Use [Navigation::event_parse_key_event()][crate::Navigation::event_parse_key_event()] to extract the details from the event.

MouseButtonPress

A mouse button press event. Use [Navigation::event_parse_mouse_button_event()][crate::Navigation::event_parse_mouse_button_event()] to extract the details from the event.

MouseButtonRelease

A mouse button release event. Use [Navigation::event_parse_mouse_button_event()][crate::Navigation::event_parse_mouse_button_event()] to extract the details from the event.

MouseMove

A mouse movement event. Use [Navigation::event_parse_mouse_move_event()][crate::Navigation::event_parse_mouse_move_event()] to extract the details from the event.

Command

A navigation command event. Use [Navigation::event_parse_command()][crate::Navigation::event_parse_command()] to extract the details from the event.

MouseScroll

A mouse scroll event. Use [Navigation::event_parse_mouse_scroll_event()][crate::Navigation::event_parse_mouse_scroll_event()] to extract the details from the event.

TouchDown

An event describing a new touch point, which will be assigned an identifier that is unique to it for the duration of its movement on the screen. Use [Navigation::event_parse_touch_event()][crate::Navigation::event_parse_touch_event()] to extract the details from the event.

TouchMotion

An event describing the movement of an active touch point across the screen. Use [Navigation::event_parse_touch_event()][crate::Navigation::event_parse_touch_event()] to extract the details from the event.

TouchUp

An event describing a removed touch point. After this event, its identifier may be reused for any new touch points. Use [Navigation::event_parse_touch_up_event()][crate::Navigation::event_parse_touch_up_event()] to extract the details from the event.

TouchFrame

An event signaling the end of a sequence of simultaneous touch events.

TouchCancel

An event cancelling all currently active touch points.

MouseDoubleClick

A mouse button double click event. Use [Navigation::event_parse_mouse_button_event()][crate::Navigation::event_parse_mouse_button_event()] to extract the details from the event.

Trait Implementations

impl Clone for NavigationEventType

fn clone(&self) -> NavigationEventType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NavigationEventType

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

Formats the value using the given formatter.

impl From<NavigationEventType> for Value

fn from(v: NavigationEventType) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for NavigationEventType

type Checker = GenericValueTypeChecker<NavigationEventType>

Value type checker.

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

Get the contained value from a Value.

impl HasParamSpec for NavigationEventType

type ParamSpec = ParamSpecEnum

type SetValue = NavigationEventType

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for NavigationEventType

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 NavigationEventType

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for NavigationEventType

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 NavigationEventType

type Type = NavigationEventType

Type to get the Type from.

impl Copy for NavigationEventType

impl Eq for NavigationEventType

impl StructuralPartialEq for NavigationEventType