Enum ncursesw::KeyBinding

source · [−]

pub enum KeyBinding {
Show 93 variants    Break,
    SoftReset,
    Reset,
    DownArrow,
    UpArrow,
    LeftArrow,
    RightArrow,
    Home,
    Backspace,
    FunctionKey(u8),
    DeleteLine,
    InsertLine,
    DeleteCharacter,
    InsertCharacter,
    InsertMode,
    Erase,
    ClearToEndOfScreen,
    ClearToEndOfLine,
    ScrollForward,
    ScrollBackward,
    NextPage,
    PreviousPage,
    SetTab,
    ClearTab,
    ClearAllTabs,
    Enter,
    Print,
    HomeDown,
    KeyPadUpperLeft,
    KeyPadUpperRight,
    KeyPadCenter,
    KeyPadLowerLeft,
    KeyPadLowerRight,
    BackTab,
    Begin,
    Cancel,
    Close,
    Command,
    Copy,
    Create,
    End,
    Exit,
    Find,
    Help,
    Mark,
    Message,
    Move,
    Next,
    Open,
    Options,
    Previous,
    Redo,
    Reference,
    Refresh,
    Replace,
    Restart,
    Resume,
    Save,
    ShiftBegin,
    ShiftCancel,
    ShiftCommand,
    ShiftCopy,
    ShiftCreate,
    ShiftDeleteCharacter,
    ShiftDeleteLine,
    Select,
    ShiftEnd,
    ShiftClearToEndOfLine,
    ShiftExit,
    ShiftFind,
    ShiftHelp,
    ShiftHome,
    ShiftInsertCharacter,
    ShiftLeftArrow,
    ShiftMessage,
    ShiftMove,
    ShiftNext,
    ShiftOptions,
    ShiftPrevious,
    ShiftPrint,
    ShiftRedo,
    ShiftReplace,
    ShiftRightArrow,
    ShiftResume,
    ShiftSave,
    ShiftSuspend,
    ShiftUndo,
    Suspend,
    Undo,
    MouseEvent,
    ResizeEvent,
    Event,
    UserDefined(i32),
}

Expand description

Keys returned by NCurses getch() and get_wch() families of functions.

Variants

`Break`

Break key (unreliable)

`SoftReset`

Soft (partial) reset (unreliable)

`Reset`

Reset or hard reset (unreliable)

`DownArrow`

down-arrow key

`UpArrow`

up-arrow key

`LeftArrow`

left-arrow key

`RightArrow`

right-arrow key

`Home`

home key

`Backspace`

backspace key

`FunctionKey(u8)`

Function keys. Space for 64

`DeleteLine`

delete-line key

`InsertLine`

insert-line key

`DeleteCharacter`

delete-character key

`InsertCharacter`

insert-character key

`InsertMode`

sent by rmir or smir in insert mode

`Erase`

clear-screen or erase key

`ClearToEndOfScreen`

clear-to-end-of-screen key

`ClearToEndOfLine`

clear-to-end-of-line key

`ScrollForward`

scroll-forward key

`ScrollBackward`

scroll-backward key

`NextPage`

next-page key

`PreviousPage`

previous-page key

`SetTab`

set-tab key

`ClearTab`

clear-tab key

`ClearAllTabs`

clear-all-tabs key

`Enter`

enter/send key

`Print`

print key

`HomeDown`

lower-left key (home down)

`KeyPadUpperLeft`

upper left of keypad

`KeyPadUpperRight`

upper right of keypad

`KeyPadCenter`

center of keypad

`KeyPadLowerLeft`

lower left of keypad

`KeyPadLowerRight`

lower right of keypad

`BackTab`

back-tab key

`Begin`

begin key

`Cancel`

cancel key

`Close`

close key

`Command`

command key

`Copy`

copy key

`Create`

create key

`End`

end key

`Exit`

exit key

`Find`

find key

`Help`

help key

`Mark`

mark key

`Message`

message key

`Move`

move key

`Next`

next key

`Open`

open key

`Options`

options key

`Previous`

previous key

`Redo`

redo key

`Reference`

reference key

`Refresh`

refresh key

`Replace`

replace key

`Restart`

restart key

`Resume`

resume key

`Save`

save key

`ShiftBegin`

shifted begin key

`ShiftCancel`

shifted cancel key

`ShiftCommand`

shifted command key

`ShiftCopy`

shifted copy key

`ShiftCreate`

shifted create key

`ShiftDeleteCharacter`

shifted delete-character key

`ShiftDeleteLine`

shifted delete-line key

`Select`

select key

`ShiftEnd`

shifted end key

`ShiftClearToEndOfLine`

shifted clear-to-end-of-line key

`ShiftExit`

shifted exit key

`ShiftFind`

shifted find key

`ShiftHelp`

shifted help key

`ShiftHome`

shifted home key

`ShiftInsertCharacter`

shifted insert-character key

`ShiftLeftArrow`

shifted left-arrow key

`ShiftMessage`

shifted message key

`ShiftMove`

shifted move key

`ShiftNext`

shifted next key

`ShiftOptions`

shifted options key

`ShiftPrevious`

shifted previous key

`ShiftPrint`

shifted print key

`ShiftRedo`

shifted redo key

`ShiftReplace`

shifted replace key

`ShiftRightArrow`

shifted right-arrow key

`ShiftResume`

shifted resume key

`ShiftSave`

shifted save key

`ShiftSuspend`

shifted suspend key

`ShiftUndo`

shifted undo key

`Suspend`

suspend key

`Undo`

undo key

`MouseEvent`

Mouse event has occurred

`ResizeEvent`

Terminal resize event

`Event`

👎 Deprecated since 0.6.3:

this was deprecated as of NCurses API v6.3.20211021

We were interrupted by an event

`UserDefined(i32)`

A user defined key.

Trait Implementations

source

impl Clone for KeyBinding

source

fn clone(&self) -> KeyBinding

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for KeyBinding

source

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

Formats the value using the given formatter. Read more

source

impl Display for KeyBinding

source

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

Formats the value using the given formatter. Read more

source

impl From<i32> for KeyBinding

source

fn from(key: i32) -> Self

Performs the conversion.

source

impl Hash for KeyBinding

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl Into<i32> for KeyBinding

source

fn into(self) -> i32

Performs the conversion.

source

impl PartialEq<KeyBinding> for KeyBinding

source

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

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

source

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

This method tests for !=.

source

impl TryFrom<u32> for KeyBinding

type Error = NCurseswError

The type returned in the event of a conversion error.

source

fn try_from(key: wint_t) -> Result<Self, Self::Error>

Performs the conversion.

source

impl StructuralPartialEq for KeyBinding

Auto Trait Implementations

impl RefUnwindSafe for KeyBinding

impl Send for KeyBinding

impl Sync for KeyBinding

impl Unpin for KeyBinding

impl UnwindSafe for KeyBinding

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.