pub struct MouseEvent {
pub kind: MouseEventKind,
pub x: u16,
pub y: u16,
pub modifiers: Modifiers,
pub pixel: Option<(u32, u32)>,
}Expand description
A mouse event.
Fields§
§kind: MouseEventKindThe type of mouse event.
x: u16X coordinate (0-indexed, leftmost column is 0).
y: u16Y coordinate (0-indexed, topmost row is 0).
modifiers: ModifiersModifier keys held during the event.
pixel: Option<(u32, u32)>Optional sub-cell pixel coordinates ((px, py)) when reported via
SGR-Pixels (?1016h) mode.
Implementations§
Source§impl MouseEvent
impl MouseEvent
Sourcepub const fn new(kind: MouseEventKind, x: u16, y: u16) -> Self
pub const fn new(kind: MouseEventKind, x: u16, y: u16) -> Self
Create a new mouse event.
Sourcepub const fn with_modifiers(self, modifiers: Modifiers) -> Self
pub const fn with_modifiers(self, modifiers: Modifiers) -> Self
Create a mouse event with modifiers.
Sourcepub const fn with_pixel(self, px: u32, py: u32) -> Self
pub const fn with_pixel(self, px: u32, py: u32) -> Self
Attach pixel coordinates (px, py) reported via SGR-Pixels (?1016h) mode.
Trait Implementations§
Source§impl Clone for MouseEvent
impl Clone for MouseEvent
impl Copy for MouseEvent
Source§impl Debug for MouseEvent
impl Debug for MouseEvent
impl Eq for MouseEvent
Source§impl PartialEq for MouseEvent
impl PartialEq for MouseEvent
impl StructuralPartialEq for MouseEvent
Auto Trait Implementations§
impl Forget for MouseEvent
impl Freeze for MouseEvent
impl Move for MouseEvent
impl RefUnwindSafe for MouseEvent
impl Send for MouseEvent
impl Sync for MouseEvent
impl Unpin for MouseEvent
impl UnsafeUnpin for MouseEvent
impl UnwindSafe for MouseEvent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more