.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Tickit::Console 3pm" .TH Tickit::Console 3pm "2024-01-01" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" "Tickit::Console" \- build full\-screen console\-style applications .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $console = Tickit::Console\->new; \& \& Tickit\->new( root => $console )\->run; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" A \f(CW\*(C`Tickit::Console\*(C'\fR instance is a subclass of Tickit::Widget::VBox intended to help building a full-screen console-style application which presents the user with one or more scrollable text areas, selectable as tabs on a ribbon, with a text entry area at the bottom of the screen for entering commands or other data. As a Tickit::Widget subclass it can be added anywhere within a widget tree, though normally it would be used as the root widget for a Tickit instance. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" .Vb 1 \& $console = Tickit::Console\->new( %args ); .Ve .PP Returns a new instance of a \f(CW\*(C`Tickit::Console\*(C'\fR. Takes the following named arguments: .IP "on_line => \s-1CODE\s0" 8 .IX Item "on_line => CODE" Callback to invoke when a line of text is entered in the entry widget. .Sp .Vb 1 \& $on_line\->( $active_tab, $text ); .Ve .IP "tab_class => \s-1STRING\s0" 8 .IX Item "tab_class => STRING" Optional. If set, gives a class name (which should be a subclass of Tickit::Console::Tab) to construct newly-added tabs with. This setting allows an application to provide new methods in tabs to change behaviours. .IP "timestamp_format, datestamp_format" 8 .IX Item "timestamp_format, datestamp_format" Optional. If supplied, these will be stored as default values to pass to the tab constructor in the \f(CW\*(C`add_tab\*(C'\fR method. .SH "METHODS" .IX Header "METHODS" .SS "add_tab" .IX Subsection "add_tab" .Vb 1 \& $tab = $console\->add_tab( %args ); .Ve .PP Adds a new tab to the console, and returns a Tickit::Console::Tab object representing it. .PP Takes the following named arguments: .IP "name => \s-1STRING\s0" 8 .IX Item "name => STRING" Name for the tab. .IP "on_line => \s-1CODE\s0" 8 .IX Item "on_line => CODE" Optional. Provides a different callback to invoke when a line of text is entered while this tab is active. Invoked the same way as above. .IP "make_widget => \s-1CODE\s0" 8 .IX Item "make_widget => CODE" Optional. Gives a piece of code used to construct the actual Tickit::Widget used as this tab's child in the ribbon. A \f(CW\*(C`Tickit::Widget::Scroller\*(C'\fR to hold the tab's content will be passed in to this code, which should construct some sort of widget tree with that inside it, and return it. This can be used to apply a decorative frame, place the scroller in a split box or other layout along with other widgets, or various other effects. .Sp .Vb 1 \& $tab_widget = $make_widget\->( $scroller ); .Ve .PP Any other named arguments are passed to the tab's constructor. .SS "active_tab_index" .IX Subsection "active_tab_index" .Vb 1 \& $index = $console\->active_tab_index; .Ve .SS "active_tab" .IX Subsection "active_tab" .Vb 1 \& $tab = $console\->active_tab; .Ve .SS "remove_tab" .IX Subsection "remove_tab" .Vb 1 \& $console\->remove_tab( $tab_or_index ); .Ve .SS "move_tab" .IX Subsection "move_tab" .Vb 1 \& $console\->move_tab( $tab_or_index, $delta ); .Ve .SS "activate_tab" .IX Subsection "activate_tab" .Vb 1 \& $console\->activate_tab( $tab_or_index ); .Ve .SS "next_tab" .IX Subsection "next_tab" .Vb 1 \& $console\->next_tab; .Ve .SS "prev_tab" .IX Subsection "prev_tab" .Vb 1 \& $console\->prev_tab; .Ve .PP These methods are all passed through to the underlying Tickit::Widget::Tabbed object. .SS "bind_key" .IX Subsection "bind_key" .Vb 1 \& $console\->bind_key( $key, $code ); .Ve .PP 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 .PP .Vb 1 \& $code\->( $console, $key ); .Ve .PP If \f(CW$code\fR is missing or \f(CW\*(C`undef\*(C'\fR, any existing callback is removed. .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans