Enum KeyBinding

pub enum KeyBinding {
    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),
}

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

impl Clone for KeyBinding

fn clone(&self) -> KeyBinding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyBinding

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

Formats the value using the given formatter.

impl Display for KeyBinding

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

Formats the value using the given formatter.

impl From<i32> for KeyBinding

fn from(key: i32) -> Self

Converts to this type from the input type.

impl Hash for KeyBinding

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<i32> for KeyBinding

fn into(self) -> i32

Converts this type into the (usually inferred) input type.

impl PartialEq for KeyBinding

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<u32> for KeyBinding

type Error = NCurseswError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for KeyBinding

impl Eq for KeyBinding

impl StructuralPartialEq for KeyBinding