Curses::Forms::Dialog::Input - Curses Forms Input Dialog


CursesForms documentation  | view source Contained in the CursesForms distribution.

Index


NAME

Top

Curses::Forms::Dialog::Input - Curses Forms Input Dialog

MODULE VERSION

Top

$Id: Input.pm,v 0.4 2002/11/04 01:06:35 corliss Exp corliss $

SYNOPSIS

Top

	use Curses::Forms::Dialog::Input;

  ($rv, $text) = input('Input Parameter!', BTN_OK | BTN_CANCEL, 
    'Search String', 20, qw(white red yellow));

REQUIREMENTS

Top

Curses Curses::Widgets Curses::Forms Curses::Forms::Dialog

DESCRIPTION

Top

Provides a single function to displaying single field input dialogs.

FUNCTIONS

Top

input

  ($rv, $text) = input('Input Parameter!', BTN_OK | BTN_CANCEL, 
    'Search String', 20, qw(white red yellow));

This function displays an input dialog with the specified title, buttons, and field caption. The following constants are defined for specifying buttons, and can be or'ed to provide multiple choices:

  BTN_OK
  BTN_CANCEL
  BTN_HELP

The remaining arguments is the max string length and the desired colours (foreground, background, and caption colour).

The return value of the dialog will be the index value of the chosen button, as one would normally recieve from the Curses::Widgets::ButtonSet widget, and the string value of the TextField widget.

HISTORY

Top

2002/10/10 -- Rewritten in OO form.

AUTHOR/COPYRIGHT

Top


CursesForms documentation  | view source Contained in the CursesForms distribution.