curses — Terminal handling for character-cell displays

Source code: Lib/curses

---

Модуль curses надає інтерфейс до бібліотеки curses, де-факто стандарту для портативної розширеної обробки терміналів.

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

Примітка

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

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

Дивись також

Модуль curses.ascii

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

Модуль curses.panel

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

Модуль curses.textpad

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

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

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

The Tools/demo/ directory in the Python source distribution contains some example programs using the curses bindings provided by this module.

Функції

Модуль curses визначає такий виняток:

exception curses.error

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

Примітка

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

Модуль curses визначає такі функції:

curses.baudrate()

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

curses.beep()

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

curses.can_change_color()

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

curses.cbreak()

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

curses.color_content(color_number)

Повертає інтенсивність червоного, зеленого та синього (RGB) компонентів у кольорі color_number, який має бути між 0 і COLORS - 1. Повертає 3-кортеж, що містить значення R, G, B для заданого кольору, який буде між «0» (без компонента) і «1000» (максимальна кількість компонента).

curses.color_pair(pair_number)

Return the attribute value for displaying text in the specified color pair. Only the first 256 color pairs are supported. 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.curs_set(visibility)

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

curses.def_prog_mode()

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

curses.def_shell_mode()

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

curses.delay_output(ms)

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

curses.doupdate()

Оновіть фізичний екран. Бібліотека curses зберігає дві структури даних: одна представляє поточний фізичний вміст екрана, а віртуальний екран представляє бажаний наступний стан. Основа doupdate() оновлює фізичний екран відповідно до віртуального.

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

curses.echo()

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

curses.endwin()

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

curses.erasechar()

Повертає поточний символ стирання користувача як однобайтовий об’єкт байтів. В операційних системах Unix це властивість керуючого tty програми curses і не встановлюється самою бібліотекою curses.

curses.filter()

Процедуру filter(), якщо вона використовується, потрібно викликати перед викликом initscr(). Результат полягає в тому, що під час цих викликів LINES встановлюється на 1; вимкнено можливості clear, cup, cud1, cuu1, cuu, vpa; і рядок home має значення cr. Ефект полягає в тому, що курсор обмежено поточним рядком, а також оновлення екрана. Це можна використовувати для ввімкнення посимвольного редагування рядків, не торкаючись решти екрана.

curses.flash()

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

curses.flushinp()

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

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

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

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.

curses.has_colors()

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

curses.has_extended_color_support()

Повертає True, якщо модуль підтримує розширені кольори; інакше поверніть False. Розширена підтримка кольорів дозволяє використовувати більше 256 пар кольорів для терміналів, які підтримують більше 16 кольорів (наприклад, xterm-256color).

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

Нове в версії 3.10.

curses.has_ic()

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

curses.has_il()

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

curses.has_key(ch)

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

curses.halfdelay(tenths)

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

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.init_pair(pair_number, fg, bg)

Змініть визначення пари кольорів. Для цього потрібні три аргументи: номер пари кольорів, яку потрібно змінити, номер кольору переднього плану та номер кольору фону. Значення pair_number має бути між 1 і COLOR_PAIRS - 1 (пара кольорів 0 пов’язана з білим на чорному і не може бути змінена). Значення аргументів fg і bg має бути між 0 і COLORS - 1 або, після виклику use_default_colors(), -1. Якщо пара кольорів була раніше ініціалізована, екран оновлюється, і всі випадки цієї пари кольорів змінюються на нове визначення.

curses.initscr()

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

Примітка

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

curses.is_term_resized(nlines, ncols)

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

curses.isendwin()

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

curses.keyname(k)

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

curses.killchar()

Повертає поточний символ анулювання рядка користувача як однобайтовий байтовий об’єкт. В операційних системах Unix це властивість керуючого tty програми curses і не встановлюється самою бібліотекою curses.

curses.longname()

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

curses.meta(flag)

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

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 200 milliseconds, or one fifth of a second.

curses.mousemask(mousemask)

Встановіть події миші, про які потрібно повідомляти, і поверніть кортеж (availmask, oldmask). availmask вказує, про яку з указаних подій миші можна повідомити; у разі повної помилки повертає 0. oldmask — це попереднє значення маски події миші даного вікна. Якщо ця функція ніколи не викликається, жодні події миші не повідомляються.

