curses::widgets::menu(3pm) [debian man page]
Widgets::Menu(3pm) User Contributed Perl Documentation Widgets::Menu(3pm) NAME
Curses::Widgets::Menu - Menu Widgets MODULE VERSION
$Id: Menu.pm,v 1.103 2002/11/14 01:26:34 corliss Exp corliss $ SYNOPSIS
use Curses::Widgets::Menu; $menu = Curses::Widgets::Menu->new({ COLUMNS => 10, INPUTFUNC => &scankey, FOREGROUND => undef, BACKGROUND => 'black', FOCUSSWITCH => " ", X => 1, Y => 1, MENUS => { MENUORDER => [qw(File)], File => { ITEMORDER => [qw(Save Quit)], Save => &Save, Quit => &Quit, }, CURSORPOS => 'File', BORDER => 1, }); $menu->draw($mwh, 1); $menu->execute; See the Curses::Widgets pod for other methods. REQUIREMENTS
Curses Curses::Widgets Curses::Widgets::ListBox DESCRIPTION
Curses::Widgets::Menu provides simplified OO access to menus. Each item in a menu can be tied to a subroutine reference which is called when selected. METHODS
new (inherited from Curses::Widgets) $menu = Curses::Widgets::Menu->new({ INPUTFUNC => &scankey, FOREGROUND => undef, BACKGROUND => 'black', FOCUSSWITCH => " ", MENUS => { MENUORDER => [qw(File)], File => { ITEMORDER => [qw(Save Quit)], Save => &Save, Quit => &Quit, }, CURSORPOS => 'File', BORDER => 1, }); The new method instantiates a new Menu object. The only mandatory key/value pairs in the configuration hash are X and Y. All others have the following defaults: Key Default Description ============================================================ INPUTFUNC &scankey Function to use to scan for keystrokes FOREGROUND undef Default foreground colour BACKGROUND 'black' Default background colour FOCUSSWITCH " " Characters which signify end of input MENUS {} Menu structure CURSORPOS '' Current position of the cursor BORDER 0 Avoid window borders The MENUS option is a hash of hashes, with each hash a separate menu, and the constituent hashes being a Entry/Function pairs. Each hash requires a special key/value pair that determines the order of the items when displayed. Each item is separated by two spaces. draw $menu->draw($mwh, 1); The draw method renders the menu 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 selection cursor to be rendered as well. popup $menu->popup; This method causes the menu to be displayed. Since, theoretically, the menu should never be seen unless it's being actively used, we will always assume that we need to draw a cursor on the list as well. execute $menu->execute; This method acts like the standard Curses::Widgets method of the same name, with the exception being that selection of any menu item will also cause it to exit (having already called the associated item subroutine). HISTORY
2002/10/17 -- First implementation AUTHOR
/COPYRIGHT (c) 2001 Arthur Corliss (corliss@digitalmages.com) perl v5.8.8 2006-09-14 Widgets::Menu(3pm)
Check Out this Related 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)