Struct libnotcurses_sys::c_api::ffi::ncinput

#[repr(C)]
pub struct ncinput {
    pub id: u32,
    pub y: c_int,
    pub x: c_int,
    pub utf8: [c_char; 5],
    pub alt: bool,
    pub shift: bool,
    pub ctrl: bool,
    pub evtype: ncintype_e,
    pub modifiers: c_uint,
    pub ypx: c_int,
    pub xpx: c_int,
}

An input event. Cell coordinates are currently defined only for mouse events. It is not guaranteed that we can set the modifiers for a given ncinput. We encompass single Unicode codepoints, not complete EGCs. FIXME for abi4, combine the bools into |modifiers|

Fields

id: u32

Unicode codepoint or synthesized NCKEY event

y: c_int

y/x cell coordinate of event, -1 for undefined

x: c_int

y/x cell coordinate of event, -1 for undefined

utf8: [c_char; 5]

utf8 representation, if one exists

alt: bool

was alt held?

shift: bool

was shift held?

ctrl: bool

was ctrl held?

evtype: ncintype_e

END DEPRECATION

modifiers: c_uint

bitmask over NCKEY_MOD_*

ypx: c_int

pixel offsets within cell, -1 for undefined

xpx: c_int

pixel offsets within cell, -1 for undefined

Implementations

impl ncinput

Constructors

pub fn new_empty() -> NcInput

New empty NcInput.

pub fn new(id: char) -> NcInput

New NcInput.

pub fn with_alt(id: char) -> NcInput

New NcInput with alt key.

pub fn with_shift(id: char) -> NcInput

New NcInput with shift key.

pub fn with_ctrl(id: char) -> NcInput

New NcInput with ctrl key.

pub fn with_all_args(
    id: char,
    x: Option<u32>,
    y: Option<u32>,
    modifiers: NcKeyMod,
    evtype: NcInputType
) -> 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.

pub fn nomod_p(&self) -> bool

Returns true if there are no modifiers present.

C style function: ncinput_nomod_p().

pub fn shift_p(&self) -> bool

Returns true if the Shift modifier is present.

C style function: ncinput_shift_p().

pub fn alt_p(&self) -> bool

Returns true if the Alt modifier is present.

C style function: ncinput_alt_p().

pub fn ctrl_p(&self) -> bool

Returns true if the Ctrl modifier is present.

C style function: ncinput_ctrl_p().

pub fn meta_p(&self) -> bool

Returns true if the Meta modifier is present.

C style function: ncinput_meta_p().

pub fn super_p(&self) -> bool

Returns true if the Super modifier is present.

C style function: ncinput_super_p().

pub fn hyper_p(&self) -> bool

Returns true if the Hyper modifier is present.

C style function: ncinput_hyper_p().

pub fn capslock_p(&self) -> bool

Returns true if the CapsLock modifier is present.

C style function: ncinput_capslock_p().

pub fn numlock_p(&self) -> bool

Returns true if the NumLock modifier is present.

C style function: ncinput_numlock_p().

pub fn equal_p(&self, other: &NcInput) -> bool

Returns true if both NcInputs are equal.

C style function: ncinput_equal_p().

Trait Implementations

impl Clone for ncinput

fn clone(&self) -> ncinput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ncinput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ncinput

fn default() -> Self

Returns the “default value” for a type.

impl From<&mut ncinput> for NcReceived

fn from(i: &mut NcInput) -> Self

Converts to this type from the input type.

impl From<&ncinput> for NcReceived

fn from(i: &NcInput) -> Self

Converts to this type from the input type.

impl From<ncinput> for NcReceived

fn from(i: NcInput) -> Self

Converts to this type from the input type.

impl Hash for ncinput

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<ncinput> for NcInput

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for ncinput