File: README

package info (click to toggle)
libtickit-app-plugin-escapeprefix-perl 0.02-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 116 kB
  • sloc: perl: 157; makefile: 2
file content (54 lines) | stat: -r--r--r-- 1,521 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
NAME

    Tickit::App::Plugin::EscapePrefix - Tickit application plugin for
    Escape-prefixed shortcut keys

SYNOPSIS

       use Tickit;
       use Tickit::App::Plugin::EscapePrefix;
    
       my $tickit = Tickit->new;
    
       Tickit::App::Plugin::EscapePrefix->apply( $tickit );
    
       ...
    
       $tickit->run;

DESCRIPTION

    This package applies code to a Tickit instance to let it handle <Escape
    >-prefixed shortcut keys, by converting them into the equivalent
    <M-...> modified keys instead.

    Once applied using the "apply" method, the plugin will consume any
    plain <Escape> keys typed at the terminal. If another key arrives soon
    afterwards, this key will be consumed and instead a new keypress event
    emitted that adds the "meta" modifier to it. For example, typing
    <Escape> <a> will instead emit the modified key <M-a> to the
    application. If no subsequent key arrives after a timeout of 3 seconds
    then the modification will not apply.

    While the plugin is still pending anothey keypress to modify, a small
    indicator window will appear in the bottom left of the display, showing
    ESC- in a reverse-video style, to remind the user the keypress is
    pending.

METHODS

 apply

       Tickit::App::Plugin::EscapePrefix->apply( $tickit )

    Applies the plugin code to the given toplevel Tickit instance.

TODO

      Much configuration - timeout; style, text and position of indicator
      window

AUTHOR

    Paul Evans <leonerd@leonerd.org.uk>