UI::Dialog::Screen::Menu3pm

new( %options )

EXAMPLE

 # Have UI::Dialog::Screen::Menu use an existing UI::Dialog instance
 # to render the user interface.
 my $s = new( dialog => $d );
 # Also accepts UI::Dialog constructor arguments, so that it can create
 # it's own instance of UI::Dialog if none is provided.
 my $s = new( title => 'Default Title', backtitle => 'Backtitle',
              width => 65, height => 20, listheight => 5,
              order => [ 'zenity', 'xdialog', 'gdialog' ] );

DESCRIPTION

This is the Class Constructor method. It accepts a list of key => value pairs and uses them as the defaults when interacting with the various widgets.

RETURNS

A blessed object reference of the UI::Dialog::Screen::Menu class.

OPTIONS

The (...)'s after each option indicate the default for the option. An * denotes support by all the widget methods on a per-use policy defaulting to the values decided during object creation.

dialog = UI::Dialog (undef)

debug = 0,1,2 (0)

order = [ zenity, xdialog, gdialog, kdialog, cdialog, whiptail, ascii ] (as indicated)

PATH = [ /bin, /usr/bin, /usr/local/bin, /opt/bin ] (as indicated)

backtitle = "backtitle" ('') *

title = "title" ('') *

beepbefore = 0,1 (0) *

beepafter = 0,1 (0) *

height = \d+ (20) *

width = \d+ (65) *

listheight = \d+ (5) *

run( )

EXAMPLE

 my $rv = $s->run();

DESCRIPTION

Render the screen menu immediately. This method blocks until the user input has been received and acted upon.

RETURNS

TRUE if the user selected an item from the menu, FALSE otherwise.

loop( )

EXAMPLE

 $s->loop();

DESCRIPTION

Calls the run() method immediately. Once run() completes it's execution, the loop() decides whether or not to display again. If the return value of run() is TRUE, the loop() will continue. If the use pressed Cancel (or Escape) or any other action other than one of the menu items; the loop() will end. The loop() will also end if the break_loop() method is called.

RETURNS

TRUE if the user selected an item from the menu, FALSE otherwise.

is_looping( )

EXAMPLE

 if ($s->is_looping()) {
     print "Currently in a UI::Dialog::Screen::Menu loop\n";
 }

DESCRIPTION

Returns TRUE if the given screen is in a menu loop(), FALSE otherwise.

RETURNS

a single SCALAR.

break_loop( )

EXAMPLE

 $s->break_loop();

DESCRIPTION

Flags the screen menu to stop looping. This does not close or otherwise clear the screen. This simply flags the loop to exit at the end of it's current run.

RETURNS

None.

add_menu_item( )

EXAMPLE

 my $index = $s->add_menu_item( "Menu Item Label", \%some_function );

DESCRIPTION

Append a new item to the menu list.

RETURNS

Returns the list index (starting from 0) of the item that was just appended to the list.

get_menu_items( )

EXAMPLE

 my @items = $s->get_menu_items();

DESCRIPTION

Returns an array of hashrefs. Each hash contains a "label" and "func" key/value pairs.

RETURNS

An ARRAY.

del_menu_item( )

EXAMPLE

 my $old_item = $d->del_menu_item( $index );

DESCRIPTION

Remove a specific item from the menu, addressed by it's list index (starting from 0), and return the menu item as a hashref.

RETURNS

A HASH containing the 'label' and 'func' of the menu item that was just removed from the menu list.

set_menu_item( )

EXAMPLE

 # Modify the 'label' and 'func' for a specific menu item
 my $original_item = $s->set_menu_item( $index, $label, $func );
 # Modify just the label of a menu item
 my $original_item = $s->set_menu_item( $index, $label, undef );
 # Modify just the func of a menu item
 my $original_item = $s->set_menu_item( $index, undef, $func );
 # Effectively do nothing
 my $original_item = $s->set_menu_item( $index, undef, undef );

DESCRIPTION

Modify the menu item addressed by the given index (starting from 0). If the 'label' and/or 'func' arguments are undef then the previous value is kept.

RETURNS

A HASH of the original values for the modified menu item.