curses — Terminal handling for character-cell displays

Source code: Lib/curses

---

The curses module provides an interface to the curses library, the de-facto standard for portable advanced terminal handling.

Хоча curses найбільш широко використовується в середовищі Unix, версії доступні для Windows, DOS і, можливо, також для інших систем. Цей модуль розширення розроблено відповідно до API ncurses, бібліотеки curses з відкритим кодом, розміщеної в Linux, і BSD-варіантів Unix.

Availability: not Android, not iOS, not WASI.

This module is not supported on mobile platforms or WebAssembly platforms.

This is an optional module. If it is missing from your copy of CPython, look for documentation from your distributor (that is, whoever provided Python to you). If you are the distributor, see Requirements for optional modules.

Availability: Unix.

Примітка

Кожного разу, коли в документації згадується символ, його можна вказати як ціле число, односимвольний рядок Unicode або однобайтовий рядок байтів.

Кожного разу, коли в документації згадується рядок символів, його можна вказати як рядок Unicode або рядок байтів.

Дивись також

Модуль curses.ascii

Утиліти для роботи з символами ASCII, незалежно від ваших налаштувань мови.

Модуль curses.panel

Розширення стеку панелей, яке додає глибини вікнам curses.

Модуль curses.textpad

Редагований текстовий віджет для curses, що підтримує Emacs-подібні прив’язки.

Програмування Curses на Python

Навчальний матеріал із використання curses у Python, Ендрю Кухлінг та Ерік Реймонд.

Функції

The module curses defines the following exception:

exception curses.error

Виняток виникає, коли функція бібліотеки curses повертає помилку.

Примітка

Щоразу, коли аргументи x або y для функції чи методу є необов’язковими, вони за замовчуванням вказують на поточне розташування курсора. Якщо attr є необов’язковим, за замовчуванням він A_NORMAL.

The module curses defines the following functions:

Initialization and termination

curses.initscr()

Ініціалізація бібліотеки. Повертає об’єкт window, який представляє весь екран.

See setupterm() for a caveat about calling it before this function.

Примітка

Якщо сталася помилка під час відкриття терміналу, базова бібліотека curses може спричинити вихід інтерпретатора.

curses.endwin()

Деініціалізуйте бібліотеку та поверніть термінал до нормального стану.

curses.isendwin()

Повертає True, якщо було викликано endwin() (тобто бібліотеку curses було деініціалізовано).

curses.newterm(type=None, fd=None, infd=None, /)

Initialize a new terminal in addition to the one initialized by initscr(), and return a screen for it. This allows a program to drive more than one terminal.

type is the terminal name, as in setupterm(); if None, the value of the TERM environment variable is used. fd and infd are the output and input files for the terminal: either a file object or a file descriptor. They default to sys.stdout and sys.stdin.

The new screen becomes the current one. Use set_term() to switch between screens.

See setupterm() for a caveat about calling it before this function.

Added in version 3.16.0a0 (unreleased).

curses.new_prescr()

Return a new screen that can be used to call functions that affect global state before initscr() or newterm() is called.

Availability: if the underlying curses library provides new_prescr().

Added in version 3.16.0a0 (unreleased).

curses.set_term(screen, /)

Make screen, a screen returned by newterm(), the current terminal, and return the previously current screen. Returns None if the previous screen was the one created by initscr().

Added in version 3.16.0a0 (unreleased).

curses.wrapper(func, /, *args, **kwargs)

Ініціалізуйте curses і викличте інший об’єкт, який можна викликати, func, який має бути рештою вашої програми, що використовує curses. Якщо програма викликає виняток, ця функція відновить термінал до працездатного стану перед тим, як повторно викликати виняток і створити зворотне відстеження. Викликаний об’єкт func потім передається головному вікну «stdscr» як перший аргумент, а потім будь-які інші аргументи, передані wrapper(). Перед викликом func wrapper() вмикає режим cbreak, вимикає відлуння, вмикає клавіатуру терміналу та ініціалізує кольори, якщо термінал підтримує кольори. Після виходу (звичайно чи за винятком) він відновлює режим приготування, вмикає відлуння та вимикає клавіатуру терміналу.

Terminal mode control

curses.def_prog_mode()

Збережіть поточний режим терміналу як режим «програми», режим, коли запущена програма використовує curses. (Його відповідником є режим «оболонки», коли програма не перебуває в curses.) Подальші виклики reset_prog_mode() відновлять цей режим.

curses.def_shell_mode()

Збережіть поточний режим терміналу як режим «оболонки», режим, коли запущена програма не використовує curses. (Його відповідником є «програмний» режим, коли програма використовує можливості curses.) Подальші виклики reset_shell_mode() відновлять цей режим.

curses.reset_prog_mode()

Відновіть термінал у «програмний» режим, який раніше зберіг def_prog_mode().

curses.reset_shell_mode()

Відновіть термінал у режим «оболонки», який раніше зберіг def_shell_mode().

curses.savetty()

Збережіть поточний стан режимів терміналу в буфері, який можна використовувати resetty().

curses.resetty()

Відновити стан режимів терміналу до того, яким він був під час останнього виклику savetty().

curses.curs_set(visibility)

Встановити стан курсору. видимість може бути встановлена на 0, 1 або 2, для невидимого, нормального або дуже видимого. Якщо термінал підтримує запитану видимість, повернути попередній стан курсору; інакше створіть виняток. На багатьох терміналах «видимий» режим — це підкреслений курсор, а «дуже видимий» — блоковий курсор.

curses.getsyx()

Повертає поточні координати віртуального екранного курсору як кортеж (y, x). Якщо leaveok наразі має значення True, тоді повертається (-1, -1).

curses.setsyx(y, x)

Встановіть віртуальний екранний курсор на y, x. Якщо y і x мають значення -1, тоді leaveok встановлюється True.

curses.doupdate()

Update the physical screen. The curses library keeps two data structures, one representing the current physical screen contents and a virtual screen representing the desired next state. The doupdate() function updates the physical screen to match the virtual screen.

Віртуальний екран може бути оновлений за допомогою виклику noutrefresh() після виконання операцій запису, таких як addstr() у вікні. Звичайний виклик refresh() — це просто noutrefresh(), за яким слідує doupdate(); якщо вам потрібно оновити кілька вікон, ви можете прискорити продуктивність і, можливо, зменшити мерехтіння екрана, виконуючи виклики noutrefresh() для всіх вікон, а потім один doupdate().

Input options

curses.cbreak()

Увійдіть у режим cbreak. У режимі cbreak (іноді його називають «рідкісним» режимом) звичайна буферизація рядка tty вимкнена, і символи доступні для читання по одному. Однак, на відміну від необробленого режиму, спеціальні символи (переривання, вихід, призупинення та керування потоком) зберігають свій вплив на драйвер tty та програму виклику. Виклик спочатку raw(), а потім cbreak() залишає термінал у режимі cbreak.

curses.nocbreak()

Вийти з режиму cbreak. Повернутися до звичайного режиму «приготування» з буферизацією рядків.

curses.echo()

Увійдіть в режим відлуння. У режимі відлуння кожен введений символ відтворюється на екрані під час введення.

curses.noecho()

Вийти з режиму відлуння. Ехо введених символів вимкнено.

curses.raw()

Увійдіть у режим raw. У необробленому режимі звичайна буферизація лінії та обробка клавіш переривання, виходу, призупинення та керування потоком вимкнено; символи представлені функціям введення curses один за одним.

curses.noraw()

Вийти з режиму raw. Повернутися до звичайного режиму «приготування» з буферизацією рядків.

curses.halfdelay(tenths)

Використовується для режиму половинної затримки, який подібний до режиму cbreak тим, що символи, введені користувачем, одразу стають доступними для програми. Однак після блокування протягом десятих десятих секунди, викликайте виняток, якщо нічого не було введено. Значення десятих має бути числом від «1» до «255». Використовуйте nocbreak(), щоб вийти з режиму половинної затримки.

curses.meta(flag)

Якщо flag має значення True, дозволяється введення 8-бітових символів. Якщо flag має значення False, дозволяйте лише 7-бітні символи.

curses.nl(flag=True)

Увійдіть у режим нового рядка. Цей режим перетворює клавішу повернення на новий рядок під час введення та перетворює новий рядок на повернення та переведення рядка під час виведення. Спочатку ввімкнено режим нового рядка.

If flag is False, the effect is the same as calling nonl().

curses.nonl()

Вийти з режиму нового рядка. Вимкнути переклад повернення на новий рядок під час введення та вимкнути низькорівневий переклад нового рядка на новий рядок/повернення на виході (але це не змінює поведінку addch('\n'), який завжди виконує еквівалент повернення та переклад рядка на віртуальному екрані). Якщо переклад вимкнено, прокляття іноді можуть трохи пришвидшити вертикальний рух; також він зможе виявити ключ повернення під час введення.

curses.intrflush(flag)

If flag is True, pressing an interrupt key (interrupt, break, or quit) will flush all output in the terminal driver queue. If flag is False, no flushing is done.

curses.qiflush([flag])

Якщо flag має значення False, ефект такий самий, як виклик noqiflush(). Якщо flag має значення True або аргумент не надано, черги будуть скинуті під час читання цих керуючих символів.

curses.noqiflush()

Коли використовується процедура noqiflush(), звичайне очищення черг введення та виведення, пов’язаних із символами INTR, QUIT і SUSP, не виконуватиметься. Ви можете викликати noqiflush() в обробнику сигналу, якщо ви бажаєте, щоб виведення продовжувалося так, ніби переривання не було, після завершення роботи обробника.

curses.typeahead(fd)

Вкажіть, що дескриптор файлу fd використовується для перевірки наперед. Якщо fd дорівнює -1, то попередня перевірка не виконується.

Бібліотека curses виконує «оптимізацію розриву рядків», періодично шукаючи попереднє введення під час оновлення екрана. Якщо вхідні дані знайдено, і вони надходять із tty, поточне оновлення відкладається до повторного виклику refresh або doupdate, що дозволяє швидше відповідати на команди, введені заздалегідь. Ця функція дозволяє вказати інший дескриптор файлу для попередньої перевірки.

