Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

curses::widgets::textmemo(3pm) [debian man page]

Widgets::TextMemo(3pm)					User Contributed Perl Documentation				    Widgets::TextMemo(3pm)

NAME
Curses::Widgets::TextMemo - Text Memo Widgets MODULE VERSION
$Id: TextMemo.pm,v 1.104 2002/11/14 01:27:31 corliss Exp corliss $ SYNOPSIS
use Curses::Widgets::TextMemo; $tm = Curses::Widgets::TextMemo->new({ CAPTION => 'Memo', CAPTIONCOL => 'blue', COLUMNS => 10, MAXLENGTH => undef, LINES => 3, MASK => undef, VALUE => '', INPUTFUNC => &scankey, FOREGROUND => 'white', BACKGROUND => 'black', BORDER => 1, BORDERCOL => 'red', FOCUSSWITCH => " ", CURSORPOS => 0, TEXTSTART => 0, PASSWORD => 0, X => 1, Y => 1, READONLY => 0, }); $tm->draw($mwh, 1); See the Curses::Widgets pod for other methods. REQUIREMENTS
Curses Curses::Widgets DESCRIPTION
Curses::Widgets::TextMemo provides simplified OO access to Curses-based single line text fields. Each object maintains its own state information. METHODS
new (inherited from Curses::Widgets) $tm = Curses::Widgets::TextMemo->new({ CAPTION => 'Memo', CAPTIONCOL => 'blue', COLUMNS => 10, MAXLENGTH => undef, LINES => 3, MASK => undef, VALUE => '', INPUTFUNC => &scankey, FOREGROUND => 'white', BACKGROUND => 'black', BORDER => 1, BORDERCOL => 'red', FOCUSSWITCH => " ", CURSORPOS => 0, TEXTSTART => 0, PASSWORD => 0, X => 1, Y => 1, READONLY => 0, }); The new method instantiates a new TextMemo object. The only mandatory key/value pairs in the configuration hash are X and Y. All others have the following defaults: Key Default Description ============================================================ CAPTION undef Caption superimposed on border CAPTIONCOL undef Foreground colour for caption text COLUMNS 10 Number of columns displayed MAXLENGTH undef Maximum string length allowed LINES 3 Number of lines in the window VALUE '' Current field text INPUTFUNC &scankey Function to use to scan for keystrokes FOREGROUND undef Default foreground colour BACKGROUND undef Default background colour BORDER 1 Display a border around the field BORDERCOL undef Foreground colour for border FOCUSSWITCH " " Characters which signify end of input CURSORPOS 0 Starting position of the cursor TEXTSTART 0 Line number of string to start displaying PASSWORD 0 Subsitutes '*' instead of characters READONLY 0 Prevents alteration to content The CAPTION is only valid when the BORDER is enabled. If the border is disabled, the field will be underlined, provided the terminal sup- ports it. The MAXLENGTH has no effect if left undefined. draw $tm->draw($mwh, 1); The draw method renders the text memo in its current state. This requires a valid handle to a curses window in which it will render itself. The optional second argument, if true, will cause the field's text cursor to be rendered as well. HISTORY
1999/12/29 -- Original text field widget in functional model 2001/07/05 -- First incarnation in OO architecture AUTHOR
/COPYRIGHT (c) 2001 Arthur Corliss (corliss@digitalmages.com) perl v5.8.8 2006-09-14 Widgets::TextMemo(3pm)

Check Out this Related Man Page

Widgets::Calendar(3pm)					User Contributed Perl Documentation				    Widgets::Calendar(3pm)

NAME
Curses::Widgets::Calendar - Calendar Widgets MODULE VERSION
$Id: Calendar.pm,v 1.103 2002/11/03 23:33:05 corliss Exp corliss $ SYNOPSIS
use Curses::Widgets::Calendar; $cal = Curses::Widgets::Calendar->({ CAPTION => 'Appointments', CAPTIONCOL => 'yellow', INPUTFUNC => &scankey, FOREGROUND => undef, BACKGROUND => 'black', BORDER => 1, BORDERCOL => 'red', FOCUSSWITCH => " ", X => 1, Y => 1, HIGHLIGHT => [12, 17, 25], HIGHLIGHTCOL=> 'green', MONTH => '11/2001', ONYEAR => &yearly, ONMONTH => &monthly, ONDAY => &daily, }); $cal->draw($mwh, 1); See the Curses::Widgets pod for other methods. REQUIREMENTS
Curses Curses::Widgets DESCRIPTION
Curses::Widgets::Calendar provides simplified OO access to Curses-based calendars. Each object maintains it's own state information. METHODS
new (inherited from Curses::Widgets) $cal = Curses::Widgets::Calendar->({ CAPTION => 'Appointments', CAPTIONCOL => 'yellow', INPUTFUNC => &scankey, FOREGROUND => undef, BACKGROUND => 'black', BORDER => 1, BORDERCOL => 'red', FOCUSSWITCH => " ", X => 1, Y => 1, HIGHLIGHT => [12, 17, 25], HIGHLIGHTCOL=> 'green', MONTH => '11/2001', ONYEAR => &yearly, ONMONTH => &monthly, ONDAY => &daily, }); The new method instantiates a new Calendar object. The only mandatory key/value pairs in the configuration hash are X and Y. All others have the following defaults: Key Default Description ============================================================ CAPTION undef Caption superimposed on border CAPTIONCOL undef Foreground colour for caption text INPUTFUNC &scankey Function to use to scan for keystrokes FOREGROUND undef Default foreground colour BACKGROUND undef Default background colour BORDER 1 Display a border around the field BORDERCOL undef Foreground colour for border FOCUSSWITCH " " Characters which signify end of input HIGHLIGHT [] Days to highlight HIGHLIGHTCOL undef Default highlighted data colour HEADERCOL undef Default calendar header colour MONTH (current) Month to display VALUE 1 Day of the month where the cursor is ONYEAR undef Callback function triggered by year ONMONTH undef Callback function triggered by month ONDAY undef Callback function triggered by day Each of the ON* callback functions expect a subroutine reference that excepts one argument: a handle to the calendar object itself. If more than one trigger is called, it will be called in the order of day, month, and then year. draw $cal->draw($mwh, 1); The draw method renders the calendar in its current state. This requires a valid handle to a curses window in which it will render itself. The optional second argument, if true, will cause the calendar's selected day to be rendered in standout mode (inverse video). HISTORY
1999/12/29 -- Original calendar widget in functional model 2001/07/05 -- First incarnation in OO architecture AUTHOR
/COPYRIGHT (c) 2001 Arthur Corliss (corliss@digitalmages.com) perl v5.8.8 2006-09-14 Widgets::Calendar(3pm)
Man Page