diff options
Diffstat (limited to 'Spec.md')
| -rw-r--r-- | Spec.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -0,0 +1,15 @@ +This is an attempt to specify some of the parts of the library so that it’s easier to spot bugs and regressions. + +The specification is expected to grow incrementally, as the developers update various parts of the code. If you hack on a part of the library that would benefit from a precise specification and is not documented here yet, please consider adding to the specification. + +Please stay high-level when writing the spec, do not document particular classes or other implementation details. The spec should be usable as a testing scenario – you should be able to walk through the spec and verify correct code behaviour on the library demo app. + +# Recording Shortcuts + +* If a shortcut has no modifiers and is not a function key (F1–F20), it must be rejected. (Examples: `A`, Shift-A.) +* If the shortcut is plain Esc without modifiers, it must be rejected and cancels the recording. +* If the shortcut is plain Backspace or plain Delete, it must be rejected, clears the recorded shortcut and cancels the recording. +* If the shortcut is Cmd-W or Cmd-Q, the recording must be cancelled and the keypress passed through to the system, closing the window or quitting the app. +* If a shortcut is already taken by system and is enabled, it must be rejected. (Examples: Cmd-S, Cmd-N. TBD: What exactly does it mean that the shortcut is “enabled”?) +* TBD: Option-key handling. +* All other shortcuts must be accepted. (Examples: Ctrl-Esc, Cmd-Delete, F16.)
\ No newline at end of file |