curses.is_cbreak()

Return True if cbreak mode (see cbreak()) is enabled, False otherwise. Availability: ncurses 6.5 or later.

Added in version 3.16.0a0 (unreleased).

curses.is_echo()

Return True if echo mode (see echo()) is enabled, False otherwise. Availability: ncurses 6.5 or later.

Added in version 3.16.0a0 (unreleased).

curses.is_nl()

Return True if nl mode (see nl()) is enabled, False otherwise. Availability: ncurses 6.5 or later.

Added in version 3.16.0a0 (unreleased).

curses.is_raw()

Return True if raw mode (see raw()) is enabled, False otherwise. Availability: ncurses 6.5 or later.

Added in version 3.16.0a0 (unreleased).

Keyboard input

curses.ungetch(ch)

Push ch so the next getch() or get_wch() will return it.

ch may be an integer (a key code or character code), a byte, or a string of length 1. A one-character string is pushed like unget_wch(); on a narrow build it must encode to a single byte.

Примітка

Лише один ch можна ввести перед викликом getch().

Змінено в версії 3.16.0a0 (unreleased): A one-character string argument is no longer required to encode to a single byte, except on a narrow build.

curses.unget_wch(ch)

Натисніть ch, щоб наступний get_wch() повернув його.

Примітка

Лише один ch можна надіслати перед викликом get_wch().

Added in version 3.3.

Змінено в версії 3.16.0a0 (unreleased): Also available on a narrow build, where ch must encode to a single byte (an 8-bit locale).

curses.flushinp()

Очистити всі вхідні буфери. Це відкидає будь-яке попереднє введення, яке було введено користувачем і ще не було оброблено програмою.

curses.has_key(ch)

Візьміть значення ключа ch і поверніть True, якщо поточний тип терміналу розпізнає ключ із таким значенням.

curses.keyname(k)

Повертає назву ключа з номером k як об’єкт bytes. Назва ключа, що генерує друкований символ ASCII, є символом ключа. Ім’я комбінації клавіш керування — це двобайтовий байтовий об’єкт, що складається з каретки (b'^'), після якої йде відповідний друкований символ ASCII. Ім’я комбінації клавіш Alt (128–255) є об’єктом байтів, що складається з префікса b'M-'', за яким слідує назва відповідного символу ASCII.

Raise a ValueError if k is negative.

curses.define_key(definition, keycode)

Define an escape sequence definition, a string, as a key that generates the key code keycode, so that curses interprets it like one of the keys predefined in the terminal database.

If definition is None, any existing binding for keycode is removed. If keycode is zero or negative, any existing binding for definition is removed.

Added in version 3.16.0a0 (unreleased).

curses.key_defined(definition)

Return the key code bound to the escape sequence definition, a string, 0 if no key code is bound to it, or -1 if definition is a prefix of a longer bound sequence (and so is ambiguous).

Added in version 3.16.0a0 (unreleased).

curses.keyok(keycode, enable)

Enable (if enable is true) or disable (otherwise) interpretation of the key code keycode. Unlike window.keypad(), this affects a single key code rather than all of them.

Added in version 3.16.0a0 (unreleased).

Mouse

curses.getmouse()

Після того, як getch() повертає KEY_MOUSE, щоб повідомити про подію миші, цей метод слід викликати, щоб отримати подію миші в черзі, представлену як 5-кортеж (id, x, y, z, bstate). id – це значення ID, яке використовується для розрізнення кількох пристроїв, а x, y, z – це координати події. (z наразі не використовується.) bstate — це ціле число, біти якого будуть встановлені для вказівки типу події та будуть порозрядним АБО однієї чи кількох наступних констант, де n — кнопка число від 1 до 5: BUTTONn_PRESSED, BUTTONn_RELEASED, BUTTONn_CLICKED, BUTTONn_DOUBLE_LICKED, BUTTONn_TRIPLE_LICKED, BUTTON_SHIFT, BUTTON_CTRL, BUTTON_ALT.

Змінено в версії 3.10: Константи BUTTON5_* тепер доступні, якщо вони надані основною бібліотекою curses.

curses.ungetmouse(id, x, y, z, bstate)

Надішліть подію KEY_MOUSE до черги введення, пов’язавши з нею дані стану.

curses.mousemask(mousemask)

Set the mouse events to be reported, and return a tuple (availmask, oldmask). availmask indicates which of the specified mouse events can be reported; on complete failure it returns 0. oldmask is the previous value of the mouse event mask. If this function is never called, no mouse events are ever reported.

curses.mouseinterval(interval)

Set the maximum time in milliseconds that can elapse between press and release events in order for them to be recognized as a click, and return the previous interval value. The default value is 166 milliseconds, or one sixth of a second. Use a negative interval to obtain the interval value without changing it.

curses.has_mouse()

Return True if the mouse driver has been successfully initialized.

Availability: if the underlying curses library provides has_mouse().

Added in version 3.16.0a0 (unreleased).

колір

curses.start_color()

Необхідно викликати, якщо програміст хоче використовувати кольори, і перед викликом будь-якої іншої процедури маніпулювання кольором. Рекомендується викликати цю процедуру одразу після initscr().

start_color() initializes eight basic colors (black, red, green, yellow, blue, magenta, cyan, and white), and two global variables in the curses module, COLORS and COLOR_PAIRS, containing the maximum number of colors and color-pairs the terminal can support. It also restores the colors on the terminal to the values they had when the terminal was just turned on.

curses.has_colors()

Повертає True, якщо термінал може відображати кольори; інакше поверніть False.

curses.has_extended_color_support()

Return True if the module supports extended colors; otherwise, return False. Extended color support allows more than 256 color pairs for terminals that support more than 16 colors (for example, xterm-256color).

Розширена підтримка кольорів вимагає ncurses версії 6.1 або новішої.

Added in version 3.10.

curses.can_change_color()

Повертає True або False, залежно від того, чи може програміст змінювати кольори, що відображаються терміналом.

curses.init_color(color_number, r, g, b)

Change the definition of a color, taking the number of the color to be changed followed by three RGB values (for the amounts of red, green, and blue components). The value of color_number must be between 0 and COLORS - 1. Each of r, g, b, must be a value between 0 and 1000. When init_color() is used, all occurrences of that color on the screen immediately change to the new definition. This function is a no-op on most terminals; it is active only if can_change_color() returns True.

curses.color_content(color_number)

Return the intensity of the red, green, and blue (RGB) components in the color color_number, which must be between 0 and COLORS - 1. Return a 3-tuple, containing the R,G,B values for the given color, which will be between 0 (no component) and 1000 (maximum amount of component). Raise an exception if the color is not supported.

curses.init_pair(pair_number, fg, bg)

Change the definition of a color-pair. It takes three arguments: the number of the color-pair to be changed, the foreground color number, and the background color number. The value of pair_number must be between 1 and COLOR_PAIRS - 1 (the 0 color pair can only be changed by use_default_colors() and assume_default_colors()). The value of fg and bg arguments must be between 0 and COLORS - 1, or, after calling use_default_colors() or assume_default_colors(), -1. If the color-pair was previously initialized, the screen is refreshed and all occurrences of that color-pair are changed to the new definition.

curses.pair_content(pair_number)

Повертає кортеж (fg, bg), що містить кольори для запитаної пари кольорів. Значення pair_number має бути між 0 і COLOR_PAIRS - 1.

curses.color_pair(pair_number)

Return the attribute value for displaying text in the specified color pair. Only color pairs that fit in the color-pair field of the returned value can be represented (usually the first 256); a larger pair_number raises OverflowError rather than being silently masked to a different pair. Use color_set() or attr_set() to display higher pairs. This attribute value can be combined with A_STANDOUT, A_REVERSE, and the other A_* attributes. pair_number() is the counterpart to this function.

curses.pair_number(attr)

Повертає номер пари кольорів, заданий значенням атрибута attr. color_pair() є аналогом цієї функції.

curses.use_default_colors()

Equivalent to assume_default_colors(-1, -1).

curses.assume_default_colors(fg, bg, /)

Allow use of default values for colors on terminals supporting this feature. Use this to support transparency in your application.

• Assign terminal default foreground/background colors to color number -1. So init_pair(x, COLOR_RED, -1) will initialize pair x as red on default background and init_pair(x, -1, COLOR_BLUE) will initialize pair x as default foreground on blue.

• Change the definition of the color-pair 0 to (fg, bg).

This is an ncurses extension.

Added in version 3.14.

curses.alloc_pair(fg, bg)

Allocate a color pair for foreground color fg and background color bg, and return its number. If a color pair for the same combination of colors already exists, return its number. Otherwise allocate a new color pair and return its number.

This function is only available if Python was built against a wide-character version of the underlying curses library with extended-color support (see has_extended_color_support()).

Added in version 3.16.0a0 (unreleased).

curses.free_pair(pair_number)

Free the color pair pair_number, which must have been allocated by alloc_pair(). The pair must not be in use.

This function is only available if Python was built against a wide-character version of the underlying curses library with extended-color support (see has_extended_color_support()).

Added in version 3.16.0a0 (unreleased).

curses.find_pair(fg, bg)

Return the number of a color pair for foreground color fg and background color bg, or -1 if no color pair for this combination of colors has been allocated.

This function is only available if Python was built against a wide-character version of the underlying curses library with extended-color support (see has_extended_color_support()).

Added in version 3.16.0a0 (unreleased).

curses.reset_color_pairs()

Discard all color-pair definitions, releasing the color pairs allocated by init_pair() and alloc_pair().

This function is only available if Python was built against a wide-character version of the underlying curses library with extended-color support (see has_extended_color_support()).

Added in version 3.16.0a0 (unreleased).

Windows and pads

curses.newwin(nlines, ncols)

curses.newwin(nlines, ncols, begin_y, begin_x)

Повертає нове вікно, лівий верхній кут якого знаходиться в (begin_y, begin_x), а висота/ширина — nlines/ncols.

