Simple curses utilities
Project description
CursesUtils
Functions
menu.menu(stdscr, title, options)
Pulls up a select menu.
stdscr
: The screen to write to.title
: The title of the menu.options
: A collection of strings to choose from.
Returns the index of the selected item, or None if the user chooses to quit.
number_select.number_select(stdscr, title, num_range, start = None)
Pulls up a number selection menu.
stdscr
: The screen to write to.title
: The title of the selection.num_range
: A range object for valid numbers.start
: The starting selected number. Defaults tonum_range
's min value.
Returns the number selected, or None if the user chooses to quit.
remap_keys.set_key_codes(key_name, key_codes)
Sets a key's function by name.
key_name
: The key name to set.key_codes
: A collection of key codes (as returned bystdscr.getkey()
) to use.
Make sure to set keys before using them! Internally, CursesUtils uses the following keys:
menu_up
(for navigating UP through menus)menu_down
(for navigating DOWN through menus)menu_confirm
(for CONFIRMING on menus)menu_cancel
(for QUITTING on menus)
remap_keys.get_key_codes(key_name)
Gets a key's codes by name.
key_name
: The key name to get the codes of.
Returns the key codes of the given key, or None if it doesn't exist. See set_key_codes for more information.
remap_keys.get_next_key(stdscr)
Gets the next key and saves it.
stdscr
: The screen to write to.
remap_keys.get_current_key()
Gets the current pressed key.
remap_keys.is_pressed(key_name)
Checks if the given key is the current pressed key by name.
key_name
: The key name to check.
wrapper.wrapper(func)
Wraps a function to set up and shut down, also wrapping using curses.wrapper
.
func
: The function to wrap.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for curses_utils-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bb394264270ab77991ba2d8b95c0213c8dce49d158585f4ce2287583a15628c |
|
MD5 | a12cc7976af636ebe50521ae52f7f497 |
|
BLAKE2b-256 | f6392629c28b4bc56e5a2c44f440c2b5cc6bddb7594c51bb8c8507b850c6862b |