Struct libnotcurses_sys::c_api::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: ncinput__bindgen_ty_1,
    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.

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: ncinput__bindgen_ty_1

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 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.

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

Performs the conversion.

impl From<&'_ ncinput> for NcReceived

fn from(i: &NcInput) -> Self

Performs the conversion.

impl From<ncinput> for NcReceived

fn from(i: NcInput) -> Self

Performs the conversion.

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 Ord for ncinput

fn cmp(&self, other: &ncinput) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ncinput> for ncinput

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

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

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

This method tests for !=.

impl PartialOrd<ncinput> for ncinput

fn partial_cmp(&self, other: &ncinput) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ncinput

impl Eq for ncinput

impl StructuralEq for ncinput

impl StructuralPartialEq for ncinput