• NAME
• SYNOPSIS
• DESCRIPTION
• CONSTRUCTORS
• METHODS
• CALLBACKS
• CREDITS

NAME

Curses::Menu::MultiSelect - display a multi-selection menu using Curses

SYNOPSIS

 use Curses::Menu;
 use Curses::Menu::MultiSelect;

 my $menu = new Curses::Menu::MultiSelect(title => "A Menu");

 $menu->additem("Item One");
 $menu->additem("Item Two" => 2);
 $menu->addescape(KEY_ESC, "Cancel", MENU_RETURN, MENU_CANCEL);
 $menu->addescape(KEY_ENTER, "Select", MENU_RETURN, MENU_OK);
 $menu->addescape(ORD('j'), undef, MENU_CALL, \&MENU_UP);
 $menu->addescape(KEY_UP, "Prev Item", MENU_CALL, \&MENU_UP);

 $menu->selected($arrayref);

 $menu->display($window);

 if ($menu->escape() == MENU_OK) {
   @r2 = @{$menu->selected()};
 }

DESCRIPTION

  Curses::Menu::MultiSelect implements a multiple selection menu on
  top of Curses::Menu.

CONSTRUCTORS

  The constructor works the same as the Curses::Menu contstructor.

METHODS

  Only the methods overridded by Curses::Menu::MultiSelect are listed
  here.  Please refer to the Curses::Menu documentation for the rest
  of the methods.

selected()

selected( $arrayref )

Returns or sets the selected item by key. When provided no arguments, it returns a reference to an array of menu item keys.

When calling it to set the selected items, it takes a reference for an array of menu item keys.

CALLBACKS

Menu::Curses::MultiSelect only defines one additional callback:

MENU_CALLBACK_TOGGLE

Toggles the select status of the highlighted item.

CREDITS

Written by Chris Collins <xfire@xware.cx>.

Inspired partially by the long obsolete perlmenu package and my boss.