curses.napms(ms)

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

curses.newpad(nlines, ncols)

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

Панель схожа на вікно, за винятком того, що вона не обмежена розміром екрана та не обов’язково пов’язана з певною частиною екрана. Підкладки можна використовувати, коли потрібне велике вікно, і на екрані одночасно буде лише частина вікна. Автоматичне оновлення панелей (наприклад, прокручування або відлуння введення) не відбувається. Методи панелі refresh() і noutrefresh() вимагають 6 аргументів для визначення частини панелі, яка буде відображатися, і місця на екрані, яке буде використовуватися для відображення. Аргументи: pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol; Аргументи p стосуються верхнього лівого кута області панелі, яка має відображатися, а аргументи s визначають рамку відсікання на екрані, в межах якої має відображатися область панелі.

curses.newwin(nlines, ncols)

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

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

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

curses.nl()

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

curses.nocbreak()

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

curses.noecho()

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

curses.nonl()

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

curses.noqiflush()

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

curses.noraw()

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

curses.pair_content(pair_number)

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

curses.pair_number(attr)

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

curses.putp(str)

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

curses.qiflush([flag])

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

curses.raw()

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

curses.reset_prog_mode()

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

curses.reset_shell_mode()

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

curses.resetty()

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

curses.resize_term(nlines, ncols)

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

curses.resizeterm(nlines, ncols)

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

curses.savetty()

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

curses.get_escdelay()

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

Нове в версії 3.9.

curses.set_escdelay(ms)

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

Нове в версії 3.9.

curses.get_tabsize()

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

Нове в версії 3.9.

curses.set_tabsize(size)

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

Нове в версії 3.9.

curses.setsyx(y, x)

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

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

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

curses.start_color()

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

start_color() ініціалізує вісім основних кольорів (чорний, червоний, зелений, жовтий, синій, пурпуровий, блакитний і білий) і дві глобальні змінні в модулі curses, COLORS і COLOR_PAIRS, що містить максимальну кількість кольорів і пар кольорів, які може підтримувати термінал. Він також відновлює кольори на терміналі до значень, які вони мали під час увімкнення терміналу.

curses.termattrs()

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

curses.termname()

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

curses.tigetflag(capname)

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

curses.tigetnum(capname)

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

curses.tigetstr(capname)

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

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

Створіть екземпляр об’єкта bytes str із наданими параметрами, де str має бути параметризованим рядком, отриманим із бази даних terminfo. наприклад tparm(tigetstr("cup"), 5, 3) може привести до b'\033[6;4H'', точний результат залежить від типу терміналу.

curses.typeahead(fd)

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

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

curses.unctrl(ch)

Повертає об’єкт bytes, який є представленням символу ch для друку. Керуючі символи представлені у вигляді каретки, за якою йде символ, наприклад b'^C'. Друковані символи залишаються без змін.

curses.ungetch(ch)

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

Примітка

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

curses.update_lines_cols()

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

Нове в версії 3.5.

curses.unget_wch(ch)

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

Примітка

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

Нове в версії 3.3.

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

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

curses.use_env(flag)

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

curses.use_default_colors()

Дозволити використовувати значення за замовчуванням для кольорів на терміналах, які підтримують цю функцію. Використовуйте це для підтримки прозорості у своїй програмі. Кольору за замовчуванням призначається номер кольору -1. Після виклику цієї функції init_pair(x, curses.COLOR_RED, -1) ініціалізує, наприклад, пару кольорів x червоним кольором переднього плану на фоні за замовчуванням.

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

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

Об’єкти вікна

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

window.addch(ch[, attr])

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

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

Примітка

Написання поза вікном, підвікном або блокнотом викликає curses.error. Спроба написати в нижньому правому куті вікна, підвікна або панелі призведе до виникнення виняткової ситуації після друку символу.

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

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

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

window.addstr(str[, attr])

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

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

Примітка

• Написання поза вікном, підвікном або блокнотом викликає curses.error. Спроба написати в нижньому правому куті вікна, підвікна або панелі призведе до виникнення виняткової ситуації після друку рядка.

• Помилка в ncurses, серверній частині цього модуля Python, може викликати SegFaults під час зміни розміру вікон. Це виправлено в ncurses-6.1-20190511. Якщо ви застрягли на попередній ncurses, ви можете уникнути цього, якщо не викличете addstr() з str, який має вбудовані символи нового рядка. Натомість викликайте addstr() окремо для кожного рядка.

