Trait gstreamer_video::prelude::NavigationExt

source · 
pub trait NavigationExt:
    IsA<Navigation>
    + Sealed
    + 'static {
    // Provided methods
    fn send_command(&self, command: NavigationCommand) { ... }
    fn send_event(&self, structure: Structure) { ... }
    fn send_event_simple(&self, event: Event) { ... }
    fn send_key_event(&self, event: &str, key: &str) { ... }
    fn send_mouse_event(&self, event: &str, button: i32, x: f64, y: f64) { ... }
    fn send_mouse_scroll_event(
        &self,
        x: f64,
        y: f64,
        delta_x: f64,
        delta_y: f64,
    ) { ... }
}
Expand description

Trait containing all Navigation methods.

§Implementors

Navigation

Provided Methods§

source

fn send_command(&self, command: NavigationCommand)

Sends the indicated command to the navigation interface.

§command

The command to issue

source

fn send_event(&self, structure: Structure)

source

fn send_event_simple(&self, event: Event)

Sends an event to the navigation interface.

§event

The event to send

source

fn send_key_event(&self, event: &str, key: &str)

§event

The type of the key event. Recognised values are “key-press” and “key-release”

§key

Character representation of the key. This is typically as produced by XKeysymToString.

source

fn send_mouse_event(&self, event: &str, button: i32, x: f64, y: f64)

Sends a mouse event to the navigation interface. Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element implementing the Navigation interface.

§event

The type of mouse event, as a text string. Recognised values are “mouse-button-press”, “mouse-button-release”, “mouse-move” and “mouse-double-click”.

§button

The button number of the button being pressed or released. Pass 0 for mouse-move events.

§x

The x coordinate of the mouse event.

§y

The y coordinate of the mouse event.

source

fn send_mouse_scroll_event(&self, x: f64, y: f64, delta_x: f64, delta_y: f64)

Sends a mouse scroll event to the navigation interface. Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element implementing the Navigation interface.

§x

The x coordinate of the mouse event.

§y

The y coordinate of the mouse event.

§delta_x

The delta_x coordinate of the mouse event.

§delta_y

The delta_y coordinate of the mouse event.

Object Safety§

This trait is not object safe.

Implementors§