NAME
Term::Choose::Util - TUI-related functions for selecting directories, files, numbers and subsets of lists.
DESCRIPTION
This module provides TUI-related functions for selecting directories, files, numbers and subsets of lists.
CONSTRUCTOR
The constructor method new can be called with optional named arguments:
my $new = Term::Choose::Util.new( :mouse( 1 ), ... )
ROUTINES
Values in brackets are default values.
Options available for all subroutines
Customize the string of the menu entry "back".
Default: BACK
If enabled, the screen is cleared before the output.
Values: [0],1.
Enables the support for color and text formatting escape sequences.
Setting color to 1 enables the support for color and text formatting escape sequences except for the current selected element. If set to 2, also for the current selected element the color support is enabled (inverted colors).
Values: [0],1,2.
Customize the string of the menu entry "confirm".
Default: CONFIRM.
The value of cs-label (current selection label) is a string which is placed in front of the current selection.
Defaults: choose-directories: 'Chosen Dirs: ', choose-a-directory: 'Directory: ', choose-a-file: 'File: '. For choose-a-number, choose-a-subset and settings-menu the default is undefined.
The current-selection output is placed between the info string and the prompt string.
Hide the cursor
Values: 0,[1].
A string placed on top of of the output.
Default: undef
The option margin allows one to set a margin on all four sides.
margin expects a reference to an array with four elements in the following order:
top margin (number of terminal lines)
right margin (number of terminal columns)
botton margin (number of terminal lines)
left margin (number of terminal columns)
margin does not affect the info string. To add margins to the info string see tabs-info.
margin changes the default values of tabs-prompt.
Allowed values: 0 or greater. Elements beyond the fourth are ignored.
Default: undef
Enable the mouse mode. An item can be chosen with the left mouse key, the right mouse key can be used instead of the SpaceBar key.
Values: [0],1.
A string placed on top of the available choices.
Default: undef
0 - off (default)
1 - use the alternate screen
The option tabs-info allows one to insert spaces at the beginning and the end of info lines.
tabs-info expects a reference to an array with one to three elements:
the first element (initial tab) sets the number of spaces inserted at beginning of paragraphs
the second element (subsequent tab) sets the number of spaces inserted at the beginning of all broken lines apart from the beginning of paragraphs
the third element sets the number of spaces used as a right margin.
Allowed values: 0 or greater. Elements beyond the third are ignored.
default: If margin is set, the initial-tab and the subsequent-tab are set to left-margin and the right margin is set to right-margin. If margin is not defined, the default is undefined.
The option tabs-prompt allows one to insert spaces at the beginning and the end of the current-selection and prompt lines.
tabs-prompt expects a reference to an array with one to three elements:
the first element (initial tab) sets the number of spaces inserted at beginning of paragraphs
the second element (subsequent tab) sets the number of spaces inserted at the beginning of all broken lines apart from the beginning of paragraphs
the third element sets the number of spaces used as a right margin.
Allowed values: 0 or greater. Elements beyond the third are ignored.
default: If margin is set, the initial-tab and the subsequent-tab are set to left-margin and the right margin is set to right-margin. choose-directories and choose-a-subset: +2 for the subsequent-tab. Else the default is undefined.
choose-a-directory
my $chosen-directory = choose-a-directory( :1layout, ... )
With choose-a-directory the user can browse through the directory tree 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 "confirm" menu entry.
The "back" menu entry causes choose-a-directory to return nothing.
Following options can be set:
Elements in columns are aligned to the left if set to 0, aligned to the right if set to 1 and centered if set to 2.
Values: [0],1,2.
Set the starting point directory. Defaults to the home directory ($*HOME).
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].
Customize the string of the menu entry "parent-dir".
Default: ..
If enabled, hidden directories are added to the available directories.
Values: 0,[1].
- [Options available for all subroutines](#Options available for all subroutines)
choose-a-file
my $chosen-file = choose-a-file( :1layout, ... )
Choose the file directory and then choose a file from the chosen directory. To return the chosen file select the "confirm" menu entry.
Options as in choose-a-directory plus
If set, the value of this option is treated as a regex pattern.
Only files matching this pattern will be displayed.
The regex pattern is used as the value of dirs :test parameter.
choose-directories
my @chosen-directories = choose-directories( :1layout, ... )
choose-directories is similar to choose-a-directory but it is possible to return multiple directories.
Options as in choose-a-directory.
choose-a-number
my $number = choose-a-number( 5, :cs-label<Testnumber>, ... );
This function lets you choose/compose a number (unsigned integer) which is then returned.
The fist argument is an integer and determines the range of the available numbers. For example setting the first argument to 4 would offer a range from 0 to 9999. If not set, it defaults to 7.
Options:
Set a default number (unsigned integer in the range of the available numbers).
Default: undef
Put the small number ranges on top.
Sets the thousands separator.
Default: ,
- [Options available for all subroutines](#Options available for all subroutines)
choose-a-subset
my $subset = choose-a-subset( @available-items, :1layout, ... )
choose-a-subset lets you choose a subset from a list.
The subset is returned as an array.
The first argument is the list of choices.
Options:
If enabled, all elements are selected if CONFIRM is chosen without any selected elements.
Elements in columns are aligned to the left if set to 0, aligned to the right if set to 1 and centered if set to 2.
Values: [0],1,2.
If true, the index positions in the available list of the made choices are returned.
Values: [0],1.
If enabled, the chosen items are not removed from the available choices.
Values: [0],1;
See the option layout in Term::Choose.
Values: 0,1,2,[3].
Expects as its value a reference to an array with indexes. Elements corresponding to these indexes are pre-selected when choose-a-subset is called.
If set to 1, the items are ordered vertically else they are ordered horizontally.
This option has no meaning if layout is set to 3.
Values: 0,[1].
prefix expects as its value a string. This string is put in front of the elements of the available list in the menu. The chosen elements are returned without this prefix.
Default: empty string.
Info output: the cs-begin string is placed between the cs-label string and the chosen elements as soon as an element has been chosen.
Default: empty string
Info output: cs-separator is placed between the chosen list elements.
Default: ,
Info output: as soon as elements have been chosen the cs-end string is placed at the end of the chosen elements.
Default: empty string
- [Options available for all subroutines](#Options available for all subroutines)
To return the chosen subset select the "confirm" menu entry.
The "back" menu entry removes the last added chosen items. If the list of chosen items is empty, "back" causes choose-a-subset to return nothing.
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, :1mouse, ... );
The first argument is a list of lists. Each of the lists has three elements:
The second argument is a hash:
The hash keys are the option names
The values are the indexes of the current value of the respective key/option. If an index is undefined or out of bonds, it is set to 0.
This hash is edited in place; the changes made by the user are saved in this hash.
Options:
Info output: the cs-begin string is placed between the cs-label string and the key-value pairs.
Default: empty string
Info output: cs-separator is placed between the key-value pairs.
Default: ,
Info output: the cs-end string is placed at the end of the key-value pairs.
Default: empty string
- [Options available for all subroutines](#Options available for all subroutines)
The info output line is only shown if the option cs-label is set to a defined value.
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.After scrolling through the list once the cursor jumps back to the top row.
If the "back" menu entry is chosen, settings-menu does not apply the made changes and returns nothing. If the "confirm" menu entry is chosen, settings-menu applies the made changes in place to the passed configuration hash (second argument) and returns the number of made changes.
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-2024 Matthäus Kiem.
This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.