.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "Curses::UI::Common 3"
.TH Curses::UI::Common 3 2023-07-25 "perl v5.38.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
Curses::UI::Common \- Common methods for Curses::UI
.SH "CLASS HIERARCHY"
.IX Header "CLASS HIERARCHY"
.Vb 1
\& Curses::UI::Common \- base class
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    package MyPackage;
\&
\&    use Curses::UI::Common;
\&    use vars qw(@ISA);
\&    @ISA = qw(Curses::UI::Common);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Curses::UI::Common is a collection of methods that is
shared between Curses::UI classes.
.SH METHODS
.IX Header "METHODS"
.SS "Various methods"
.IX Subsection "Various methods"
.IP \(bu 4
\&\fBparent\fR ( )
.Sp
Returns the data member \f(CW$this\fR\->{\fB\-parent\fR}.
.IP \(bu 4
\&\fBroot\fR ( )
.Sp
Returns the topmost \fB\-parent\fR (the Curses::UI instance).
.IP \(bu 4
\&\fBdelallwin\fR ( )
.Sp
This method will walk through all the data members of the
class intance. Each data member that is a Curses::Window
descendant will be removed.
.IP \(bu 4
\&\fBaccessor\fR ( NAME, [VALUE] )
.Sp
If VALUE is set, the value for the data member \f(CW$this\fR\->{NAME} 
will be changed. The method will return the current value for
data member \f(CW$this\fR\->{NAME}.
.IP \(bu 4
\&\fBkeys_to_lowercase\fR ( HASHREF )
.Sp
All keys in the hash referred to by HASHREF will be 
converted to lower case.
.SS "Text processing"
.IX Subsection "Text processing"
.IP "\fBsplit_to_lines\fR ( TEXT )" 4
.IX Item "split_to_lines ( TEXT )"
This method will split TEXT into a list of separate lines.
It returns a reference to this list.
.IP "\fBscrlength\fR ( LINE )" 4
.IX Item "scrlength ( LINE )"
Returns the screenlength of the string LINE. The difference
with the perl function \fBlength()\fR is that this method will
expand TAB characters. It is exported by this class and it may
be called as a stand-alone routine.
.IP "\fBtext_dimension\fR ( TEXT )" 4
.IX Item "text_dimension ( TEXT )"
This method will return an array containing the width 
(the length of the longest line) and the height (the
number of lines) of the TEXT.
.IP "\fBtext_wrap\fR ( LINE, LENGTH, WORDWRAP )" 4
.IX Item "text_wrap ( LINE, LENGTH, WORDWRAP )"
.PD 0
.IP "\fBWORDWRAP\fR ( )" 4
.IX Item "WORDWRAP ( )"
.IP "\fBNO_WORDWRAP\fR ( )" 4
.IX Item "NO_WORDWRAP ( )"
.PD
This method will wrap a line of text (LINE) to a 
given length (LENGTH). If the WORDWRAP argument is
true, wordwrap will be enabled (this is the default
for WORDWRAP). It will return a reference to a list
of wrapped lines. It is exported by this class and it may
be called as a stand-alone routine.
.Sp
The \fBWORDWRAP\fR and \fBNO_WORDWRAP\fR routines will
return the correct value vor the WORDWRAP argument.
These routines are exported by this class.
.Sp
Example:
.Sp
.Vb 1
\&    $this\->text_wrap($line, 50, NO_WORDWRAP);
.Ve
.SS "Reading key input"
.IX Subsection "Reading key input"
.IP "\fBCUI_ESCAPE\fR ( )" 4
.IX Item "CUI_ESCAPE ( )"
.PD 0
.IP "\fBCUI_TAB\fR ( )" 4
.IX Item "CUI_TAB ( )"
.IP "\fBCUI_SPACE\fR ( )" 4
.IX Item "CUI_SPACE ( )"
.PD
These are a couple of routines that are not defined by the
Curses module, but which might be useful anyway. 
These routines are exported by this class.
.IP "\fBget_key\fR ( BLOCKTIME, CURSOR )" 4
.IX Item "get_key ( BLOCKTIME, CURSOR )"
This method will try to read a key from the keyboard.
It will return the key pressed or \-1 if no key was 
pressed. It is exported by this class and it may
be called as a stand-alone routine.
.Sp
The BLOCKTIME argument can be used to set
the curses halfdelay (the time to wait before the
routine decides that no key was pressed). BLOCKTIME is
given in tenths of seconds. The default is 0 (non-blocking
key read).
.Sp
Example:
.Sp
.Vb 1
\&    my $key = $this\->get_key(5)
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Curses::UI
.SH AUTHOR
.IX Header "AUTHOR"
Copyright (c) 2001\-2002 Maurice Makaay. All rights reserved.
.PP
Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)
.PP
This package is free software and is provided "as is" without express
or implied warranty. It may be used, redistributed and/or modified
under the same terms as perl itself.