Trait tfc::MouseContext[−][src]

pub trait MouseContext {
    fn mouse_move_rel(&mut self, dx: i32, dy: i32) -> Result<(), Error>;
    fn mouse_move_abs(&mut self, x: i32, y: i32) -> Result<(), Error>;
    fn mouse_scroll(&mut self, dx: i32, dy: i32) -> Result<(), Error>;
    fn mouse_down(&mut self, button: MouseButton) -> Result<(), Error>;
    fn mouse_up(&mut self, button: MouseButton) -> Result<(), Error>;

    fn mouse_click(&mut self, button: MouseButton) -> Result<(), Error> { ... }
}

A context that supports mouse events.

Implementors of this trait are able to emit mouse events. The mouse can be moved or scrolled. The mouse buttons can also be pressed.

Platform Differences

On Linux, smooth scrolling isn't supported so mouse_scroll will accumulate up to 120 (a magic number that seems to pop up in various places) before issuing a scroll event.

Required methods

`fn mouse_move_rel(&mut self, dx: i32, dy: i32) -> Result<(), Error>`[src]

Move the mouse relative to its current location.

Arguments

dx - The horizontal offset. Positive values move to the right and negative values move to the left.
dy - The vertical offset. Positive values move down and negative values move up.

`fn mouse_move_abs(&mut self, x: i32, y: i32) -> Result<(), Error>`[src]

Move the mouse to an absolute location.

Arguments

x - The horizontal position. A zero value is the left side of the screen.
y - The vertical position. A zero value is the top of the screen.

`fn mouse_scroll(&mut self, dx: i32, dy: i32) -> Result<(), Error>`[src]

Scroll the mouse horizontally and vertically in pixels.

Arguments

dx - The horizontal offset. Positive values scroll to the right and negative values scroll to the left.
dy - The vertical offset. Positive values scroll down and negative values scroll up.