За замовчуванням вікно розширюється від зазначеної позиції до правого нижнього кута екрана.

curses.newpad(nlines, ncols)

Створіть і поверніть вказівник на нову структуру даних із заданою кількістю рядків і стовпців. Повертає блокнот як віконний об’єкт.

A pad is like a window, except that it is not restricted by the screen size, and is not necessarily associated with a particular part of the screen. Pads can be used when a large window is needed, and only a part of the window will be on the screen at one time. Automatic refreshes of pads (such as from scrolling or echoing of input) do not occur. The refresh() and noutrefresh() methods of a pad require 6 arguments to specify the part of the pad to be displayed and the location on the screen to be used for the display. The arguments are pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol; the p arguments refer to the upper-left corner of the pad region to be displayed and the s arguments define a clipping box on the screen within which the pad region is to be displayed.

Soft labels

The following functions manage soft-label keys, a row of labels displayed along the bottom line of the screen, typically used to label a row of function keys. slk_init() must be called before initscr() or newterm(); it takes one screen line away from the standard window for the labels.

curses.slk_init(fmt=0)

Reserve a screen line for the soft labels and choose their layout. fmt selects the arrangement: 0 for 3-2-3 (eight labels), 1 for 4-4 (eight labels). Where the underlying curses library supports them, 2 gives 4-4-4 (twelve labels) and 3 gives 4-4-4 with an index line.

Must be called before initscr() or newterm().

Added in version 3.16.0a0 (unreleased).

curses.slk_set(labnum, label, justify)

Set the text of soft label number labnum, in the range 1 through 8 (or 12 in a twelve-label layout). justify controls how label is placed within the label: 0 for left, 1 for centered, 2 for right.

Added in version 3.16.0a0 (unreleased).

curses.slk_label(labnum)

Return the current text of soft label number labnum, justified as it was set, or an empty string if it has no label.

Added in version 3.16.0a0 (unreleased).

curses.slk_refresh()

Update the soft labels on the physical screen, like refresh() for a window.

Added in version 3.16.0a0 (unreleased).

curses.slk_noutrefresh()

Update the soft labels on the virtual screen, like window.noutrefresh(). Use it together with doupdate() to batch screen updates.

Added in version 3.16.0a0 (unreleased).

curses.slk_clear()

Remove the soft labels from the screen.

Added in version 3.16.0a0 (unreleased).

curses.slk_restore()

Restore the soft labels to the screen after a slk_clear().

Added in version 3.16.0a0 (unreleased).

curses.slk_touch()

Force all the soft labels to be redrawn by the next slk_refresh() or slk_noutrefresh().

Added in version 3.16.0a0 (unreleased).

curses.slk_attron(attr)

curses.slk_attroff(attr)

curses.slk_attrset(attr)

Add, remove, or set the attributes used to display the soft labels, given as packed A_* attributes.

Added in version 3.16.0a0 (unreleased).

curses.slk_attr()

Return the current attributes of the soft labels as packed A_* attributes. Availability depends on the underlying curses library.

Added in version 3.16.0a0 (unreleased).

curses.slk_attr_on(attr)

curses.slk_attr_off(attr)

Turn the given attributes on or off without affecting any others. Like the attr_* window methods, these work with the WA_* attributes rather than packed A_* attributes.

Added in version 3.16.0a0 (unreleased).

curses.slk_attr_set(attr, pair=0)

Set the attributes and color pair of the soft labels. attr is given as WA_* attributes and pair as a color pair number.

Added in version 3.16.0a0 (unreleased).

curses.slk_color(pair)

Set the color pair of the soft labels to color pair number pair.

Added in version 3.16.0a0 (unreleased).

Saving and restoring

curses.getwin(file)

Read window-related data stored in the file by an earlier window.putwin() call. The routine then creates and initializes a new window using that data, returning the new window object. The file argument must be a file object opened for reading in binary mode.

curses.scr_dump(filename)

Write the current contents of the virtual screen to filename, which may be a string or a path-like object. The file can later be read by scr_restore(), scr_init() or scr_set(). This is the whole-screen counterpart of window.putwin().

Added in version 3.16.0a0 (unreleased).

curses.scr_restore(filename)

Set the virtual screen to the contents of filename, which must have been written by scr_dump(). The next call to doupdate() or window.refresh() restores the screen to those contents.

Added in version 3.16.0a0 (unreleased).

curses.scr_init(filename)

Initialize the assumed contents of the terminal from filename, which must have been written by scr_dump(). Use it when the terminal already displays those contents, for example after another program has drawn the screen, so that curses does not redraw what is already there.

Added in version 3.16.0a0 (unreleased).

curses.scr_set(filename)

Use filename, which must have been written by scr_dump(), as both the virtual screen and the assumed terminal contents. This combines the effects of scr_restore() and scr_init().

Added in version 3.16.0a0 (unreleased).

Querying the terminal

curses.baudrate()

Повертає вихідну швидкість терміналу в бітах за секунду. На програмних емуляторах терміналів воно матиме фіксоване високе значення. Включено з історичних причин; раніше він використовувався для запису циклів виведення для затримок часу та іноді для зміни інтерфейсів залежно від швидкості лінії.

curses.erasechar()

Return the user’s current erase character as a raw byte, a bytes object of length 1. See also erasewchar().

curses.erasewchar()

Return the user’s current erase character as a one-character str. Under Unix operating systems this is a property of the controlling tty of the curses program, and is not set by the curses library itself.

Added in version 3.16.0a0 (unreleased).

curses.killchar()

Return the user’s current line kill character as a raw byte, a bytes object of length 1. See also killwchar().

curses.killwchar()

Return the user’s current line kill character as a one-character str. Under Unix operating systems this is a property of the controlling tty of the curses program, and is not set by the curses library itself.

Added in version 3.16.0a0 (unreleased).

curses.termname()

Повертає значення змінної середовища TERM як об’єкт bytes, скорочений до 14 символів.

curses.longname()

Повертає об’єкт bytes, що містить поле довгої назви terminfo, що описує поточний термінал. Максимальна довжина докладного опису становить 128 символів. Він визначається лише після виклику initscr().

curses.termattrs()

Повертає логічне АБО всіх атрибутів відео, які підтримує термінал. Ця інформація корисна, коли програма curses потребує повного контролю над виглядом екрана.

curses.term_attrs()

Like termattrs(), but return the attributes as WA_* values rather than A_* values.

Added in version 3.16.0a0 (unreleased).

curses.has_ic()

Повертає True, якщо термінал має можливості вставляти та видаляти символи. Ця функція включена лише з історичних причин, оскільки всі сучасні програмні емулятори терміналу мають такі можливості.

curses.has_il()

Повертає True, якщо термінал має можливості вставляти та видаляти рядки або може імітувати їх за допомогою областей прокручування. Ця функція включена лише з історичних причин, оскільки всі сучасні програмні емулятори терміналу мають такі можливості.

Bell and screen flash

curses.beep()

Видайте короткий звук уваги.

curses.flash()

Спалах екрану. Тобто змініть його на зворотне відео, а потім знову змініть його через короткий проміжок часу. Деякі люди віддають перевагу «видимому дзвону» перед звуковим сигналом уваги, створюваним beep().

Terminal resizing

curses.resizeterm(nlines, ncols)

Змінює розміри стандартних і поточних вікон до вказаних розмірів і налаштовує інші облікові дані, які використовуються бібліотекою curses, яка записує розміри вікон (зокрема, обробник SIGWINCH).

curses.resize_term(nlines, ncols)

Функція серверної частини, яку використовує resizeterm(), виконує більшу частину роботи; під час зміни розміру вікна resize_term() заповнює порожніми області, які розширені. Додаток, що викликає, має заповнити ці області відповідними даними. Функція resize_term() намагається змінити розмір усіх вікон. Однак через правила виклику планшетів неможливо змінити їх розмір без додаткової взаємодії з програмою.

curses.is_term_resized(nlines, ncols)

Повертає True, якщо resize_term() змінює структуру вікна, False інакше.

curses.update_lines_cols()

Update the LINES and COLS module variables. Useful for detecting manual screen resize.

Added in version 3.5.

Terminfo database

curses.setupterm(term=None, fd=-1)

Ініціалізуйте термінал. термін - це рядок, що дає назву терміналу, або None; якщо опущено або None, буде використано значення змінної середовища TERM. fd — це дескриптор файлу, до якого будуть надіслані будь-які послідовності ініціалізації; якщо не вказано або -1, буде використано файловий дескриптор для sys.stdout.

Raise a curses.error if the terminal could not be found or its terminfo database entry could not be read. If the terminal has already been initialized, this function has no effect.

Примітка

Calling initscr() or newterm() after setupterm() leaks the terminal that setupterm() allocated: the curses library keeps only a single current terminal and does not free the previously allocated one.

curses.tigetflag(capname)

Повертає значення логічної можливості, що відповідає назві можливості terminfo capname як ціле число. Повертає значення -1, якщо capname не є логічною можливістю, або 0, якщо вона скасована або відсутня в описі терміналу.

setupterm() (or initscr()) must be called first.

curses.tigetnum(capname)

Повертає значення числової можливості, що відповідає назві можливості terminfo capname як ціле число. Повертає значення -2, якщо capname не є числовою можливістю, або -1, якщо вона скасована або відсутня в описі терміналу.

setupterm() (or initscr()) must be called first.

curses.tigetstr(capname)

Повертає значення можливості рядка, що відповідає назві можливості terminfo capname як об’єкт bytes. Повертає None, якщо capname не є «можливістю рядка terminfo», або його скасовано чи немає в описі терміналу.

setupterm() (or initscr()) must be called first.

curses.tparm(str[, ...])

Instantiate the bytes object str with the supplied parameters, where str should be a parameterized string obtained from the terminfo database. For example, tparm(tigetstr("cup"), 5, 3) could result in b'\033[6;4H', the exact result depending on terminal type. Up to nine integer parameters may be supplied.

setupterm() (or initscr()) must be called first.

