.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Term::ReadLine::Zoid::Base 3pm"
.TH Term::ReadLine::Zoid::Base 3pm "2022-06-17" "perl v5.34.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"
Term::ReadLine::Zoid::Base \- atomic routines
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module contains some atomic operations used by all
Term::ReadLine::Zoid objects. It is intended as a base class.
.PP
At the very least, to child class needs to define a \f(CW\*(C`default()\*(C'\fR function
to handle key bindings and a \f(CW\*(C`draw()\*(C'\fR function
which in turn calls \f(CW\*(C`print()\*(C'\fR. Also the attributes \f(CW\*(C`IN\*(C'\fR and \f(CW\*(C`OUT\*(C'\fR
should contain valid filehandles.
.SH "METHODS"
.IX Header "METHODS"
.SS "\s-1ANSI\s0 stuff"
.IX Subsection "ANSI stuff"
.ie n .IP """cursor_at($x, $y)""" 4
.el .IP "\f(CWcursor_at($x, $y)\fR" 4
.IX Item "cursor_at($x, $y)"
Positions the cursor on screen, dimensions are 1\-based.
.ie n .IP """clear_screen()""" 4
.el .IP "\f(CWclear_screen()\fR" 4
.IX Item "clear_screen()"
Clear screen.
.ie n .IP """title($string)""" 4
.el .IP "\f(CWtitle($string)\fR" 4
.IX Item "title($string)"
Set terminal title to \f(CW$string\fR. When using for example \fBxterm\fR\|(1)
this is the window name.
.ie n .IP """print_length($string)""" 4
.el .IP "\f(CWprint_length($string)\fR" 4
.IX Item "print_length($string)"
Returns the printable length of \f(CW$string\fR, not counting (some) ansi sequences.
.SS "Private api"
.IX Subsection "Private api"
Methods for use in overload classes.
\&\fIAvoid using these methods from the application.\fR
.ie n .IP """bell()""" 4
.el .IP "\f(CWbell()\fR" 4
.IX Item "bell()"
Notify the user of an error or limit.
.ie n .IP """loop()""" 4
.el .IP "\f(CWloop()\fR" 4
.IX Item "loop()"
Low level function used by readline. 
Calls \f(CW\*(C`draw()\*(C'\fR and \f(CW\*(C`do_key()\*(C'\fR.
.ie n .IP """beat()""" 4
.el .IP "\f(CWbeat()\fR" 4
.IX Item "beat()"
Method called by intervals while waiting for input, to be overloaded.
.ie n .IP """read_key()""" 4
.el .IP "\f(CWread_key()\fR" 4
.IX Item "read_key()"
Returns one key read from input (this is the named key, not the char when mapped).
.ie n .IP """do_key($key)""" 4
.el .IP "\f(CWdo_key($key)\fR" 4
.IX Item "do_key($key)"
Execute a key, calls subroutine for a key binding or the default binding.
If \f(CW$key\fR is undefined \f(CW\*(C`read_key()\*(C'\fR is called first.
.ie n .IP """press($string)""" 4
.el .IP "\f(CWpress($string)\fR" 4
.IX Item "press($string)"
Do chars in \f(CW$string\fR like they were typed on the keyboard. Used for testing puposes
and to make macros possible.
.Sp
If you give more then one argument, these are considered individual characters, use this to
press named keys.
.ie n .IP """unread_key($string)""" 4
.el .IP "\f(CWunread_key($string)\fR" 4
.IX Item "unread_key($string)"
Unshifts characters on the read buffer, arguments the same as \f(CW\*(C`press()\*(C'\fR.
.ie n .IP """key_name($chr)""" 4
.el .IP "\f(CWkey_name($chr)\fR" 4
.IX Item "key_name($chr)"
Returns a name for a character or character sequence.
.ie n .IP """key_binding($key, $mode)""" 4
.el .IP "\f(CWkey_binding($key, $mode)\fR" 4
.IX Item "key_binding($key, $mode)"
Returns the keybinding for \f(CW$key\fR in \f(CW$mode\fR, mode defaults to the current one.
.ie n .IP """bindchr($chr, $key)""" 4
.el .IP "\f(CWbindchr($chr, $key)\fR" 4
.IX Item "bindchr($chr, $key)"
Bind a key name to a character, or a character sequence. All bindings of this kind
are global (you're using only one keyboard, right ?).
.ie n .IP """recalc_chr_map()""" 4
.el .IP "\f(CWrecalc_chr_map()\fR" 4
.IX Item "recalc_chr_map()"
Recalculates the chr map, you need to call this after deleting from \f(CW%chr_names\fR.
.ie n .IP """print($lines, $pos)""" 4
.el .IP "\f(CWprint($lines, $pos)\fR" 4
.IX Item "print($lines, $pos)"
Low level function used by draw. Both arguments need to be array references.
.SH "BUGS"
.IX Header "BUGS"
Undefined behaviour when the buffer has more lines then the terminal.
.PP
Please mail the author if you find any other bugs.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jaap Karssenberg || Pardus [Larus] <pardus@cpan.org>
.PP
Copyright (c) 2004 Jaap G Karssenberg. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Term::ReadLine::Zoid