Struct EventBuilder 

pub struct EventBuilder { /* private fields */ }

Builder for constructing a sequence of input Events.

Chain calls to key, click, scroll_up, etc., then call build to get the final Vec<Event>.

Example

use slt::EventBuilder;
use slt::KeyCode;

let events = EventBuilder::new()
    .key('a')
    .key_code(KeyCode::Enter)
    .build();
assert_eq!(events.len(), 2);

Implementations

impl EventBuilder

pub fn new() -> Self

Create an empty event builder.

pub fn key(self, c: char) -> Self

Append a character key-press event.

pub fn key_code(self, code: KeyCode) -> Self

Append a special key-press event (arrows, Enter, Esc, etc.).

pub fn key_with(self, code: KeyCode, modifiers: KeyModifiers) -> Self

Append a key-press event with modifier keys (Ctrl, Shift, Alt).

pub fn key_modifier(self, m: ModifierKey) -> Self

Append a modifier-only key-press event (a bare Ctrl/Shift/Alt/Super press with no accompanying character).

Mirrors what the Kitty keyboard protocol delivers when RunConfig::report_all_keys(true) is enabled, so widget tests can simulate modifier-only presses without poking crossterm. The event carries KeyCode::Modifier with KeyModifiers::NONE.

Since 0.21.0.

Example

use slt::{EventBuilder, KeyCode, ModifierKey};

let events = EventBuilder::new()
    .key_modifier(ModifierKey::LeftCtrl)
    .build();
assert_eq!(events.len(), 1);

pub fn click(self, x: u32, y: u32) -> Self

Append a left mouse click at terminal position (x, y).

pub fn click_with(self, x: u32, y: u32, modifiers: KeyModifiers) -> Self

Append a left-button press at (x, y) carrying the given modifiers.

Use this to simulate Shift+click (e.g. range extension in the calendar widget). The plain click helper always sends KeyModifiers::NONE.

pub fn mouse_up(self, x: u32, y: u32) -> Self

Append a left mouse button release at terminal position (x, y).

pub fn drag(self, x: u32, y: u32) -> Self

Append a mouse drag (movement with the left button held) at (x, y).

pub fn key_release(self, c: char) -> Self

Append a key-release event for character c.

Only meaningful on terminals that emit release events (e.g. with the Kitty keyboard protocol enabled).

pub fn focus_gained(self) -> Self

Append a terminal focus-gained event.

pub fn focus_lost(self) -> Self

Append a terminal focus-lost event.

pub fn scroll_up(self, x: u32, y: u32) -> Self

Append a scroll-up event at (x, y).

pub fn scroll_down(self, x: u32, y: u32) -> Self

Append a scroll-down event at (x, y).

pub fn paste(self, text: impl Into<String>) -> Self

Append a bracketed-paste event.

pub fn resize(self, width: u32, height: u32) -> Self

Append a terminal resize event.

pub fn build(self) -> Vec<Event>

Consume the builder and return the event sequence.

Trait Implementations

impl Default for EventBuilder

fn default() -> Self

Returns the “default value” for a type.