curses.putp(str)

Еквівалент tputs(str, 1, putchar); видавати значення вказаної можливості terminfo для поточного терміналу. Зауважте, що вивід putp() завжди переходить у стандартний вивід.

setupterm() (or initscr()) must be called first.

Utilities

curses.unctrl(ch)

Return a bytes object which is a printable representation of the character ch. ch cannot be a character that does not fit in a single byte; use wunctrl() for those.

curses.wunctrl(ch)

Return a string which is a printable representation of the character ch; any attributes and color pair are ignored. ASCII control characters are represented as a caret followed by a character, for example as '^C'. Printing characters, including non-ASCII characters printable in the locale, are left as they are. The representation of other characters is defined by the underlying curses library.

Added in version 3.16.0a0 (unreleased).

curses.filter()

The filter() routine, if used, must be called before initscr() is called. The effect is that, during the initialization, LINES is set to 1; the capabilities clear, cup, cud, cud1, cuu1, cuu, vpa are disabled; and the home string is set to the value of cr. The effect is that the cursor is confined to the current line, and so are screen updates. This may be used for enabling character-at-a-time line editing without touching the rest of the screen.

curses.nofilter()

Undo the effect of a previous filter() call. Like filter(), it must be called before initscr() (or newterm()) so that the next initialization uses the full screen again.

Availability: if the underlying curses library provides nofilter().

Added in version 3.16.0a0 (unreleased).

curses.use_env(flag)

Якщо використовується, цю функцію слід викликати перед викликом initscr() або newterm. Якщо flag має значення False, використовуватимуться значення рядків і стовпців, указані в базі даних terminfo, навіть якщо встановлено змінні середовища LINES і COLUMNS (використовуються за умовчанням). , або якщо curses запущено у вікні (у цьому випадку типовою поведінкою буде використання розміру вікна, якщо LINES і COLUMNS не встановлено).

curses.get_escdelay()

Отримує значення, встановлене set_escdelay().

Added in version 3.9.

curses.set_escdelay(ms)

Встановлює кількість мілісекунд очікування після читання керуючого символу, щоб відрізнити окремий керуючий символ, введений на клавіатурі, від керуючих послідовностей, надісланих курсором і функціональними клавішами.

Added in version 3.9.

curses.get_tabsize()

Отримує значення, встановлене set_tabsize().

Added in version 3.9.

curses.set_tabsize(size)

Встановлює кількість стовпців, які використовуються бібліотекою curses під час перетворення символу табуляції на пробіли, коли вона додає табуляцію до вікна.

Added in version 3.9.

curses.napms(ms)

Сплячий режим на мс мілісекунди.

curses.delay_output(ms)

Вставте ms мілісекундну паузу у вивід.

Window objects

class curses.window

Об’єкти Window, які повертаються initscr() і newwin() вище, мають такі методи та атрибути:

Adding and inserting text

window.addch(ch[, attr])

window.addch(y, x, ch[, attr])

Зафарбувати символ ch у (y, x) за допомогою атрибутів attr, перезаписавши будь-який символ, попередньо намальований у цьому місці. За замовчуванням позиція символу та атрибути є поточними налаштуваннями об’єкта вікна.

ch may be a single character, optionally followed by combining characters, that together occupy one character cell.

Примітка

Writing outside the window, subwindow, or pad raises a curses.error. Attempting to write to the lower-right corner of a window, subwindow, or pad will cause an exception to be raised after the character is printed.

Змінено в версії 3.16.0a0 (unreleased): A character may now be given as a string of a base character followed by combining characters, instead of only a single character, or as a complexchar cell.

window.addstr(str[, attr])

window.addstr(y, x, str[, attr])

Зафарбуйте рядок символів str у (y, x) атрибутами attr, перезаписуючи все, що було раніше на дисплеї.

str may also be a complexstr, in which case each cell carries its own attributes and color pair, so attr must not be given. A complexstr obtained from in_wchstr() is written back unchanged.

Примітка

• Writing outside the window, subwindow, or pad raises curses.error. Attempting to write to the lower-right corner of a window, subwindow, or pad will cause an exception to be raised after the string is printed.

• A bug in ncurses, the backend for this Python module, could cause segfaults when resizing windows. This was fixed in ncurses-6.1-20190511. If you are stuck with an earlier ncurses, you can avoid triggering it by not calling addstr() with a str that has embedded newlines; instead, call addstr() separately for each line.

Змінено в версії 3.16.0a0 (unreleased): str may now also be a complexstr, as described above.

window.addnstr(str, n[, attr])

window.addnstr(y, x, str, n[, attr])

Зафарбуйте щонайбільше n символів рядка символів str у (y, x) з атрибутами attr, перезаписуючи все, що було раніше на дисплеї.

Змінено в версії 3.16.0a0 (unreleased): str may now also be a complexstr; see addstr().

window.echochar(ch[, attr])

Додайте символ ch з атрибутом attr і негайно викличте refresh() у вікні.

Змінено в версії 3.16.0a0 (unreleased): Wide and combining characters, and complexchar cells, are now accepted.

window.insch(ch[, attr])

window.insch(y, x, ch[, attr])

Insert character ch with attributes attr before the character under the cursor, or at (y, x) if specified. All characters to the right of the cursor are shifted one position right, with the rightmost character on the line being lost. The cursor position does not change.

Змінено в версії 3.16.0a0 (unreleased): Wide and combining characters, and complexchar cells, are now accepted.

window.insstr(str[, attr])

window.insstr(y, x, str[, attr])

Вставте рядок символів (стільки символів, скільки поміститься в рядку) перед символом під курсором. Усі символи праворуч від курсору зсуваються праворуч, а крайні праві символи в рядку втрачаються. Положення курсору не змінюється (після переходу на y, x, якщо вказано).

str may also be a complexstr, in which case each cell carries its own attributes and color pair, so attr must not be given.

Змінено в версії 3.16.0a0 (unreleased): str may now also be a complexstr, as described above.

window.insnstr(str, n[, attr])

window.insnstr(y, x, str, n[, attr])

Вставте рядок символів (стільки символів, скільки поміститься в рядку) перед символом під курсором, до n символів. Якщо n дорівнює нулю або від’ємне значення, вставляється весь рядок. Усі символи праворуч від курсору зсуваються праворуч, а крайні праві символи в рядку втрачаються. Положення курсору не змінюється (після переходу на y, x, якщо вказано).

Змінено в версії 3.16.0a0 (unreleased): str may now also be a complexstr; see insstr().

Deleting and inserting lines

window.delch([y, x])

Delete the character under the cursor, or at (y, x) if specified. All characters to the right on the same line are shifted one position left.

window.deleteln()

Видалити рядок під курсором. Усі наступні рядки переносяться на один рядок вгору.

window.insertln()

Вставте порожній рядок під курсором. Усі наступні рядки пересуваються на один рядок вниз.

window.insdelln(nlines)

Вставте рядки nlines у вказане вікно над поточним рядком. Нижні рядки nlines втрачені. Для негативних nlines видаліть nlines рядки, починаючи з того, що знаходиться під курсором, і перемістіть інші рядки вгору. Нижні рядки nlines очищаються. Поточна позиція курсору залишається незмінною.

Reading input

window.getch([y, x])

Get a character. Note that the integer returned does not have to be in ASCII range: function keys, keypad keys and so on are represented by numbers higher than 255. In no-delay mode, return -1 if there is no input, otherwise wait until a key is pressed. A multibyte character is returned as its encoded bytes one at a time; use get_wch() to read it as a single character.

window.get_wch([y, x])

Get a wide character. Return a character for most keys, or an integer for function keys, keypad keys, and other special keys. Unlike getch(), an ordinary key is returned as a one-character str. In no-delay mode, raise an exception if there is no input.

Added in version 3.3.

Змінено в версії 3.16.0a0 (unreleased): Also available on a narrow build, where only a character representable as a single byte (an 8-bit locale) can be returned.

window.getkey([y, x])

Отримати символ, повертаючи рядок замість цілого числа, як це робить getch(). Функціональні клавіші, клавіші клавіатури та інші спеціальні клавіші повертають багатобайтовий рядок, що містить назву клавіші. У режимі без затримки викликати виняток, якщо немає введення.

window.getstr()

window.getstr(n)

window.getstr(y, x)

window.getstr(y, x, n)

Read a bytes object from the user, with primitive line editing capacity. At most n characters are read; n defaults to and cannot exceed 2047. A multibyte character is returned as its encoded bytes; use get_wstr() to read the input as a str.

Змінено в версії 3.14: The maximum value for n was increased from 1023 to 2047.

window.get_wstr()

window.get_wstr(n)

window.get_wstr(y, x)

window.get_wstr(y, x, n)

Read a string from the user, with primitive line editing capacity. Unlike getstr(), it can return characters that are not representable in the window’s encoding. At most n characters are read; n defaults to and cannot exceed 2047.

Added in version 3.16.0a0 (unreleased).

window.getdelay()

Return the window’s read timeout in milliseconds, as set by nodelay() or timeout(): -1 for blocking, 0 for non-blocking, or a positive number of milliseconds.

Added in version 3.16.0a0 (unreleased).

Reading window contents

window.inch([y, x])

Return the character at the given position in the window. The bottom 8 bits are the character proper and the upper bits are the attributes; extract them with the A_CHARTEXT and A_ATTRIBUTES bit-masks, and the color pair with pair_number(). It cannot represent a cell holding combining characters, a character that does not fit in a single byte, or a color pair outside the color_pair() range; use in_wch() for those, which returns it as a complexchar.

window.in_wch([y, x])

Return the complex character at the given position in the window as a complexchar. Unlike inch(), the returned object carries the cell’s text (a spacing character optionally followed by combining characters) together with its attributes and color pair.

Added in version 3.16.0a0 (unreleased).

window.instr([n])

window.instr(y, x[, n])

