Help language development. Donate to The Perl Foundation

Term::Choose::Util cpan:KUERBIS last updated on 2018-08-24

Term-Choose-Util-1.1.2/

Build Status

NAME

Term::Choose::Util - CLI related functions.

DESCRIPTION

This module provides some CLI related functions.

CONSTRUCTOR

The constructor method new can be called with optional named arguments:

    my $new = Term::Choose::Util.new( :mouse(1) )

Additionally to the different options mentioned below one can pass the option win to the new-method. The option

win expects as its value a WINDOW object - the return value of NCurses initscr. If set, the different methods use

this global window instead of creating their own without calling endwin to restores the terminal before returning.

ROUTINES

Values in brackets are default values.

Options valid for all routines are

Set to 0 the mouse mode is disabled, set to 1 the mouse mode is enabled.

Values: [0], 1.

A string placed on top of of the output.

If set shows an additionally prompt line before the choices.

choose-a-dir

    $chosen_directory = choose-a-dir( :layout(1), ... )

With choose-a-dir the user can browse through the directory tree (as far as the granted rights permit it) and choose a directory which is returned.

To move around in the directory tree:

To return the current working-directory as the chosen directory choose "=".

The "back"-menu-entry ("E<lt>") causes choose-a-dir to return nothing.

It can be set the following options:

Set the starting point directory. Defaults to the home directory ($*HOME).

If set to 1, the default cursor position is on the "up" menu entry. If the directory name remains the same after an user input, the default cursor position changes to "back".

If set to 0, the default cursor position is on the "back" menu entry.

Values: 0,[1].

Elements in columns are left justified if set to 0, right justified if set to 1 and centered if set to 2.

Values: [0],1,2.

See the option layout in Term::Choose

Values: 0,[1],2.

If set to 1, the items are ordered vertically else they are ordered horizontally.

This option has no meaning if layout is set to 2.

Values: 0,[1].

If enabled, hidden directories are added to the available directories.

Values: 0,[1].

choose-a-file

    $chosen_file = choose-a-file( :layout(1), ... )

Browse the directory tree like with choose-a-dir. Select "E<gt>F" to get the files of the current directory. To return the chosen file select "=".

See #choose-a-dir for the different options.

choose-dirs

    @chosen_directories = choose-dirs( :layout(1), ... )

choose-dirs is similar to choose-a-dir but it is possible to return multiple directories.

"." adds the current directory to the list of chosen directories and "=" returns the chosen list of directories.

The "back"-menu-entry ( "E<lt>" ) removes the last added directory. If the list of chosen directories is empty, "E<lt>" causes choose-dirs to return nothing.

choose-dirs uses the same option as choose-a-dir. The option prompt can be used to put empty lines between the header rows and the menu: an empty string ('') means no newline, a space (' ') one newline, a newline ("\n") two newlines.

choose-a-number

    my $number = choose-a-number( 5, :name<Testnumber> );

This function lets you choose/compose a number (unsigned integer) which is returned.

The fist argument - "digits" - is an integer and determines the range of the available numbers. For example setting the first argument to 6 would offer a range from 0 to 999999. If not set, it defaults to 7.

The available options:

Sets the name of the number seen in the prompt line.

Default: empty string ("");

Sets the thousands separator.

Default: comma (,).

choose-a-subset

    $subset = choose-a-subset( @available_items, :layout( 1 ) )

choose-a-subset lets you choose a subset from a list.

The first argument is the list of choices. The following arguments are the options:

The subset is returned as an array.

If true, the index positions in the available list of the made choices is returned.

Elements in columns are left justified if set to 0, right justified if set to 1 and centered if set to 2.

Values: [0],1,2.

See the option layout in Term::Choose.

Values: 0,1,[2].

If set to 1, the items are ordered vertically else they are ordered horizontally.

This option has no meaning if layout is set to 2.

Values: 0,[1].

prefix expects as its value a string. This string is put in front of the elements of the available list before printing. The chosen elements are returned without this prefix.

The default value is "- " if the layout is 2 else the default is the empty string ("").

settings-menu

    my @menu = (
        ( 'enable_logging', "- Enable logging", ( 'NO', 'YES' )   ),
        ( 'case_sensitive', "- Case sensitive", ( 'NO', 'YES' )   ),
        ( 'attempts',       "- Attempts"      , ( '1', '2', '3' ) )
    );

    my %config = (
        'enable_logging' => 0,
        'case_sensitive' => 1,
        'attempts'       => 2
    );

    settings-menu( @menu, %config );

The first argument is a list of lists. Each of the lists have three elements:

the option name

the prompt string

a list of the available values for the option

The second argument is a hash:

the hash key is the option name

the hash value (zero based index) sets the current value for the option.

This hash is edited in place: the changes made by the user are saved as new current values.

The following arguments can be the different options.

When settings-menu is called, it displays for each list entry a row with the prompt string and the current value. It is possible to scroll through the rows. If a row is selected, the set and displayed value changes to the next. If the end of the list of the values is reached, it begins from the beginning of the list.

AUTHOR

Matthäus Kiem cuer2s@gmail.com

CREDITS

Thanks to the people from Perl-Community.de, from stackoverflow and from #perl6 on irc.freenode.net for the help.

LICENSE AND COPYRIGHT

Copyright 2016-2018 Matthäus Kiem.

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.