No description, website, or topics provided.
Perl 6
Switch branches/tags
Nothing to show
Latest commit 5360835 Aug 6, 2017 @kuerbis Removed unused function
Permalink
Failed to load latest commit information.
lib/Term/Choose Removed unused function Aug 6, 2017
t 0.006 Mar 16, 2016
xt
.gitignore 0.004 Mar 1, 2016
.travis.yml Use NCurses Jul 3, 2017
Changes Removed unused function Aug 6, 2017
LICENSE 0.001 Feb 10, 2016
META6.json Removed unused function Aug 6, 2017
README.md Backward incompatible changes Jul 30, 2017

README.md

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

  • mouse

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

Values: [0],1.

  • prompt

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:

  • select a directory and press Return to enter in the selected directory.

  • choose the "up"-menu-entry ("..") to move upwards.

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:

  • current-dir

If set, choose-a-dir shows current-dir as the current directory.

  • dir

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

  • enchanted

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

  • justify

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.

  • layout

See the option layout in Term::Choose

Values: 0,[1],2.

  • order

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

  • show-hidden

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. Instead current-dir choose-a-file has current-file.

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>" ) resets the list of chosen directories if any. 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. Instead current-dir choose_dirs has current-dirs. current-dirs expects as its value a list (directories shown as the current directories).

choose-a-number

    my $current-number = 139;
    for ( 1 .. 3 ) {
        $current-number = choose-a-number( 5, :$current-number, :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.

The available options:

  • current-number

The current value (integer). If set, two prompt lines are displayed - one for the current number and one for the new number.

  • name

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

Default: empty string ("");

  • thsd-sep

Sets the thousands separator.

Default: comma (,).

choose-a-subset

    $subset = choose-a-subset( @available_items, :current-list( @current_subset ) )

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:

  • current-list

This option expects as its value the current subset of the available list. If set, two prompt lines are displayed - one for the current subset and one for the new subset. Even if the option index is true the passed current subset is made of values and not of indexes.

The subset is returned as an array.

  • index

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

  • justify

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.

  • layout

See the option layout in Term::Choose.

Values: 0,1,[2].

  • order

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

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 ("").

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-2017 Matthäus Kiem.

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