Enum kas::event::Command[−][src]

pub enum Command {
Show 59 variants    Escape,
    Return,
    Tab,
    ViewUp,
    ViewDown,
    Left,
    Right,
    Up,
    Down,
    WordLeft,
    WordRight,
    Home,
    End,
    DocHome,
    DocEnd,
    PageUp,
    PageDown,
    Snapshot,
    ScrollLock,
    Pause,
    Insert,
    Delete,
    DelBack,
    DelWord,
    DelWordBack,
    Deselect,
    SelectAll,
    Find,
    FindReplace,
    FindNext,
    FindPrev,
    Bold,
    Italic,
    Underline,
    Link,
    Cut,
    Copy,
    Paste,
    Undo,
    Redo,
    New,
    Open,
    Save,
    Print,
    NavNext,
    NavPrev,
    NavParent,
    NavDown,
    TabNew,
    TabNext,
    TabPrev,
    Help,
    Rename,
    Refresh,
    Spelling,
    Menu,
    Fullscreen,
    Close,
    Exit,
}

Expand description

Command input (Event::Command)

The exact command sent depends on the type of focus a widget has.

Handling may depend on the state of the Shift key.

The exact mapping between the keyboard and these commands is OS-specific. In the future it should be customisable (see shortcuts module).

Variants

Escape

Escape key

Each press of this key should somehow relax control. It is expected that widgets receiving this key repeatedly eventually (soon) have no more use for this themselves and return it via Response::Unhandled.

This is in some cases remapped to Command::Deselect.

Return

Return / enter key

This may insert a line-break or may activate something.

This is only sent to widgets with char focus. In other cases a widget may receive Event::Activate.

Tab

Tab key

This key is used to insert (horizontal) tabulators as well as to navigate focus (in reverse when combined with Shift).

This is usually not sent to widgets but instead used for navigation.

ViewUp

Move view up without affecting selection

ViewDown

Move view down without affecting selection

Left

Move left

Right

Move right

Up

Move up

Down

Move down

WordLeft

Move left one word

WordRight

Move right one word

Home

Move to start (of the line)

End

Move to end (of the line)

DocHome

Move to start of the document

DocEnd

Move to end of the document

PageUp

Move up a page

PageDown

Move down a page

Snapshot

Capture a screenshot

ScrollLock

Lock output of screen

Pause

Pause key

Insert

Insert key

Delete

Delete forwards

DelBack

Delete backwards (Backspace key)

DelWord

Delete forwards one word

DelWordBack

Delete backwards one word

Deselect

Clear any selections

SelectAll

Select all contents

Find

Find (start)

FindReplace

Find and replace (start)

FindNext

Find next

FindPrev

Find previous

Bold

Make text bold

Italic

Make text italic

Underline

Underline text

Link

Insert a link

Cut

Copy to clipboard and clear

Copy

Copy to clipboard

Paste

Copy from clipboard

Undo

Undo the last action

Redo

Redo the last undone action

New

New document

Open

Open document

Save

Save document

Print

Print document

NavNext

Navigate forwards one page/item

NavPrev

Navigate backwards one page/item

NavParent

Navigate to the parent item

May be used to browse “up” to a parent directory.

NavDown

Navigate “down”

This is an opposite to NavParent, and will mostly not be used.

TabNew

Open a new tab

TabNext

Navigate to next tab

TabPrev

Navigate to previous tab

Help

Show help

Rename

Rename

Refresh

Refresh

Spelling

Spell-check tool

Menu

Open the menu / activate the menubar

Fullscreen

Make view fullscreen

Close

Close window/tab/popup

Exit

Exit program (e.g. Ctrl+Q)

Implementations

[src]

impl Command

[src]

pub fn new(vkey: VirtualKeyCode) -> Option<Command>

Try constructing from a VirtualKeyCode

[src]

pub fn suitable_for_sel_focus(self) -> bool

Convert to selection-focus command

Certain limited commands may be sent to widgets with selection focus but not character or navigation focus.

Trait Implementations

[src]

impl Clone for Command

[src]

pub fn clone(&self) -> Command

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for Command

[src]

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

Formats the value using the given formatter. Read more

[src]

impl<'de> Deserialize<'de> for Command

[src]

pub fn deserialize<D>(
deserializer: D
) -> Result<Command, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

[src]

impl Hash for Command

[src]

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

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

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

[src]

impl PartialEq<Command> for Command

[src]

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

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

1.0.0[src]

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

This method tests for !=.

[src]

impl Serialize for Command

[src]