Return a bytes object of characters, extracted from the window starting at the current cursor position, or at y, x if specified, and stopping at the end of the line. Attributes and color information are stripped from the characters. If n is specified, instr() returns a string at most n characters long (exclusive of the trailing NUL). The maximum value for n is 2047. A character not representable in the window’s encoding cannot be returned; use in_wstr() for those.

Змінено в версії 3.14: The maximum value for n was increased from 1023 to 2047.

window.in_wstr([n])

window.in_wstr(y, x[, n])

Return a string of characters, extracted from the window starting at the current cursor position, or at y, x if specified. Unlike instr(), it can return characters that are not representable in the window’s encoding. Attributes and color information are stripped from the characters. The maximum value for n is 2047.

Added in version 3.16.0a0 (unreleased).

window.in_wchstr([n])

window.in_wchstr(y, x[, n])

Return a complexstr of the styled cells extracted from the window starting at the current cursor position, or at y, x if specified, and stopping at the end of the line. This is the variant of instr() and in_wstr() that keeps each cell’s attributes and color pair (those methods strip the rendition). If n is specified, at most n cells are returned. The maximum value for n is 2047.

The result can be written back unchanged with addstr() (a read and a re-write is a round-trip that preserves every cell’s rendition).

Added in version 3.16.0a0 (unreleased).

Attributes

window.attroff(attr)

Видалити атрибут attr із набору «фон», застосованого до всіх записів у поточному вікні.

window.attron(attr)

Add attribute attr to the «background» set applied to all writes to the current window.

window.attrset(attr)

Встановіть для набору атрибутів «фон» значення attr. Цей набір початково 0 (без атрибутів).

window.attr_get()

Return the window’s current rendition as a (attrs, pair) tuple, where attrs is the set of attributes and pair is the color pair number.

Unlike attron() and friends, which take packed A_* attributes, this method and the other attr_* methods work with the WA_* attributes and keep the color pair as a separate number, which lets them use color pairs that do not fit alongside the attributes in a single value.

Added in version 3.16.0a0 (unreleased).

window.attr_set(attr, pair=0)

Set the window’s rendition to the attributes attr and the color pair pair.

Added in version 3.16.0a0 (unreleased).

window.attr_on(attr)

Turn on the attributes attr without affecting any others.

Added in version 3.16.0a0 (unreleased).

window.attr_off(attr)

Turn off the attributes attr without affecting any others.

Added in version 3.16.0a0 (unreleased).

window.color_set(pair)

Set the window’s color pair to pair, leaving the other attributes unchanged.

Added in version 3.16.0a0 (unreleased).

window.getattrs()

Return the window’s current attributes.

Added in version 3.16.0a0 (unreleased).

window.standout()

Увімкніть атрибут A_STANDOUT.

window.standend()

Вимкніть атрибут standout. На деяких терміналах це має побічним ефектом вимкнення всіх атрибутів.

window.chgat(attr)

window.chgat(num, attr)

window.chgat(y, x, attr)

window.chgat(y, x, num, attr)

Встановіть атрибути кількість символів у поточній позиції курсору або в позиції (y, x), якщо надається. Якщо num не вказано або має значення -1, атрибут буде встановлено для всіх символів до кінця рядка. Ця функція переміщує курсор у позицію (y, x), якщо вона надана. Змінений рядок буде торкнуто за допомогою методу touchline(), щоб вміст знову відображався під час наступного оновлення вікна.

Background

window.bkgd(ch[, attr])

Встановіть для властивості фону вікна символ ch з атрибутами attr. Потім зміни застосовуються до кожної позиції символу у цьому вікні:

• Атрибут кожного символу у вікні змінено на новий атрибут фону.

• Усюди, де з’являється попередній фоновий символ, він змінюється на новий фоновий символ.

Змінено в версії 3.16.0a0 (unreleased): Wide and combining characters, and complexchar cells, are now accepted.

window.bkgdset(ch[, attr])

Встановити фон вікна. Фон вікна складається з символу та будь-якої комбінації атрибутів. Атрибутна частина фону поєднується (оперується АБО) з усіма непробілами, які записуються у вікно. Частини фону символів і атрибутів поєднуються з порожніми символами. Фон стає властивістю символу та переміщується разом із символом під час будь-яких операцій прокручування та вставлення/видалення рядків/символів.

Змінено в версії 3.16.0a0 (unreleased): Wide and combining characters, and complexchar cells, are now accepted.

window.getbkgd()

Return the given window’s current background character/attribute pair. Its components can be extracted like those of inch(). It cannot represent a background set with a wide character or with a color pair outside the color_pair() range; use getbkgrnd() for those.

window.getbkgrnd()

Return the given window’s current background as a complexchar. Unlike getbkgd(), the returned object carries the background character together with its attributes and color pair, and the color pair is not limited to the value that fits in a color_pair().

Added in version 3.16.0a0 (unreleased).

Clearing and erasing

window.erase()

Очистіть вікно.

window.clear()

Подібно до erase(), але також призведе до перефарбування всього вікна під час наступного виклику refresh().

window.clrtobot()

Видалити від курсора до кінця вікна: усі рядки під курсором видаляються, а потім виконується еквівалент clrtoeol().

window.clrtoeol()

Стерти від курсора до кінця рядка.

Borders and lines

window.border([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])

Намалюйте рамку по краях вікна. Кожен параметр визначає символ для використання для певної частини рамки; дивіться таблицю нижче для більш детальної інформації.

Примітка

Значення 0 для будь-якого параметра призведе до використання символу за замовчуванням для цього параметра. Параметри ключових слів не можна використовувати. Значення за замовчуванням наведено в цій таблиці:

Параметр	опис	Значення за замовчуванням
ls	Ліва сторона	ACS_VLINE
rs	Права сторона	ACS_VLINE
ts	Топ	ACS_HLINE
bs	Дно	ACS_HLINE
tl	Лівий верхній кут	ACS_ULCORNER
tr	Правий верхній кут	ACS_URCORNER
bl	Нижній лівий кут	ACS_LLCORNER
br	Правий нижній кут	ACS_LRCORNER

Змінено в версії 3.16.0a0 (unreleased): Wide and combining characters, and complexchar cells, are now accepted. A single call cannot mix them with integer or byte characters.

window.box([vertch, horch])

Подібно до border(), але ls і rs є vertch, а ts і bs є horch. Ця функція завжди використовує стандартні кутові символи.

Змінено в версії 3.16.0a0 (unreleased): Wide and combining characters, and complexchar cells, are now accepted. A single call cannot mix them with integer or byte characters.

window.hline(ch, n[, attr])

window.hline(y, x, ch, n[, attr])

Display a horizontal line starting at (y, x) with length n consisting of the character ch with attributes attr. The line stops at the right edge of the window if fewer than n cells are available.

Змінено в версії 3.16.0a0 (unreleased): Wide and combining characters, and complexchar cells, are now accepted.

window.vline(ch, n[, attr])

window.vline(y, x, ch, n[, attr])

Display a vertical line starting at (y, x) with length n consisting of the character ch with attributes attr.

Змінено в версії 3.16.0a0 (unreleased): Wide and combining characters, and complexchar cells, are now accepted.

Cursor position and window geometry

window.move(new_y, new_x)

Перемістіть курсор до (новий_y, новий_x).

window.getyx()

Повертає кортеж (y, x) поточної позиції курсору відносно лівого верхнього кута вікна.

window.getbegyx()

Return a tuple (y, x) of coordinates of upper-left corner.

window.getmaxyx()

Повертає кортеж (y, x) висоти та ширини вікна.

window.getparyx()

Повертає початкові координати цього вікна відносно його батьківського вікна як кортеж (y, x). Повертає (-1, -1), якщо це вікно не має батьківського елемента.

window.getparent()

Return the parent window of this subwindow, or None if this window is not a subwindow.

Added in version 3.16.0a0 (unreleased).

Creating and resizing windows

window.subwin(begin_y, begin_x)

window.subwin(nlines, ncols, begin_y, begin_x)

Return a sub-window, whose upper-left corner is at the screen-relative coordinates (begin_y, begin_x), and whose width/height is ncols/nlines.

За замовчуванням підвікно розширюватиметься від зазначеної позиції до нижнього правого кута вікна.

window.derwin(begin_y, begin_x)

window.derwin(nlines, ncols, begin_y, begin_x)

Абревіатура від «вихідного вікна», derwin() — це те саме, що виклик subwin(), за винятком того, що begin_y і begin_x відносяться до джерела вікна, а не до всього екран. Повертає віконний об’єкт для похідного вікна.

window.subpad(begin_y, begin_x)

window.subpad(nlines, ncols, begin_y, begin_x)

Return a sub-pad, whose upper-left corner is at (begin_y, begin_x), and whose width/height is ncols/nlines. The coordinates are relative to the parent pad (unlike subwin(), which uses screen coordinates). This method is only available for pads created with newpad().

window.dupwin()

Return a new window that is an exact duplicate of the window: it has the same size, position, contents and attributes. Unlike a window created by subwin() or derwin(), the duplicate is independent of the original – it has its own cell buffer, so later changes to one do not affect the other.

Added in version 3.16.0a0 (unreleased).

window.mvwin(new_y, new_x)

Перемістіть вікно так, щоб його верхній лівий кут знаходився на (new_y, new_x).

Moving the window so that any part of it would be off the screen is an error: the window is not moved and curses.error is raised.

window.mvderwin(y, x)

Перемістити вікно всередину його батьківського вікна. Відносні до екрана параметри вікна не змінюються. Ця процедура використовується для відображення різних частин батьківського вікна в одній фізичній позиції на екрані.

window.resize(nlines, ncols)

Перерозподіліть сховище для вікна curses, щоб налаштувати його розміри до вказаних значень. Якщо будь-який з розмірів більший за поточні значення, дані вікна заповнюються пробілами, у яких об’єднано поточне фонове відтворення (як установлено bkgdset()).

Refreshing and redrawing

window.refresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])

Негайно оновіть дисплей (синхронізуйте фактичний екран із попередніми методами малювання/видалення).

