Tickit::Widget::Entry - a widget for entering text
Tickit::Widget::Entry
use Tickit; use Tickit::Widget::Entry; my $tickit = Tickit->new; my $entry = Tickit::Widget::Entry->new( on_enter => sub { my ( $self, $line ) = @_; # process $line somehow $self->set_text( "" ); }, ); $tickit->set_root_widget( $entry ); $tickit->run;
This class provides a widget which allows the user to enter a line of text.
The following keys are bound by default
Ctrl-K
Delete the entire line
Ctrl-U
Delete to the start of the line
Ctrl-W
Delete one word backwards
Backspace
Delete one character backwards
Delete
Delete one character forwards
Ctrl-Delete
Delete one word forwards
End or Ctrl-E
Move the cursor to the end of the input line
Enter
Accept a line of input by running the on_enter action
on_enter
Home or Ctrl-A
Move the cursor to the beginning of the input line
Insert
Toggle between overwrite and insert mode
Left
Move the cursor one character left
Ctrl-Left or Alt-B
Move the cursor one word left
Right
Move the cursor one character right
Ctrl-Right or Alt-F
Move the cursor one word right
Constructs a new Tickit::Widget::Entry object.
Return or set the CODE reference to be called when the key_enter_line action is invoked; usually bound to the Enter key.
key_enter_line
$on_enter->( $entry, $line )
Returns the current entry position, in terms of characters within the text.
Set the text entry position, moving the cursor
Associate methods or CODE references with keypresses. On receipt of a the key the method or CODE reference will be invoked, being passed the stringified key representation and the underlying Term::TermKey::Key structure.
Term::TermKey::Key
$ret = $entry->method( $keystr, $key ) $ret = $coderef->( $entry, $keystr, $key )
This method takes a hash of keystring/value pairs. Binding a value of undef will remove it.
undef
These methods operate on the text input buffer directly, updating the stored text and changing the rendered display to reflect the changes. They can be used by a program to directly manipulate the text.
Returns the currently entered text.
Replace the text in the entry box. This completely redraws the widget's window. It is largely provided for initialisation; for normal edits (such as from keybindings), it is preferrable to use text_insert, text_delete or text_splice.
text_insert
text_delete
text_splice
Insert the given text at the given character position.
Delete the given section of text. Returns the deleted text.
Replace the given section of text with the given replacement. Returns the text deleted from the section.
Search forward in the string, returning the character position of the next beginning of word from the initial position. If none is found, returns $else.
$else
Search forward in the string, returning the character position of the next end of word from the initial position. If none is found, returns the length of the string.
Search backward in the string, returning the character position of the previous beginning of word from the initial position. If none is found, returns 0.
Search backward in the string, returning the character position of the previous end of word from the initial position. If none is found, returns undef.
Plugin ability
Try to find a nice way to allow loaded plugins, possibly per-instance if not just globally or per-class. See how many of these TODO items can be done using plugins.
More readline behaviours
History. Isearch. History replay. Transpose. Transcase. Yank ring. Numeric prefixes.
Visual selection behaviour
Shift-movement, or vim-style. Mouse.
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.