Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk::Menu::Item (3)

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

User Contributed Perl Documentation                              Menu::Item(3)



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'.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------------+
       |ATTRIBUTE TYPE |      ATTRIBUTE VALUE       |
       +---------------+----------------------------+
       |Availability   | library/perl-5/perl-tk-532 |
       +---------------+----------------------------+
       |Stability      | Volatile                   |
       +---------------+----------------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://search.cpan.org/CPAN/authors/id/S/SR/SREZIC/Tk-804.036.tar.gz.

       Further information about this software can be found on the open source
       community website at http://search.cpan.org/~srezic/Tk.



perl v5.32.0                      2013-11-15                     Menu::Item(3)