The 6 arguments can only be specified, and are then required, when the window is a pad created with newpad(). The additional parameters are needed to indicate what part of the pad and screen are involved. pminrow and pmincol specify the upper-left corner of the rectangle to be displayed in the pad. sminrow, smincol, smaxrow, and smaxcol specify the edges of the rectangle to be displayed on the screen. The lower-right corner of the rectangle to be displayed in the pad is calculated from the screen coordinates, since the rectangles must be the same size. Both rectangles must be entirely contained within their respective structures. Negative values of pminrow, pmincol, sminrow, or smincol are treated as if they were zero.

window.noutrefresh()

window.noutrefresh(pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol)

Позначте для оновлення, але зачекайте. Ця функція оновлює структуру даних, що представляє потрібний стан вікна, але не примусово оновлює фізичний екран. Для цього викличте doupdate().

The 6 arguments can only be specified, and are then required, when the window is a pad created with newpad(); they have the same meaning as for refresh().

window.redrawln(beg, num)

Вказує, що num рядків екрана, починаючи з рядка beg, пошкоджені та мають бути повністю перемальовані під час наступного виклику refresh().

window.redrawwin()

Торкніться всього вікна, щоб його повністю перемалювати під час наступного виклику refresh().

Output options

window.clearok(flag)

Якщо flag має значення True, наступний виклик refresh() повністю очистить вікно.

window.idlok(flag)

If flag is True, curses will try to use hardware line editing facilities. Otherwise, curses will not use them.

window.idcok(flag)

Якщо flag має значення False, curses більше не розглядає використання апаратної функції вставки/видалення символів терміналу; якщо flag має значення True, увімкнено використання вставки та видалення символів. Коли curses вперше ініціалізовано, використання вставки/видалення символів увімкнено за замовчуванням.

window.immedok(flag)

Якщо flag має значення True, будь-яка зміна зображення вікна автоматично спричиняє оновлення вікна; вам більше не потрібно викликати refresh() самостійно. Однак це може значно погіршити продуктивність через повторні виклики оновлення. Цей параметр вимкнено за замовчуванням.

window.leaveok(flag)

If flag is True, cursor is left where it is on update, instead of being at «cursor position.» This reduces cursor movement where possible.

Якщо flag має значення False, курсор завжди буде в «положенні курсора» після оновлення.

window.scrollok(flag)

Керуйте тим, що відбувається, коли курсор вікна переміщується за межі вікна чи області прокручування в результаті дії нового рядка в нижньому рядку або введення останнього символу останнього рядка. Якщо flag має значення False, курсор залишається в нижньому рядку. Якщо flag має значення True, вікно прокручується на один рядок вгору. Зауважте, що для того, щоб отримати ефект фізичної прокрутки на терміналі, також необхідно викликати idlok().

window.scroll([lines=1])

Scroll the screen or scrolling region. Scroll upward by lines lines if lines is positive, or downward if it is negative. Scrolling has no effect unless it has been enabled for the window with scrollok().

window.setscrreg(top, bottom)

Встановіть область прокручування від рядка верхнього до рядка нижнього. Усі дії прокручування відбуватимуться в цьому регіоні.

window.getscrreg()

Return a tuple (top, bottom) of the window’s current scrolling region, as set by setscrreg().

Added in version 3.16.0a0 (unreleased).

window.syncok(flag)

Якщо flag має значення True, тоді syncup() викликається автоматично щоразу, коли відбувається зміна у вікні.

Input options

window.keypad(flag)

If flag is True, escape sequences generated by some keys (keypad, function keys) will be interpreted by curses. If flag is False, escape sequences will be left as is in the input stream.

window.nodelay(flag)

Якщо flag має значення True, getch() буде неблокуючим.

window.notimeout(flag)

Якщо flag має значення True, escape-послідовності не будуть вичерпані.

Якщо flag має значення False, через кілька мілісекунд escape-послідовність не буде інтерпретовано та залишиться у вхідному потоці як є.

window.timeout(delay)

Встановити блокуючу або неблокуючу поведінку читання для вікна. Якщо затримка має від’ємне значення, використовується блокування читання (що нескінченно чекатиме введення). Якщо затримка дорівнює нулю, то використовується неблокуюче читання, і getch() поверне -1, якщо введення не очікується. Якщо затримка позитивна, тоді getch() блокуватиметься на затримку мілісекунд і повертатиме -1, якщо в кінці цього часу все ще немає введення.

Overlapping and touch

