Skip to main content

Module keys

Module keys 

Source
Expand description

The keys of what every front end offers besides the operations — the command palette, the key list, committing and cancelling a step, undoing, framing the view — named once, here, so that the web app and VS Code press the same keys for the same things (see docs/ux.md). An operation’s key is its own (crate::editable::OperationInfo::shortcut).

A key is written as the front ends read it: modifiers before the key, joined by + — Mod is Ctrl, or ⌘ on a Mac — Mod+K, Shift+F, ?. Plain keys belong to the step being edited (its tools), so the view’s plain keys (F, Home, O) work only while no step is; the key list’s (?) and those with Mod always. Escape is the step’s while one is edited: it ends what is in progress in it first, and with nothing in progress cancels it — or, for a sketch, keeps it, as OK does (see crate::editor::Editor::handle).

Structs§

AppKey
Something every front end offers, and its key.

Constants§

APP_KEYS
The app’s keys (see the module docs).

Functions§

is_app_key
Whether key is a plain key of the app’s: one no operation may take.
key_of
The key of action, if it has one.