Type Definition libnotcurses_sys::NcInput

pub type NcInput = ncinput;

Reads and decodes input events.

Reads from stdin and decodes the input to stdout, including synthesized events and mouse events. Notcurses provides input from keyboards and mice. Single Unicode codepoints are received from the keyboard, directly encoded as u32.

All events carry an NcInput structure with them.

For mouse events, the x and y coordinates are reported within this struct. For all events, modifiers (e.g. “Alt”) are carried as bools in this struct.

Implementations

impl NcInput

Constructors

pub const fn new_empty() -> NcInput

New empty NcInput.

pub const fn new(id: char) -> NcInput

New NcInput.

pub const fn with_alt(id: char) -> NcInput

New NcInput with alt key.

pub const fn with_shift(id: char) -> NcInput

New NcInput with shift key.

pub const fn with_ctrl(id: char) -> NcInput

New NcInput with ctrl key.

pub const fn with_all_args(
    id: char,
    x: Option<NcDim>,
    y: Option<NcDim>,
    alt: bool,
    shift: bool,
    ctrl: bool,
    evtype: NcEvType
) -> NcInput

New NcInput, expecting all the arguments (except utf8).

impl NcInput

Methods

pub fn char(&self) -> Option<char>

Returns the char from the utf8 representation of the input.