window.overlay(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

Накладіть вікно поверх destwin. Вікна не обов’язково мають бути однакового розміру, копіюється лише область, що перекривається. Ця копія є неруйнівною, що означає, що поточний фоновий символ не перезаписує старий вміст destwin.

Щоб отримати детальний контроль над скопійованою областю, можна використовувати другу форму overlay(). sminrow і smincol — верхні ліві координати вікна джерела, а інші змінні позначають прямокутник у вікні призначення.

window.overwrite(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

Перезаписати вікно поверх destwin. Вікна не обов’язково мають бути однакового розміру, у цьому випадку копіюється лише область, що перекривається. Ця копія є деструктивною, що означає, що поточний фоновий символ перезаписує старий вміст destwin.

Щоб отримати детальний контроль над скопійованою областю, можна використати другу форму overwrite(). sminrow і smincol — верхні ліві координати вікна джерела, інші змінні позначають прямокутник у вікні призначення.

window.touchline(start, count[, changed])

Уявіть, що кількість рядків змінено, починаючи з рядка початок. Якщо вказано changed, це визначає, чи позначаються відповідні рядки як змінені (changed=True) чи незмінені (changed=False).

window.touchwin()

Уявіть, що все вікно було змінено з метою оптимізації малюнка.

window.untouchwin()

Позначте всі рядки у вікні як незмінні з часу останнього виклику refresh().

window.syncup()

Торкніться всіх розташувань у предках вікна, які були змінені у вікні.

window.syncdown()

Торкніться кожного місця у вікні, яке було торкано в будь-якому з попередніх вікон. Ця процедура викликається refresh(), тому майже ніколи не потрібно викликати її вручну.

window.cursyncup()

Оновити поточну позицію курсору всіх предків вікна, щоб відобразити поточну позицію курсору вікна.

Coordinate conversion

window.enclose(y, x)

Перевірте, чи задана пара координат символів клітинок, що відносяться до екрану, включена даним вікном, повертаючи True або False. Це корисно для визначення того, яка підмножина вікон екрана містить місце події миші.

Змінено в версії 3.10: Раніше він повертав 1 або 0 замість True або False.

window.mouse_trafo(y, x, to_screen)

Convert between window-relative and screen-relative (stdscr-relative) character-cell coordinates. If to_screen is true, convert the window-relative coordinates y, x to screen-relative coordinates; otherwise convert in the opposite direction. The two coordinate systems differ when lines are reserved on the screen, for example for soft labels.

Return the converted coordinates as a (y, x) tuple, or None if they lie outside the window.

Added in version 3.16.0a0 (unreleased).

Other

window.encoding

Encoding used to encode method arguments (Unicode strings and characters). The encoding attribute is inherited from the parent window when a subwindow is created, for example with window.subwin(). By default, current locale encoding is used (see locale.getencoding()).

Added in version 3.3.

window.putwin(file)

Запишіть усі дані, пов’язані з вікном, у наданий файловий об’єкт. Пізніше цю інформацію можна отримати за допомогою функції getwin().

window.use(func, /, *args, **kwargs)

Call func(window, *args, **kwargs) with the lock of the window held, and return its result. This provides automatic protection for the window against concurrent access from another thread.

Availability: if the underlying curses library provides use_window().

Added in version 3.16.0a0 (unreleased).

State queries

window.is_cleared()

Return the current value set by clearok().

Added in version 3.16.0a0 (unreleased).

window.is_idcok()

Return the current value set by idcok().

Added in version 3.16.0a0 (unreleased).

window.is_idlok()

Return the current value set by idlok().

Added in version 3.16.0a0 (unreleased).

window.is_immedok()

Return the current value set by immedok().

Added in version 3.16.0a0 (unreleased).

window.is_keypad()

Return the current value set by keypad().

Added in version 3.16.0a0 (unreleased).

window.is_leaveok()

Return the current value set by leaveok().

Added in version 3.16.0a0 (unreleased).

window.is_linetouched(line)

Повертає True, якщо вказаний рядок було змінено після останнього виклику refresh(); інакше повертає False. Викликати виняток curses.error, якщо рядок недійсний для даного вікна.

window.is_nodelay()

Return the current value set by nodelay().

Added in version 3.16.0a0 (unreleased).

window.is_notimeout()

Return the current value set by notimeout().

Added in version 3.16.0a0 (unreleased).

window.is_pad()

Return True if the window is a pad created by newpad().

Added in version 3.16.0a0 (unreleased).

window.is_scrollok()

Return the current value set by scrollok().

Added in version 3.16.0a0 (unreleased).

window.is_subwin()

Return True if the window is a subwindow created by subwin() or derwin().

Added in version 3.16.0a0 (unreleased).

window.is_syncok()

Return the current value set by syncok().

Added in version 3.16.0a0 (unreleased).

window.is_wintouched()

Повертає True, якщо вказане вікно було змінено після останнього виклику refresh(); інакше повертає False.

Screen objects

class curses.screen

A screen object represents a terminal initialized by newterm() (or new_prescr()), in addition to the default screen created by initscr(). Screen objects are returned by those functions; they cannot be instantiated directly.

A screen is freed automatically once it is no longer referenced, either directly or through one of its windows. Each window keeps its screen alive, so a screen remains valid as long as any of its windows does.

Added in version 3.16.0a0 (unreleased).

screen.close()

Detach the screen’s standard window, breaking the reference cycle between them so the screen can be reclaimed promptly instead of waiting for a garbage collection. Afterwards stdscr is None and the window it returned earlier can no longer be used. The screen’s resources are released once it and all its windows are no longer referenced.

Added in version 3.16.0a0 (unreleased).

screen.stdscr

The standard window of the screen, covering the whole terminal, or None for a screen created by new_prescr().

screen.use(func, /, *args, **kwargs)

Call func(screen, *args, **kwargs) with the lock of the screen held, and return its result. This provides automatic protection for the screen against concurrent access from another thread.

Availability: if the underlying curses library provides use_screen().

Added in version 3.16.0a0 (unreleased).

Complex character objects

class curses.complexchar(text, /, attr=0, pair=0)

A complex character (or complexchar) is an immutable styled character cell: a spacing character optionally followed by combining characters, together with a set of attributes and a color pair.

text is the cell’s text, attr a combination of the WA_* attributes (equivalent to the matching A_* constants), and pair a color pair number. Unlike the packed chtype used by inch() and the A_* methods, the color pair is stored separately and is not limited to the value that fits in a color_pair().

Complex characters are returned by window.in_wch() and window.getbkgrnd(), and are accepted (along with an integer, a byte or a string) by the character-cell methods such as window.addch(), window.insch(), window.bkgd(), window.border(), window.hline() and window.vline(). A complex character already carries its own rendition, so it cannot be combined with an explicit attr argument.

str() returns the cell’s text; two complex characters are equal when their text, attributes and color pair all match.

The same code works on both wide- and narrow-character builds. On a narrow build a cell holds a single character (no combining marks) that must encode to one byte in the window’s encoding (8-bit locales only), and pair is limited to the value that fits in a color_pair().

attr

The attributes of the character cell (read-only).

pair

The color pair number of the character cell (read-only).

Added in version 3.16.0a0 (unreleased).

class curses.complexstr(cells[, attr[, pair]])

A complex character string (or complexstr) is an immutable sequence of styled character cells – the string counterpart of complexchar (as str is to a single character).

If cells is a string, it is split into character cells (each a spacing character optionally followed by combining characters), and attr (a combination of the WA_* attributes) and pair (a color pair number), if given, are applied to every cell.

Otherwise cells is an iterable whose items are themselves cells, each a complexchar or a string; each item then carries its own rendition, and attr and pair must be omitted.

It is returned by window.in_wchstr(), and accepted by window.addstr(), addnstr(), insstr() and insnstr(), so a run read from a window can be written back unchanged.

It behaves like an immutable sequence: len(s) is the number of cells, s[i] is the i-th cell as a complexchar, slicing and concatenation produce new complexstr instances, and iterating yields the cells. str() returns the cells“ text joined together, and two complex character strings are equal when their cells all match. It is hashable.

To build or edit a run of cells, use an ordinary list of complexchar (or strings); a complexstr is the immutable form returned by a read.

Like complexchar, this type works on both wide- and narrow-character builds, with the same per-cell limitations on a narrow build.

Added in version 3.16.0a0 (unreleased).

Константи

General

The curses module defines the following data members:

curses.ERR

Деякі процедури curses, які повертають ціле число, наприклад getch(), повертають ERR у разі помилки.

curses.OK

Деякі процедури curses, які повертають ціле число, наприклад napms(), повертають OK після успіху.

curses.version

A bytes object representing the current version of the module.

curses.ncurses_version

Іменований кортеж, що містить три компоненти версії бібліотеки ncurses: major, minor і patch. Усі значення є цілими. До компонентів також можна отримати доступ за іменем, тому curses.ncurses_version[0] еквівалентно curses.ncurses_version.major і так далі.

Доступність: якщо використовується бібліотека ncurses.

Added in version 3.8.

curses.COLORS

The maximum number of colors the terminal can support. It is defined only after the call to start_color().

curses.COLOR_PAIRS

The maximum number of color pairs the terminal can support. It is defined only after the call to start_color().

curses.COLS

The width of the screen, that is, the number of columns. It is defined only after the call to initscr(). Updated by update_lines_cols(), resizeterm() and resize_term().

curses.LINES

The height of the screen, that is, the number of lines. It is defined only after the call to initscr(). Updated by update_lines_cols(), resizeterm() and resize_term().

Attributes

Деякі константи доступні для визначення атрибутів клітинок символів. Доступні точні константи залежать від системи.

Атрибут	Значення
curses.A_ALTCHARSET	Режим альтернативного набору символів
curses.A_BLINK	Режим моргання
curses.A_BOLD	Жирний режим
curses.A_DIM	Режим затемнення
curses.A_INVIS	Невидимий або порожній режим
curses.A_ITALIC	Курсив
curses.A_NORMAL	Нормальний атрибут
curses.A_PROTECT	Захищений режим
curses.A_REVERSE	Зворотні кольори фону та переднього плану
curses.A_STANDOUT	Режим видатного
curses.A_UNDERLINE	Режим підкреслення
curses.A_HORIZONTAL	Горизонтальне виділення
curses.A_LEFT	Виділення зліва
curses.A_LOW	Низьке виділення
curses.A_RIGHT	Виділіть праворуч
curses.A_TOP	Верхня підсвітка
curses.A_VERTICAL	Вертикальне виділення

Added in version 3.7: Додано A_ITALIC.

The attr_get(), attr_set(), attr_on() and attr_off() methods use a parallel set of WA_* constants. These have the same meaning as the corresponding A_* attributes above (WA_BOLD like A_BOLD, and so on), but belong to the attr_t type rather than being packed into a character. In ncurses the two sets share the same values, but other curses implementations may give them different ones, so use the WA_* constants with the attr_* methods. The available names are WA_ATTRIBUTES, WA_NORMAL, WA_STANDOUT, WA_UNDERLINE, WA_REVERSE, WA_BLINK, WA_DIM, WA_BOLD, WA_ALTCHARSET, WA_INVIS, WA_PROTECT, WA_HORIZONTAL, WA_LEFT, WA_LOW, WA_RIGHT, WA_TOP, WA_VERTICAL and WA_ITALIC (each available only where the platform defines it).

Added in version 3.16.0a0 (unreleased): The WA_* constants were added.

Для отримання відповідних атрибутів, які повертаються деякими методами, доступно кілька констант.

Біт-маска	Значення
curses.A_ATTRIBUTES	Бітова маска для вилучення атрибутів
curses.A_CHARTEXT	Бітова маска для вилучення символу
curses.A_COLOR	Бітова маска для отримання інформації про поле пари кольорів

Keys

На ключі посилаються цілі константи з іменами, що починаються з KEY_. Точні доступні клавіші залежать від системи.

Ключова константа	ключ
curses.KEY_MIN	Мінімальне значення ключа
curses.KEY_BREAK	Розривний ключ (ненадійний)
curses.KEY_DOWN	Стрілка вниз
curses.KEY_UP	Стрілка вгору
curses.KEY_LEFT	Стрілка вліво
curses.KEY_RIGHT	Стрілка вправо
curses.KEY_HOME	Клавіша «Додому» (стрілка вгору+ліворуч)
curses.KEY_BACKSPACE	Backspace (ненадійно)
curses.KEY_F0	Функціональні клавіші. Підтримується до 64 функціональних клавіш.
curses.KEY_Fn	Значення функціональної клавіші n
curses.KEY_DL	Видалити рядок
curses.KEY_IL	Вставити рядок
curses.KEY_DC	Видалити символ
curses.KEY_IC	Вставити символ або перейти в режим вставки
curses.KEY_EIC	Вийти з режиму вставки символів
curses.KEY_CLEAR	Очистити екран
curses.KEY_EOS	Очистити до кінця екрана
curses.KEY_EOL	Очистити до кінця рядка
curses.KEY_SF	Прокрутити на 1 рядок вперед
curses.KEY_SR	Прокрутити на 1 рядок назад (назад)
curses.KEY_NPAGE	Наступна сторінка
curses.KEY_PPAGE	Попередня сторінка
curses.KEY_STAB	Встановити вкладку
curses.KEY_CTAB	Очистити вкладку
curses.KEY_CATAB	Очистити всі вкладки
curses.KEY_ENTER	Введіть або надішліть (ненадійно)
curses.KEY_SRESET	М’яке (часткове) скидання (ненадійне)
curses.KEY_RESET	Скидання або апаратне скидання (ненадійно)
curses.KEY_PRINT	Роздрукувати
curses.KEY_LL	Головна внизу або внизу (внизу ліворуч)
curses.KEY_A1	Верхній лівий кут клавіатури
curses.KEY_A3	Правий верхній кут клавіатури
curses.KEY_B2	Центр клавіатури
curses.KEY_C1	Ліворуч внизу від клавіатури
curses.KEY_C3	Правий нижній кут клавіатури
curses.KEY_BTAB	Задня вкладка
curses.KEY_BEG	Бег (початок)
curses.KEY_CANCEL	Скасувати
curses.KEY_CLOSE	Закрити
curses.KEY_COMMAND	Cmd (команда)
curses.KEY_COPY	Копія
curses.KEY_CREATE	Створити
curses.KEY_END	Кінець
curses.KEY_EXIT	Вихід
curses.KEY_FIND	знайти
curses.KEY_HELP	Довідка
curses.KEY_MARK	Марк
curses.KEY_MESSAGE	повідомлення
curses.KEY_MOVE	рухатися
curses.KEY_NEXT	Далі
curses.KEY_OPEN	ВІДЧИНЕНО
curses.KEY_OPTIONS	Опції
curses.KEY_PREVIOUS	Prev (попередній)
curses.KEY_REDO	Повторити
curses.KEY_REFERENCE	Ref (посилання)
curses.KEY_REFRESH	Оновити
curses.KEY_REPLACE	Замінити
curses.KEY_RESTART	Перезапустіть
curses.KEY_RESUME	Резюме
curses.KEY_SAVE	зберегти
curses.KEY_SBEG	Зміщений початок (початок)
curses.KEY_SCANCEL	Скасування зі зсувом
curses.KEY_SCOMMAND	Зміщена команда
curses.KEY_SCOPY	Зміщена копія
curses.KEY_SCREATE	Зсув Створити
curses.KEY_SDC	Зміщений Видалити символ
curses.KEY_SDL	Зміщений рядок «Видалити».
curses.KEY_SELECT	Виберіть
curses.KEY_SEND	Зміщений кінець
curses.KEY_SEOL	Зміщена чиста лінія
curses.KEY_SEXIT	Зміщений вихід
curses.KEY_SFIND	Зміщений пошук
curses.KEY_SHELP	Зміщена довідка
curses.KEY_SHOME	Перенесено додому
curses.KEY_SIC	Зміщений вхід
curses.KEY_SLEFT	Зміщена стрілка вліво
curses.KEY_SMESSAGE	Зміщене повідомлення
curses.KEY_SMOVE	Зміщений хід
curses.KEY_SNEXT	Зсув Далі
curses.KEY_SOPTIONS	Зміщені параметри
curses.KEY_SPREVIOUS	Зміщено Поперед
curses.KEY_SPRINT	Зміщений друк
curses.KEY_SREDO	Зміщений повтор
curses.KEY_SREPLACE	Зміщена заміна
curses.KEY_SRIGHT	Зміщена стрілка вправо
curses.KEY_SRSUME	Зміщене резюме
curses.KEY_SSAVE	Зміщене збереження
curses.KEY_SSUSPEND	Зміщене призупинення
curses.KEY_SUNDO	Зміщене скасування
curses.KEY_SUSPEND	Призупинити
curses.KEY_UNDO	Скасувати
curses.KEY_MOUSE	Сталася подія миші
curses.KEY_RESIZE	Подія зміни розміру терміналу
curses.KEY_MAX	Максимальне значення ключа

On VT100s and their software emulations, such as X terminal emulators, there are normally at least four function keys (KEY_F1, KEY_F2, KEY_F3, KEY_F4) available, and the arrow keys mapped to KEY_UP, KEY_DOWN, KEY_LEFT and KEY_RIGHT in the obvious way. If your machine has a PC keyboard, it is safe to expect arrow keys and twelve function keys (older PC keyboards may have only ten function keys); also, the following keypad mappings are standard:

Клавіатура	Постійний
Insert	KEY_IC
Delete	KEY_DC
Home	KEY_HOME
End	KEY_END
Page Up	KEY_PPAGE
Page Down	KEY_NPAGE

Alternate character set

У наведеній нижче таблиці наведено символи з альтернативного набору символів. Вони успадковані від терміналу VT100 і, як правило, будуть доступні на програмних емуляціях, таких як термінали X. Якщо немає доступної графіки, curses повертається до грубого наближення для друку ASCII.

Примітка

Вони доступні лише після виклику initscr().

код ACS	Значення
curses.ACS_BBSS	alternate name for upper-right corner
curses.ACS_BLOCK	суцільний квадратний блок
curses.ACS_BOARD	дошка з квадратів
curses.ACS_BSBS	альтернативна назва горизонтальної лінії
curses.ACS_BSSB	alternate name for upper-left corner
curses.ACS_BSSS	альтернативна назва верхнього трійника
curses.ACS_BTEE	нижній трійник
curses.ACS_BULLET	куля
curses.ACS_CKBOARD	шашка (пунктир)
curses.ACS_DARROW	стрілка вниз
curses.ACS_DEGREE	символ ступеня
curses.ACS_DIAMOND	діамант
curses.ACS_GEQUAL	більший або рівний
curses.ACS_HLINE	горизонтальна лінія
curses.ACS_LANTERN	символ ліхтаря
curses.ACS_LARROW	стрілка вліво
curses.ACS_LEQUAL	менше або дорівнює
curses.ACS_LLCORNER	lower-left corner
curses.ACS_LRCORNER	lower-right corner
curses.ACS_LTEE	лівий трійник
curses.ACS_NEQUAL	знак нерівності
curses.ACS_PI	літера пі
curses.ACS_PLMINUS	знак плюс або мінус
curses.ACS_PLUS	великий плюс
curses.ACS_RARROW	стрілка вправо
curses.ACS_RTEE	правий трійник
curses.ACS_S1	сканувати рядок 1
curses.ACS_S3	рядок сканування 3
curses.ACS_S7	сканувати рядок 7
curses.ACS_S9	сканувати рядок 9
curses.ACS_SBBS	alternate name for lower-right corner
curses.ACS_SBSB	альтернативна назва для вертикальної лінії
curses.ACS_SBSS	альтернативна назва правого трійника
curses.ACS_SSBB	alternate name for lower-left corner
curses.ACS_SSBS	альтернативна назва нижнього трійника
curses.ACS_SSSB	альтернативна назва лівого трійника
curses.ACS_SSSS	альтернативна назва для кросовера або великий плюс
curses.ACS_STERLING	фунт стерлінгів
curses.ACS_TTEE	верхній трійник
curses.ACS_UARROW	стрілка вгору
curses.ACS_ULCORNER	upper-left corner
curses.ACS_URCORNER	upper-right corner
curses.ACS_VLINE	вертикальна лінія

Mouse buttons

The following table lists mouse button constants used by getmouse():

Mouse button constant	Значення
curses.BUTTONn_PRESSED	Mouse button n pressed
curses.BUTTONn_RELEASED	Mouse button n released
curses.BUTTONn_CLICKED	Mouse button n clicked
curses.BUTTONn_DOUBLE_CLICKED	Mouse button n double clicked
curses.BUTTONn_TRIPLE_CLICKED	Mouse button n triple clicked
curses.BUTTON_SHIFT	Shift was down during button state change
curses.BUTTON_CTRL	Control was down during button state change
curses.BUTTON_ALT	Alt was down during button state change

Змінено в версії 3.10: Константи BUTTON5_* тепер доступні, якщо вони надані основною бібліотекою curses.

Colors

У наведеній нижче таблиці перераховано попередньо визначені кольори:

Постійний	колір
curses.COLOR_BLACK	чорний
curses.COLOR_BLUE	Синій
curses.COLOR_CYAN	Блакитний (світло-зеленувато-блакитний)
curses.COLOR_GREEN	Зелений
curses.COLOR_MAGENTA	Маджента (багряно-червоний)
curses.COLOR_RED	Червоний
curses.COLOR_WHITE	Білий
curses.COLOR_YELLOW	Жовтий

curses.textpad — Text input widget for curses programs

The curses.textpad module provides a Textbox class that handles elementary text editing in a curses window, supporting a set of keybindings resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x, FrameMaker, and many other programs). The module also provides a rectangle-drawing function useful for framing text boxes or for other purposes.

The module curses.textpad defines the following function:

curses.textpad.rectangle(win, uly, ulx, lry, lrx)

Draw a rectangle. The first argument must be a window object; the remaining arguments are coordinates relative to that window. The second and third arguments are the y and x coordinates of the upper-left corner of the rectangle to be drawn; the fourth and fifth arguments are the y and x coordinates of the lower-right corner. The rectangle will be drawn using VT100/IBM PC forms characters on terminals that make this possible (including xterm and most other software terminal emulators). Otherwise it will be drawn with ASCII dashes, vertical bars, and plus signs.

Об’єкти текстового поля

Ви можете створити об’єкт Textbox наступним чином:

class curses.textpad.Textbox(win, insert_mode=False)

Return a textbox widget object. The win argument should be a curses window object in which the textbox is to be contained. If insert_mode is true, the textbox inserts typed characters, shifting existing text to the right, rather than overwriting it. The edit cursor of the textbox is initially located at the upper-left corner of the containing window, with coordinates (0, 0). The instance’s stripspaces flag is initially on.

Змінено в версії 3.16.0a0 (unreleased): Entering and reading back the full Unicode range, including combining characters, is now supported when curses is built with wide-character support.

Об’єкти Textbox мають такі методи:

edit(validate=None)

This is the entry point you will normally use. It accepts editing keystrokes until one of the termination keystrokes is entered. If validate is supplied, it must be a function. It will be called for each keystroke entered with the keystroke as a parameter; command dispatch is done on the result. If it returns a false value, the keystroke is ignored. This method returns the window contents as a string; whether blanks in the window are included is affected by the stripspaces attribute.

Змінено в версії 3.16.0a0 (unreleased): validate is now called with a non-ASCII character as a string; other keystrokes are still passed as an integer.

do_command(ch)

Process a single command keystroke. Returns 1 to continue editing, or 0 if a termination keystroke was processed. Here are the supported special keystrokes:

натискання клавіші	Дія
Control-A	Перейдіть до лівого краю вікна.
Control-B	Курсор ліворуч, перенесення на попередній рядок, якщо потрібно.
Control-D	Видалити символ під курсором.
Control-E	Перейдіть до правого краю (пробілі вимкнено) або кінець рядка (пробілі увімкнено).
Control-F	Курсор праворуч, перенесення на наступний рядок, якщо потрібно.
Control-G	Завершити, повернувши вміст вікна.
Control-H	Видалити символ назад.
Control-J	Terminate if the window is 1 line, otherwise move to the start of the next line.
Control-K	Якщо рядок порожній, видаліть його, інакше очистіть до кінця рядка.
Control-L	Оновити екран.
Control-N	Курсор вниз; переміститися на один рядок вниз.
Control-O	Вставте порожній рядок у місці курсора.
Control-P	Курсор вгору; переміститися на один рядок вгору.

Операції переміщення нічого не роблять, якщо курсор знаходиться на краю, де переміщення неможливе. За можливості підтримуються такі синоніми:

Постійний	натискання клавіші
KEY_LEFT	Control-B
KEY_RIGHT	Control-F
KEY_UP	Control-P
KEY_DOWN	Control-N
KEY_BACKSPACE	Control-h

Усі інші натискання клавіш сприймаються як команда вставити вказаний символ і переміститися вправо (з переносом рядка).

gather()

Повертає вміст вікна у вигляді рядка; член stripspaces впливає на те, чи будуть включені порожні місця у вікні.

stripspaces

Цей атрибут є прапорцем, який керує інтерпретацією прогалин у вікні. Коли його ввімкнено, пробіли в кінці кожного рядка ігноруються; будь-який рух курсору, який призведе до переходу курсора на порожнє місце в кінці, натомість переходить у кінець цього рядка, а кінцеві порожні місця видаляються, коли вміст вікна збирається.