pub fn serialize<S>(
 &self,
 serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
 S: Serializer,

Serialize this value into the given Serde serializer. Read more

[src]

impl StructuralPartialEq for Command

Auto Trait Implementations

impl RefUnwindSafe for Command

impl Send for Command

impl Sync for Command

impl Unpin for Command

impl UnwindSafe for Command

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash,

pub fn get_hash<H>(&self, hasher: H) -> u64 where
H: Hasher,

impl<S, T> Cast<T> for S where
T: Conv<S>,

pub fn cast(self) -> T

Cast from Self to T

pub fn try_cast(self) -> Result<T, Error>

Try converting from Self to T

impl<S, T> CastFloat<T> for S where
T: ConvFloat<S>,

pub fn cast_trunc(self) -> T

Cast to integer, truncating Read more

pub fn cast_nearest(self) -> T

Cast to the nearest integer Read more

pub fn cast_floor(self) -> T

Cast the floor to an integer Read more

pub fn cast_ceil(self) -> T

Cast the ceiling to an integer Read more

pub fn try_cast_trunc(self) -> Result<T, Error>

Try converting to integer with truncation Read more

pub fn try_cast_nearest(self) -> Result<T, Error>

Try converting to the nearest integer Read more

pub fn try_cast_floor(self) -> Result<T, Error>

Try converting the floor to an integer Read more

pub fn try_cast_ceil(self) -> Result<T, Error>

Try convert the ceiling to an integer Read more

impl<T> Conv<T> for T

pub fn conv(v: T) -> T

Convert from T to Self

pub fn try_conv(v: T) -> Result<T, Error>

Try converting from T to Self

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

[src]

impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,

[src]

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

[src]

impl<'a, T, X> Filter<&'a T> for X where
X: Filter<T>,
T: Clone,

[src]

pub fn matches(&self, item: &T) -> bool

Returns true if the given item matches this filter

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

[src]

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

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

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

recently added

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

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

impl<T> Upcast<T> for T

pub fn upcast(&self) -> Option<&T>

[src]

Enum kas::event::Command[−][src]

Variants

Implementations

impl Command

pub fn new(vkey: VirtualKeyCode) -> Option<Command>

pub fn suitable_for_sel_focus(self) -> bool

Trait Implementations

impl Clone for Command

pub fn clone(&self) -> Command

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

impl Debug for Command

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

impl<'de> Deserialize<'de> for Command

pub fn deserialize<__D>( __deserializer: __D) -> Result<Command, <__D as Deserializer<'de>>::Error> where __D: Deserializer<'de>,

impl Hash for Command

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

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

impl PartialEq<Command> for Command

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

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

impl Serialize for Command

pub fn serialize<__S>( &self, __serializer: __S) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where __S: Serializer,

impl Copy for Command

impl Eq for Command

impl StructuralEq for Command

impl StructuralPartialEq for Command

Auto Trait Implementations

impl RefUnwindSafe for Command

impl Send for Command

impl Sync for Command

impl Unpin for Command

impl UnwindSafe for Command

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> CallHasher for T where T: Hash,

pub fn get_hash<H>(&self, hasher: H) -> u64 where H: Hasher,

impl<S, T> Cast<T> for S where T: Conv<S>,

pub fn cast(self) -> T

pub fn try_cast(self) -> Result<T, Error>

impl<S, T> CastFloat<T> for S where T: ConvFloat<S>,

pub fn cast_trunc(self) -> T

pub fn cast_nearest(self) -> T

pub fn cast_floor(self) -> T

pub fn cast_ceil(self) -> T

pub fn try_cast_trunc(self) -> Result<T, Error>

pub fn try_cast_nearest(self) -> Result<T, Error>

pub fn try_cast_floor(self) -> Result<T, Error>

pub fn try_cast_ceil(self) -> Result<T, Error>

impl<T> Conv<T> for T

pub fn conv(v: T) -> T

pub fn try_conv(v: T) -> Result<T, Error>

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

impl<Q, K> Equivalent<K> for Q where K: Borrow<Q> + ?Sized, Q: Eq + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

impl<'a, T, X> Filter<&'a T> for X where X: Filter<T>, T: Clone,

pub fn matches(&self, item: &T) -> bool

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

pub fn deserialize<D>(
deserializer: D
) -> Result<Command, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

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

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

pub fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,

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

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

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

impl<T> CallHasher for T where
T: Hash,

pub fn get_hash<H>(&self, hasher: H) -> u64 where
H: Hasher,

impl<S, T> Cast<T> for S where
T: Conv<S>,

impl<S, T> CastFloat<T> for S where
T: ConvFloat<S>,

impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,

impl<'a, T, X> Filter<&'a T> for X where
X: Filter<T>,
T: Clone,

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

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

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

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,