Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Curses::UI::Common(3) User Contributed Perl DocumentationCurses::UI::Common(3)

NAME
       Curses::UI::Common - Common methods for Curses::UI

CLASS HIERARCHY
	Curses::UI::Common - base class

SYNOPSIS
	   package MyPackage;

	   use Curses::UI::Common;
	   use vars qw(@ISA);
	   @ISA	= qw(Curses::UI::Common);

DESCRIPTION
       Curses::UI::Common is a collection of methods that is shared between
       Curses::UI classes.

METHODS
   Various methods
       o   parent ( )

	   Returns the data member $this->{-parent}.

       o   root	( )

	   Returns the topmost -parent (the Curses::UI instance).

       o   delallwin ( )

	   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.

       o   accessor ( NAME, [VALUE] )

	   If VALUE is set, the	value for the data member $this->{NAME}	will
	   be changed. The method will return the current value	for data
	   member $this->{NAME}.

       o   keys_to_lowercase ( HASHREF )

	   All keys in the hash	referred to by HASHREF will be converted to
	   lower case.

   Text	processing
       split_to_lines (	TEXT )
	   This	method will split TEXT into a list of separate lines.  It
	   returns a reference to this list.

       scrlength ( LINE	)
	   Returns the screenlength of the string LINE.	The difference with
	   the perl function length() is that this method will expand TAB
	   characters. It is exported by this class and	it may be called as a
	   stand-alone routine.

       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.

       text_wrap ( LINE, LENGTH, WORDWRAP )
       WORDWRAP	( )
       NO_WORDWRAP ( )
	   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.

	   The WORDWRAP	and NO_WORDWRAP	routines will return the correct value
	   vor the WORDWRAP argument.  These routines are exported by this
	   class.

	   Example:

	       $this->text_wrap($line, 50, NO_WORDWRAP);

   Reading key input
       CUI_ESCAPE ( )
       CUI_TAB ( )
       CUI_SPACE ( )
	   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.

       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.

	   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).

	   Example:

	       my $key = $this->get_key(5)

SEE ALSO
       Curses::UI

AUTHOR
       Copyright (c) 2001-2002 Maurice Makaay. All rights reserved.

       Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)

       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.

perl v5.24.1			  2011-09-01		 Curses::UI::Common(3)

NAME | CLASS HIERARCHY | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Curses::UI::Common&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help