NAME

Curses::Forms::Dialog - Curses Forms Dialog

MODULE VERSION

$Id: Dialog.pm,v 0.4 2002/11/14 19:09:08 corliss Exp corliss $

SYNOPSIS

        use Curses::Forms::Dialog;

  $rv = dialog('Warning!', BTN_OK, 'You generated and error!', 
    qw(white red yellow));

REQUIREMENTS

Curses Curses::Widgets Curses::Forms

DESCRIPTION

Provides a single function to displaying flexible dialogs.

FUNCTIONS

dialog

  $rv = dialog('Warning!', BTN_OK, 'You generated and error!', 
    qw(white red yellow));

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

  BTN_OK
  BTN_YES
  BTN_NO
  BTN_CANCEL
  BTN_HELP

The buttons will always be displayed in the order shown above, and is not modifiable. The remaining optional arguments are the desired colours for the foreground, background, and caption colour, respectively.

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.

This function can handle multi-line messages with embedded newlines, as long as the number of lines doesn't cause the dialog to be too large to display as a whole on the screen. It uses the textwrap function from Curses::Widgets to split lines longer than the screen according to whitespace.

HISTORY

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