window.attroff(attr)

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

window.attron(attr)

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

window.attrset(attr)

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

window.bkgd(ch[, attr])

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

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

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

window.bkgdset(ch[, attr])

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

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

window.box([vertch, horch])

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

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(), щоб вміст знову відображався під час наступного оновлення вікна.

window.clear()

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

window.clearok(flag)

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

window.clrtobot()

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

window.clrtoeol()

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

window.cursyncup()

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

window.delch([y, x])

Видаліть будь-який символ у (y, x).

window.deleteln()

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

window.derwin(begin_y, begin_x)

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

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

window.echochar(ch[, attr])

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

window.enclose(y, x)

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

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

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

Нове в версії 3.3.

window.erase()

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

window.getbegyx()

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

window.getbkgd()

Повертає поточну пару символ/атрибут тла даного вікна.

window.getch([y, x])

Отримати персонажа. Зауважте, що повернуте ціле число не має бути в діапазоні ASCII: функціональні клавіші, клавіші клавіатури тощо позначаються числами, вищими за 255. У режимі без затримки поверніть -1, якщо немає введення. , інакше зачекайте, доки не буде натиснуто клавішу.

window.get_wch([y, x])

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

Нове в версії 3.3.

window.getkey([y, x])

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

window.getmaxyx()

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

window.getparyx()

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

window.getstr()

window.getstr(n)

window.getstr(y, x)

window.getstr(y, x, n)

Читання байтового об’єкта від користувача з примітивною можливістю редагування рядків.

window.getyx()

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

window.hline(ch, n)

window.hline(y, x, ch, n)

Відобразити горизонтальну лінію, починаючи з (y, x) довжиною n, яка складається з символу ch.

window.idcok(flag)

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

window.idlok(flag)

Якщо flag має значення True, curses спробує використати апаратні засоби редагування рядків. В іншому випадку вставлення/видалення рядків буде вимкнено.

window.immedok(flag)

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

window.inch([y, x])

Повернути символ у задану позицію у вікні. Нижні 8 бітів є власне символом, а верхні біти є атрибутами.

window.insch(ch[, attr])

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

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

window.insdelln(nlines)

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

window.insertln()

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

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

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

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

window.insstr(str[, attr])

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

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

window.instr([n])

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

Повертає байтовий об’єкт із символами, отриманими з вікна, починаючи з поточної позиції курсору або з y, x, якщо вказано. Атрибути позбавлені символів. Якщо вказано n, instr() повертає рядок довжиною щонайбільше n символів (за винятком кінцевого NUL).

window.is_linetouched(line)

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

window.is_wintouched()

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

window.keypad(flag)

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

window.leaveok(flag)

Якщо flag має значення True, курсор залишається там, де він знаходиться під час оновлення, замість того, щоб бути в «положенні курсору». Це зменшує рух курсору, де це можливо. Якщо можливо, курсор буде зроблено невидимим.

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

window.move(new_y, new_x)

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

window.mvderwin(y, x)

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

window.mvwin(new_y, new_x)

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

window.nodelay(flag)

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

window.notimeout(flag)

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

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

window.noutrefresh()

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

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.putwin(file)

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

window.redrawln(beg, num)

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

window.redrawwin()

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

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

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

6 необов’язкових аргументів можна вказати лише тоді, коли вікно є панеллю, створеною за допомогою newpad(). Додаткові параметри потрібні, щоб вказати, яка частина панелі та екрану задіяна. pminrow і pmincol визначають верхній лівий кут прямокутника, який буде відображатися на панелі. sminrow, smincol, smaxrow і smaxcol визначають краї прямокутника, який буде відображатися на екрані. Правий нижній кут прямокутника, який відображатиметься на панелі, обчислюється за координатами на екрані, оскільки прямокутники мають бути однакового розміру. Обидва прямокутники мають повністю міститися у відповідних структурах. Від’ємні значення pminrow, pmincol, sminrow або smincol розглядаються як нульові.

window.resize(nlines, ncols)

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

window.scroll([lines=1])

Прокрутіть екран або область прокручування вгору на лінії лінії.

window.scrollok(flag)

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

window.setscrreg(top, bottom)

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

