tk::menu::item(3pm) [debian man page]

Menu::Item(3pm) 					User Contributed Perl Documentation					   Menu::Item(3pm)

NAME

       Tk::Menu::Item - Base class for Menu items

SYNOPSIS

	  require Tk::Menu::Item;

	  my $but = $menu->Button(...);
	  $but->configure(...);
	  my $what = $but->cget();

	  package Whatever;
	  require Tk::Menu::Item;
	  @ISA = qw(Tk::Menu::Item);

	  sub PreInit
	  {
	   my ($class,$menu,$info) = @_;
	   $info->{'-xxxxx'} = ...
	   my $y = delete $info->{'-yyyy'};
	  }

DESCRIPTION

       Tk::Menu::Item is the base class from which Tk::Menu::Button, Tk::Menu::Cascade, Tk::Menu::Radiobutton and Tk::Menu::Checkbutton are
       derived.  There is also a Tk::Menu::Separator.

       Constructors are declared so that $menu->Button(...) etc. do what you would expect.

       The "-label" option is pre-processed allowing ~ to be prefixed to the character to derive a "-underline" value. Thus

	   $menu->Button(-label => 'Goto ~Home',...)

	   is equivalent to

	   $menu->Button(-label => 'Goto Home', -underline => 6, ...)

       The "Cascade" menu item creates a sub-menu and accepts these options:

       -menuitems
	   A list of items for the sub-menu.  Within this list (which is also accepted by Menu and Menubutton) the first two elements of each item
	   should be the "constructor" name and the label:

	       -menuitems => [
			      [Button	   => '~Quit', -command => [destroy => $mw]],
			      [Checkbutton => '~Oil',  -variable => $oil],
			     ]

       -postcommand
	   A callback to be invoked before posting the menu.

       -tearoff
	   Specifies whether sub-menu can be torn-off or not.

       -menuvar
	   Scalar reference that will be set to the newly-created sub-menu.

       The returned object is currently a blessed reference to an array of two items: the containing Menu and the 'label'.  Methods "configure"
       and "cget" are mapped onto underlying "entryconfigure" and "entrycget".

       The main purpose of the OO interface is to allow derived item classes to be defined which pre-set the options used to create a more basic
       item.

BUGS

       This OO interface is very new. Using the label as the "key" is a problem for separaror items which don't have one. The alternative would be
       to use an index into the menu but that is a problem if items are deleted (or inserted other than at the end).

       There should probably be a PostInit entry point too, or a more widget like defered 'configure'.

perl v5.14.2							    2010-05-29							   Menu::Item(3pm)

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)