Tickit - Terminal Interface Construction KIT
Tickit
use Tickit; use Tickit::Widget::Box; use Tickit::Widget::Static; my $tickit = Tickit->new; my $box = Tickit::Widget::Box->new( h_border => 4, v_border => 2, bg => "green", child => Tickit::Widget::Static->new( text => "Hello, world!", bg => "black", align => "centre", valign => "middle", ), ); $tickit->set_root_widget( $box ); $tickit->run;
Tickit is a high-level toolkit for creating full-screen terminal-based interactive programs. It allows programs to be written in an abstracted way, working with a tree of widget objects, to represent the layout of the interface and implement its behaviours.
Its supported terminal features includes a rich set of rendering attributes (bold, underline, italic, 256-colours, etc), support for mouse including wheel and position events above the 224th column and arbitrary modified key input via libtermkey (all of these will require a supporting terminal as well). It also supports having multiple instances and non-blocking or asynchronous control.
At the current version, this is a Perl distribution which contains some XS utility code, and depends on a number of other XS modules to provide the remaining terminal behaviours. Work is in progress at porting the lower level parts into a standalone C library, with the intention being that eventually this distribution will become an XS wrapper for that C library. Development releases may appear on CPAN that include the C library and XS wrappings of it.
Constructs a new Tickit framework container object.
Takes the following named arguments at construction time:
IO handle for terminal input. Will default to STDIN.
STDIN
IO handle for terminal output. Will default to STDOUT.
STDOUT
If defined, overrides locale detection to enable or disable UTF-8 mode. If not defined then this will be detected from the locale by using Perl's ${^UTF8LOCALE} variable.
${^UTF8LOCALE}
Runs the given CODE reference at some time soon in the future. It will not be invoked yet, but will be invoked at some point before the next round of input events are processed.
Returns the underlying Tickit::Term object.
Query the current size of the terminal. Will be cached and updated on receipt of SIGWINCH signals.
SIGWINCH
Installs a callback to invoke if the given key is pressed, overwriting any previous callback for the same key. The code block is invoked as
$code->( $tickit, $key )
If $code is missing or undef, any existing callback is removed.
$code
undef
As a convenience for the common application use case, the Ctrl-C key is bound to the _STOP method.
Ctrl-C
_STOP
To remove this binding, simply bind another callback, or remove the binding entirely by setting undef.
Returns the root Tickit::Window.
Sets the root widget for the application's display. This must be a subclass of Tickit::Widget.
Set up the screen and generally prepare to start running
Shut down the screen after running
Run a single round of IO events. Does not call setup_term or teardown_term.
setup_term
teardown_term
Calls the setup_term method, then processes IO events until stopped, by the _STOP method, SIGINT, SIGTERM or the Ctrl-C key. Then runs the teardown_term method, and returns.
SIGINT
SIGTERM
Paul Evans <leonerd@leonerd.org.uk>
To install Tickit, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tickit
CPAN shell
perl -MCPAN -e shell install Tickit
For more information on module installation, please visit the detailed CPAN module installation guide.