window.standend()

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

window.standout()

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

window.subpad(begin_y, begin_x)

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

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

window.subwin(begin_y, begin_x)

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

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

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

window.syncdown()

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

window.syncok(flag)

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

window.syncup()

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

window.timeout(delay)

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

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

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

window.touchwin()

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

window.untouchwin()

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

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.

Константи

Модуль curses визначає такі елементи даних:

curses.ERR

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

curses.OK

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

curses.version

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.

Нове в версії 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, i.e., 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, i.e., the number of lines. It is defined only after the call to initscr(). Updated by update_lines_cols(), resizeterm() and resize_term().

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

Атрибут	Значення
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	Вертикальне виділення

Нове в версії 3.7: Додано A_ITALIC.

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

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

На ключі посилаються цілі константи з іменами, що починаються з 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

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

Примітка

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

код ACS	Значення
curses.ACS_BBSS	альтернативна назва для верхнього правого кута
curses.ACS_BLOCK	суцільний квадратний блок
curses.ACS_BOARD	дошка з квадратів
curses.ACS_BSBS	альтернативна назва горизонтальної лінії
curses.ACS_BSSB	альтернативна назва для верхнього лівого кута
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	нижній лівий кут
curses.ACS_LRCORNER	нижній правий кут
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	альтернативна назва для нижнього правого кута
curses.ACS_SBSB	альтернативна назва для вертикальної лінії
curses.ACS_SBSS	альтернативна назва правого трійника
curses.ACS_SSBB	альтернативна назва для нижнього лівого кута
curses.ACS_SSBS	альтернативна назва нижнього трійника
curses.ACS_SSSB	альтернативна назва лівого трійника
curses.ACS_SSSS	альтернативна назва для кросовера або великий плюс
curses.ACS_STERLING	фунт стерлінгів
curses.ACS_TTEE	верхній трійник
curses.ACS_UARROW	стрілка вгору
curses.ACS_ULCORNER	верхній лівий кут
curses.ACS_URCORNER	верхній правий кут
curses.ACS_VLINE	вертикальна лінія

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	Control was down during button state change

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

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

Постійний	колір
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 — Віджет введення тексту для програм curses

Модуль curses.textpad надає клас Textbox, який обробляє елементарне редагування тексту у вікні curses, підтримуючи набір прив’язок клавіш, схожих на Emacs (тобто, також у Netscape Navigator, BBedit 6.x). , FrameMaker та багато інших програм). Модуль також надає функцію малювання прямокутника, корисну для обрамлення текстових полів або для інших цілей.

Модуль curses.textpad визначає таку функцію:

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

Намалюйте прямокутник. Першим аргументом має бути вікно; решта аргументів є координатами відносно цього вікна. Другим і третім аргументами є координати y і x верхнього лівого кута прямокутника, який буде намальовано; четвертий і п’ятий аргументи - це координати y і x у нижньому правому куті. Прямокутник буде намальовано за допомогою символів форм VT100/IBM PC на терміналах, які це роблять можливим (включаючи xterm та більшість інших програмних емуляторів терміналу). Інакше він буде намальований з дефісами ASCII, вертикальними смужками та знаками плюса.

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

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

class curses.textpad.Textbox(win)

Повертає об’єкт віджета текстового поля. Аргумент win має бути об’єктом curses window, у якому має міститися текстове поле. Курсор редагування текстового поля спочатку розташований у верхньому лівому куті вікна, що містить, із координатами (0, 0). Прапор stripspaces екземпляра спочатку ввімкнено.

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

edit([validator])

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

do_command(ch)

Обробка натискання однієї команди. Ось підтримувані спеціальні натискання клавіш:

натискання клавіші	Дія
Control-A	Перейдіть до лівого краю вікна.
Control-B	Курсор ліворуч, перенесення на попередній рядок, якщо потрібно.
Control-D	Видалити символ під курсором.
Control-E	Перейдіть до правого краю (пробілі вимкнено) або кінець рядка (пробілі увімкнено).
Control-F	Курсор праворуч, перенесення на наступний рядок, якщо потрібно.
Control-G	Завершити, повернувши вміст вікна.
Control-H	Видалити символ назад.
Control-J	Завершити, якщо вікно складається з 1 рядка, інакше вставити новий рядок.
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

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