2 :mod:`curses` --- Terminal handling for character-cell displays
3 ===============================================================
6 :synopsis: An interface to the curses library, providing portable terminal handling.
7 .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
8 .. sectionauthor:: Eric Raymond <esr@thyrsus.com>
11 .. versionchanged:: 1.6
12 Added support for the ``ncurses`` library and converted to a package.
14 The :mod:`curses` module provides an interface to the curses library, the
15 de-facto standard for portable advanced terminal handling.
17 While curses is most widely used in the Unix environment, versions are available
18 for DOS, OS/2, and possibly other systems as well. This extension module is
19 designed to match the API of ncurses, an open-source curses library hosted on
20 Linux and the BSD variants of Unix.
24 Since version 5.4, the ncurses library decides how to interpret non-ASCII data
25 using the ``nl_langinfo`` function. That means that you have to call
26 :func:`locale.setlocale` in the application and encode Unicode strings
27 using one of the system's available encodings. This example uses the
28 system's default encoding::
31 locale.setlocale(locale.LC_ALL, '')
32 code = locale.getpreferredencoding()
34 Then use *code* as the encoding for :meth:`str.encode` calls.
38 Module :mod:`curses.ascii`
39 Utilities for working with ASCII characters, regardless of your locale settings.
41 Module :mod:`curses.panel`
42 A panel stack extension that adds depth to curses windows.
44 Module :mod:`curses.textpad`
45 Editable text widget for curses supporting :program:`Emacs`\ -like bindings.
47 Module :mod:`curses.wrapper`
48 Convenience function to ensure proper terminal setup and resetting on
49 application entry and exit.
52 Tutorial material on using curses with Python, by Andrew Kuchling and Eric
55 The :file:`Demo/curses/` directory in the Python source distribution contains
56 some example programs using the curses bindings provided by this module.
64 The module :mod:`curses` defines the following exception:
69 Exception raised when a curses library function returns an error.
73 Whenever *x* or *y* arguments to a function or a method are optional, they
74 default to the current cursor location. Whenever *attr* is optional, it defaults
77 The module :mod:`curses` defines the following functions:
80 .. function:: baudrate()
82 Returns the output speed of the terminal in bits per second. On software
83 terminal emulators it will have a fixed high value. Included for historical
84 reasons; in former times, it was used to write output loops for time delays and
85 occasionally to change interfaces depending on the line speed.
90 Emit a short attention sound.
93 .. function:: can_change_color()
95 Returns true or false, depending on whether the programmer can change the colors
96 displayed by the terminal.
99 .. function:: cbreak()
101 Enter cbreak mode. In cbreak mode (sometimes called "rare" mode) normal tty
102 line buffering is turned off and characters are available to be read one by one.
103 However, unlike raw mode, special characters (interrupt, quit, suspend, and flow
104 control) retain their effects on the tty driver and calling program. Calling
105 first :func:`raw` then :func:`cbreak` leaves the terminal in cbreak mode.
108 .. function:: color_content(color_number)
110 Returns the intensity of the red, green, and blue (RGB) components in the color
111 *color_number*, which must be between ``0`` and :const:`COLORS`. A 3-tuple is
112 returned, containing the R,G,B values for the given color, which will be between
113 ``0`` (no component) and ``1000`` (maximum amount of component).
116 .. function:: color_pair(color_number)
118 Returns the attribute value for displaying text in the specified color. This
119 attribute value can be combined with :const:`A_STANDOUT`, :const:`A_REVERSE`,
120 and the other :const:`A_\*` attributes. :func:`pair_number` is the counterpart
124 .. function:: curs_set(visibility)
126 Sets the cursor state. *visibility* can be set to 0, 1, or 2, for invisible,
127 normal, or very visible. If the terminal supports the visibility requested, the
128 previous cursor state is returned; otherwise, an exception is raised. On many
129 terminals, the "visible" mode is an underline cursor and the "very visible" mode
133 .. function:: def_prog_mode()
135 Saves the current terminal mode as the "program" mode, the mode when the running
136 program is using curses. (Its counterpart is the "shell" mode, for when the
137 program is not in curses.) Subsequent calls to :func:`reset_prog_mode` will
141 .. function:: def_shell_mode()
143 Saves the current terminal mode as the "shell" mode, the mode when the running
144 program is not using curses. (Its counterpart is the "program" mode, when the
145 program is using curses capabilities.) Subsequent calls to
146 :func:`reset_shell_mode` will restore this mode.
149 .. function:: delay_output(ms)
151 Inserts an *ms* millisecond pause in output.
154 .. function:: doupdate()
156 Update the physical screen. The curses library keeps two data structures, one
157 representing the current physical screen contents and a virtual screen
158 representing the desired next state. The :func:`doupdate` ground updates the
159 physical screen to match the virtual screen.
161 The virtual screen may be updated by a :meth:`noutrefresh` call after write
162 operations such as :meth:`addstr` have been performed on a window. The normal
163 :meth:`refresh` call is simply :meth:`noutrefresh` followed by :func:`doupdate`;
164 if you have to update multiple windows, you can speed performance and perhaps
165 reduce screen flicker by issuing :meth:`noutrefresh` calls on all windows,
166 followed by a single :func:`doupdate`.
171 Enter echo mode. In echo mode, each character input is echoed to the screen as
175 .. function:: endwin()
177 De-initialize the library, and return terminal to normal status.
180 .. function:: erasechar()
182 Returns the user's current erase character. Under Unix operating systems this
183 is a property of the controlling tty of the curses program, and is not set by
184 the curses library itself.
187 .. function:: filter()
189 The :func:`filter` routine, if used, must be called before :func:`initscr` is
190 called. The effect is that, during those calls, LINES is set to 1; the
191 capabilities clear, cup, cud, cud1, cuu1, cuu, vpa are disabled; and the home
192 string is set to the value of cr. The effect is that the cursor is confined to
193 the current line, and so are screen updates. This may be used for enabling
194 character-at-a-time line editing without touching the rest of the screen.
197 .. function:: flash()
199 Flash the screen. That is, change it to reverse-video and then change it back
200 in a short interval. Some people prefer such as 'visible bell' to the audible
201 attention signal produced by :func:`beep`.
204 .. function:: flushinp()
206 Flush all input buffers. This throws away any typeahead that has been typed
207 by the user and has not yet been processed by the program.
210 .. function:: getmouse()
212 After :meth:`getch` returns :const:`KEY_MOUSE` to signal a mouse event, this
213 method should be call to retrieve the queued mouse event, represented as a
214 5-tuple ``(id, x, y, z, bstate)``. *id* is an ID value used to distinguish
215 multiple devices, and *x*, *y*, *z* are the event's coordinates. (*z* is
216 currently unused.). *bstate* is an integer value whose bits will be set to
217 indicate the type of event, and will be the bitwise OR of one or more of the
218 following constants, where *n* is the button number from 1 to 4:
219 :const:`BUTTONn_PRESSED`, :const:`BUTTONn_RELEASED`, :const:`BUTTONn_CLICKED`,
220 :const:`BUTTONn_DOUBLE_CLICKED`, :const:`BUTTONn_TRIPLE_CLICKED`,
221 :const:`BUTTON_SHIFT`, :const:`BUTTON_CTRL`, :const:`BUTTON_ALT`.
224 .. function:: getsyx()
226 Returns the current coordinates of the virtual screen cursor in y and x. If
227 leaveok is currently true, then -1,-1 is returned.
230 .. function:: getwin(file)
232 Reads window related data stored in the file by an earlier :func:`putwin` call.
233 The routine then creates and initializes a new window using that data, returning
234 the new window object.
237 .. function:: has_colors()
239 Returns true if the terminal can display colors; otherwise, it returns false.
242 .. function:: has_ic()
244 Returns true if the terminal has insert- and delete- character capabilities.
245 This function is included for historical reasons only, as all modern software
246 terminal emulators have such capabilities.
249 .. function:: has_il()
251 Returns true if the terminal has insert- and delete-line capabilities, or can
252 simulate them using scrolling regions. This function is included for
253 historical reasons only, as all modern software terminal emulators have such
257 .. function:: has_key(ch)
259 Takes a key value *ch*, and returns true if the current terminal type recognizes
260 a key with that value.
263 .. function:: halfdelay(tenths)
265 Used for half-delay mode, which is similar to cbreak mode in that characters
266 typed by the user are immediately available to the program. However, after
267 blocking for *tenths* tenths of seconds, an exception is raised if nothing has
268 been typed. The value of *tenths* must be a number between 1 and 255. Use
269 :func:`nocbreak` to leave half-delay mode.
272 .. function:: init_color(color_number, r, g, b)
274 Changes the definition of a color, taking the number of the color to be changed
275 followed by three RGB values (for the amounts of red, green, and blue
276 components). The value of *color_number* must be between ``0`` and
277 :const:`COLORS`. Each of *r*, *g*, *b*, must be a value between ``0`` and
278 ``1000``. When :func:`init_color` is used, all occurrences of that color on the
279 screen immediately change to the new definition. This function is a no-op on
280 most terminals; it is active only if :func:`can_change_color` returns ``1``.
283 .. function:: init_pair(pair_number, fg, bg)
285 Changes the definition of a color-pair. It takes three arguments: the number of
286 the color-pair to be changed, the foreground color number, and the background
287 color number. The value of *pair_number* must be between ``1`` and
288 ``COLOR_PAIRS - 1`` (the ``0`` color pair is wired to white on black and cannot
289 be changed). The value of *fg* and *bg* arguments must be between ``0`` and
290 :const:`COLORS`. If the color-pair was previously initialized, the screen is
291 refreshed and all occurrences of that color-pair are changed to the new
295 .. function:: initscr()
297 Initialize the library. Returns a :class:`WindowObject` which represents the
302 If there is an error opening the terminal, the underlying curses library may
303 cause the interpreter to exit.
306 .. function:: isendwin()
308 Returns true if :func:`endwin` has been called (that is, the curses library has
312 .. function:: keyname(k)
314 Return the name of the key numbered *k*. The name of a key generating printable
315 ASCII character is the key's character. The name of a control-key combination
316 is a two-character string consisting of a caret followed by the corresponding
317 printable ASCII character. The name of an alt-key combination (128-255) is a
318 string consisting of the prefix 'M-' followed by the name of the corresponding
322 .. function:: killchar()
324 Returns the user's current line kill character. Under Unix operating systems
325 this is a property of the controlling tty of the curses program, and is not set
326 by the curses library itself.
329 .. function:: longname()
331 Returns a string containing the terminfo long name field describing the current
332 terminal. The maximum length of a verbose description is 128 characters. It is
333 defined only after the call to :func:`initscr`.
336 .. function:: meta(yes)
338 If *yes* is 1, allow 8-bit characters to be input. If *yes* is 0, allow only
342 .. function:: mouseinterval(interval)
344 Sets the maximum time in milliseconds that can elapse between press and release
345 events in order for them to be recognized as a click, and returns the previous
346 interval value. The default value is 200 msec, or one fifth of a second.
349 .. function:: mousemask(mousemask)
351 Sets the mouse events to be reported, and returns a tuple ``(availmask,
352 oldmask)``. *availmask* indicates which of the specified mouse events can be
353 reported; on complete failure it returns 0. *oldmask* is the previous value of
354 the given window's mouse event mask. If this function is never called, no mouse
355 events are ever reported.
358 .. function:: napms(ms)
360 Sleep for *ms* milliseconds.
363 .. function:: newpad(nlines, ncols)
365 Creates and returns a pointer to a new pad data structure with the given number
366 of lines and columns. A pad is returned as a window object.
368 A pad is like a window, except that it is not restricted by the screen size, and
369 is not necessarily associated with a particular part of the screen. Pads can be
370 used when a large window is needed, and only a part of the window will be on the
371 screen at one time. Automatic refreshes of pads (such as from scrolling or
372 echoing of input) do not occur. The :meth:`refresh` and :meth:`noutrefresh`
373 methods of a pad require 6 arguments to specify the part of the pad to be
374 displayed and the location on the screen to be used for the display. The
375 arguments are pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol; the p
376 arguments refer to the upper left corner of the pad region to be displayed and
377 the s arguments define a clipping box on the screen within which the pad region
381 .. function:: newwin([nlines, ncols,] begin_y, begin_x)
383 Return a new window, whose left-upper corner is at ``(begin_y, begin_x)``, and
384 whose height/width is *nlines*/*ncols*.
386 By default, the window will extend from the specified position to the lower
387 right corner of the screen.
392 Enter newline mode. This mode translates the return key into newline on input,
393 and translates newline into return and line-feed on output. Newline mode is
397 .. function:: nocbreak()
399 Leave cbreak mode. Return to normal "cooked" mode with line buffering.
402 .. function:: noecho()
404 Leave echo mode. Echoing of input characters is turned off.
409 Leave newline mode. Disable translation of return into newline on input, and
410 disable low-level translation of newline into newline/return on output (but this
411 does not change the behavior of ``addch('\n')``, which always does the
412 equivalent of return and line feed on the virtual screen). With translation
413 off, curses can sometimes speed up vertical motion a little; also, it will be
414 able to detect the return key on input.
417 .. function:: noqiflush()
419 When the noqiflush routine is used, normal flush of input and output queues
420 associated with the INTR, QUIT and SUSP characters will not be done. You may
421 want to call :func:`noqiflush` in a signal handler if you want output to
422 continue as though the interrupt had not occurred, after the handler exits.
425 .. function:: noraw()
427 Leave raw mode. Return to normal "cooked" mode with line buffering.
430 .. function:: pair_content(pair_number)
432 Returns a tuple ``(fg, bg)`` containing the colors for the requested color pair.
433 The value of *pair_number* must be between ``1`` and ``COLOR_PAIRS - 1``.
436 .. function:: pair_number(attr)
438 Returns the number of the color-pair set by the attribute value *attr*.
439 :func:`color_pair` is the counterpart to this function.
442 .. function:: putp(string)
444 Equivalent to ``tputs(str, 1, putchar)``; emits the value of a specified
445 terminfo capability for the current terminal. Note that the output of putp
446 always goes to standard output.
449 .. function:: qiflush( [flag] )
451 If *flag* is false, the effect is the same as calling :func:`noqiflush`. If
452 *flag* is true, or no argument is provided, the queues will be flushed when
453 these control characters are read.
458 Enter raw mode. In raw mode, normal line buffering and processing of
459 interrupt, quit, suspend, and flow control keys are turned off; characters are
460 presented to curses input functions one by one.
463 .. function:: reset_prog_mode()
465 Restores the terminal to "program" mode, as previously saved by
466 :func:`def_prog_mode`.
469 .. function:: reset_shell_mode()
471 Restores the terminal to "shell" mode, as previously saved by
472 :func:`def_shell_mode`.
475 .. function:: setsyx(y, x)
477 Sets the virtual screen cursor to *y*, *x*. If *y* and *x* are both -1, then
481 .. function:: setupterm([termstr, fd])
483 Initializes the terminal. *termstr* is a string giving the terminal name; if
484 omitted, the value of the TERM environment variable will be used. *fd* is the
485 file descriptor to which any initialization sequences will be sent; if not
486 supplied, the file descriptor for ``sys.stdout`` will be used.
489 .. function:: start_color()
491 Must be called if the programmer wants to use colors, and before any other color
492 manipulation routine is called. It is good practice to call this routine right
493 after :func:`initscr`.
495 :func:`start_color` initializes eight basic colors (black, red, green, yellow,
496 blue, magenta, cyan, and white), and two global variables in the :mod:`curses`
497 module, :const:`COLORS` and :const:`COLOR_PAIRS`, containing the maximum number
498 of colors and color-pairs the terminal can support. It also restores the colors
499 on the terminal to the values they had when the terminal was just turned on.
502 .. function:: termattrs()
504 Returns a logical OR of all video attributes supported by the terminal. This
505 information is useful when a curses program needs complete control over the
506 appearance of the screen.
509 .. function:: termname()
511 Returns the value of the environment variable TERM, truncated to 14 characters.
514 .. function:: tigetflag(capname)
516 Returns the value of the Boolean capability corresponding to the terminfo
517 capability name *capname*. The value ``-1`` is returned if *capname* is not a
518 Boolean capability, or ``0`` if it is canceled or absent from the terminal
522 .. function:: tigetnum(capname)
524 Returns the value of the numeric capability corresponding to the terminfo
525 capability name *capname*. The value ``-2`` is returned if *capname* is not a
526 numeric capability, or ``-1`` if it is canceled or absent from the terminal
530 .. function:: tigetstr(capname)
532 Returns the value of the string capability corresponding to the terminfo
533 capability name *capname*. ``None`` is returned if *capname* is not a string
534 capability, or is canceled or absent from the terminal description.
537 .. function:: tparm(str[,...])
539 Instantiates the string *str* with the supplied parameters, where *str* should
540 be a parameterized string obtained from the terminfo database. E.g.
541 ``tparm(tigetstr("cup"), 5, 3)`` could result in ``'\033[6;4H'``, the exact
542 result depending on terminal type.
545 .. function:: typeahead(fd)
547 Specifies that the file descriptor *fd* be used for typeahead checking. If *fd*
548 is ``-1``, then no typeahead checking is done.
550 The curses library does "line-breakout optimization" by looking for typeahead
551 periodically while updating the screen. If input is found, and it is coming
552 from a tty, the current update is postponed until refresh or doupdate is called
553 again, allowing faster response to commands typed in advance. This function
554 allows specifying a different file descriptor for typeahead checking.
557 .. function:: unctrl(ch)
559 Returns a string which is a printable representation of the character *ch*.
560 Control characters are displayed as a caret followed by the character, for
561 example as ``^C``. Printing characters are left as they are.
564 .. function:: ungetch(ch)
566 Push *ch* so the next :meth:`getch` will return it.
570 Only one *ch* can be pushed before :meth:`getch` is called.
573 .. function:: ungetmouse(id, x, y, z, bstate)
575 Push a :const:`KEY_MOUSE` event onto the input queue, associating the given
579 .. function:: use_env(flag)
581 If used, this function should be called before :func:`initscr` or newterm are
582 called. When *flag* is false, the values of lines and columns specified in the
583 terminfo database will be used, even if environment variables :envvar:`LINES`
584 and :envvar:`COLUMNS` (used by default) are set, or if curses is running in a
585 window (in which case default behavior would be to use the window size if
586 :envvar:`LINES` and :envvar:`COLUMNS` are not set).
589 .. function:: use_default_colors()
591 Allow use of default values for colors on terminals supporting this feature. Use
592 this to support transparency in your application. The default color is assigned
593 to the color number -1. After calling this function, ``init_pair(x,
594 curses.COLOR_RED, -1)`` initializes, for instance, color pair *x* to a red
595 foreground color on the default background.
598 .. _curses-window-objects:
603 Window objects, as returned by :func:`initscr` and :func:`newwin` above, have
604 the following methods:
607 .. method:: window.addch([y, x,] ch[, attr])
611 A *character* means a C character (an ASCII code), rather then a Python
612 character (a string of length 1). (This note is true whenever the documentation
613 mentions a character.) The builtin :func:`ord` is handy for conveying strings to
616 Paint character *ch* at ``(y, x)`` with attributes *attr*, overwriting any
617 character previously painter at that location. By default, the character
618 position and attributes are the current settings for the window object.
621 .. method:: window.addnstr([y, x,] str, n[, attr])
623 Paint at most *n* characters of the string *str* at ``(y, x)`` with attributes
624 *attr*, overwriting anything previously on the display.
627 .. method:: window.addstr([y, x,] str[, attr])
629 Paint the string *str* at ``(y, x)`` with attributes *attr*, overwriting
630 anything previously on the display.
633 .. method:: window.attroff(attr)
635 Remove attribute *attr* from the "background" set applied to all writes to the
639 .. method:: window.attron(attr)
641 Add attribute *attr* from the "background" set applied to all writes to the
645 .. method:: window.attrset(attr)
647 Set the "background" set of attributes to *attr*. This set is initially 0 (no
651 .. method:: window.bkgd(ch[, attr])
653 Sets the background property of the window to the character *ch*, with
654 attributes *attr*. The change is then applied to every character position in
657 * The attribute of every character in the window is changed to the new
658 background attribute.
660 * Wherever the former background character appears, it is changed to the new
661 background character.
664 .. method:: window.bkgdset(ch[, attr])
666 Sets the window's background. A window's background consists of a character and
667 any combination of attributes. The attribute part of the background is combined
668 (OR'ed) with all non-blank characters that are written into the window. Both
669 the character and attribute parts of the background are combined with the blank
670 characters. The background becomes a property of the character and moves with
671 the character through any scrolling and insert/delete line/character operations.
674 .. method:: window.border([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])
676 Draw a border around the edges of the window. Each parameter specifies the
677 character to use for a specific part of the border; see the table below for more
678 details. The characters can be specified as integers or as one-character
683 A ``0`` value for any parameter will cause the default character to be used for
684 that parameter. Keyword parameters can *not* be used. The defaults are listed
687 +-----------+---------------------+-----------------------+
688 | Parameter | Description | Default value |
689 +===========+=====================+=======================+
690 | *ls* | Left side | :const:`ACS_VLINE` |
691 +-----------+---------------------+-----------------------+
692 | *rs* | Right side | :const:`ACS_VLINE` |
693 +-----------+---------------------+-----------------------+
694 | *ts* | Top | :const:`ACS_HLINE` |
695 +-----------+---------------------+-----------------------+
696 | *bs* | Bottom | :const:`ACS_HLINE` |
697 +-----------+---------------------+-----------------------+
698 | *tl* | Upper-left corner | :const:`ACS_ULCORNER` |
699 +-----------+---------------------+-----------------------+
700 | *tr* | Upper-right corner | :const:`ACS_URCORNER` |
701 +-----------+---------------------+-----------------------+
702 | *bl* | Bottom-left corner | :const:`ACS_LLCORNER` |
703 +-----------+---------------------+-----------------------+
704 | *br* | Bottom-right corner | :const:`ACS_LRCORNER` |
705 +-----------+---------------------+-----------------------+
708 .. method:: window.box([vertch, horch])
710 Similar to :meth:`border`, but both *ls* and *rs* are *vertch* and both *ts* and
711 bs are *horch*. The default corner characters are always used by this function.
714 .. method:: window.chgat([y, x, ] [num,] attr)
716 Sets the attributes of *num* characters at the current cursor position, or at
717 position ``(y, x)`` if supplied. If no value of *num* is given or *num* = -1,
718 the attribute will be set on all the characters to the end of the line. This
719 function does not move the cursor. The changed line will be touched using the
720 :meth:`touchline` method so that the contents will be redisplayed by the next
724 .. method:: window.clear()
726 Like :meth:`erase`, but also causes the whole window to be repainted upon next
727 call to :meth:`refresh`.
730 .. method:: window.clearok(yes)
732 If *yes* is 1, the next call to :meth:`refresh` will clear the window
736 .. method:: window.clrtobot()
738 Erase from cursor to the end of the window: all lines below the cursor are
739 deleted, and then the equivalent of :meth:`clrtoeol` is performed.
742 .. method:: window.clrtoeol()
744 Erase from cursor to the end of the line.
747 .. method:: window.cursyncup()
749 Updates the current cursor position of all the ancestors of the window to
750 reflect the current cursor position of the window.
753 .. method:: window.delch([y, x])
755 Delete any character at ``(y, x)``.
758 .. method:: window.deleteln()
760 Delete the line under the cursor. All following lines are moved up by 1 line.
763 .. method:: window.derwin([nlines, ncols,] begin_y, begin_x)
765 An abbreviation for "derive window", :meth:`derwin` is the same as calling
766 :meth:`subwin`, except that *begin_y* and *begin_x* are relative to the origin
767 of the window, rather than relative to the entire screen. Returns a window
768 object for the derived window.
771 .. method:: window.echochar(ch[, attr])
773 Add character *ch* with attribute *attr*, and immediately call :meth:`refresh`
777 .. method:: window.enclose(y, x)
779 Tests whether the given pair of screen-relative character-cell coordinates are
780 enclosed by the given window, returning true or false. It is useful for
781 determining what subset of the screen windows enclose the location of a mouse
785 .. method:: window.erase()
790 .. method:: window.getbegyx()
792 Return a tuple ``(y, x)`` of co-ordinates of upper-left corner.
795 .. method:: window.getch([y, x])
797 Get a character. Note that the integer returned does *not* have to be in ASCII
798 range: function keys, keypad keys and so on return numbers higher than 256. In
799 no-delay mode, -1 is returned if there is no input.
802 .. method:: window.getkey([y, x])
804 Get a character, returning a string instead of an integer, as :meth:`getch`
805 does. Function keys, keypad keys and so on return a multibyte string containing
806 the key name. In no-delay mode, an exception is raised if there is no input.
809 .. method:: window.getmaxyx()
811 Return a tuple ``(y, x)`` of the height and width of the window.
814 .. method:: window.getparyx()
816 Returns the beginning coordinates of this window relative to its parent window
817 into two integer variables y and x. Returns ``-1,-1`` if this window has no
821 .. method:: window.getstr([y, x])
823 Read a string from the user, with primitive line editing capacity.
826 .. method:: window.getyx()
828 Return a tuple ``(y, x)`` of current cursor position relative to the window's
832 .. method:: window.hline([y, x,] ch, n)
834 Display a horizontal line starting at ``(y, x)`` with length *n* consisting of
838 .. method:: window.idcok(flag)
840 If *flag* is false, curses no longer considers using the hardware insert/delete
841 character feature of the terminal; if *flag* is true, use of character insertion
842 and deletion is enabled. When curses is first initialized, use of character
843 insert/delete is enabled by default.
846 .. method:: window.idlok(yes)
848 If called with *yes* equal to 1, :mod:`curses` will try and use hardware line
849 editing facilities. Otherwise, line insertion/deletion are disabled.
852 .. method:: window.immedok(flag)
854 If *flag* is true, any change in the window image automatically causes the
855 window to be refreshed; you no longer have to call :meth:`refresh` yourself.
856 However, it may degrade performance considerably, due to repeated calls to
857 wrefresh. This option is disabled by default.
860 .. method:: window.inch([y, x])
862 Return the character at the given position in the window. The bottom 8 bits are
863 the character proper, and upper bits are the attributes.
866 .. method:: window.insch([y, x,] ch[, attr])
868 Paint character *ch* at ``(y, x)`` with attributes *attr*, moving the line from
869 position *x* right by one character.
872 .. method:: window.insdelln(nlines)
874 Inserts *nlines* lines into the specified window above the current line. The
875 *nlines* bottom lines are lost. For negative *nlines*, delete *nlines* lines
876 starting with the one under the cursor, and move the remaining lines up. The
877 bottom *nlines* lines are cleared. The current cursor position remains the
881 .. method:: window.insertln()
883 Insert a blank line under the cursor. All following lines are moved down by 1
887 .. method:: window.insnstr([y, x,] str, n [, attr])
889 Insert a character string (as many characters as will fit on the line) before
890 the character under the cursor, up to *n* characters. If *n* is zero or
891 negative, the entire string is inserted. All characters to the right of the
892 cursor are shifted right, with the rightmost characters on the line being lost.
893 The cursor position does not change (after moving to *y*, *x*, if specified).
896 .. method:: window.insstr([y, x, ] str [, attr])
898 Insert a character string (as many characters as will fit on the line) before
899 the character under the cursor. All characters to the right of the cursor are
900 shifted right, with the rightmost characters on the line being lost. The cursor
901 position does not change (after moving to *y*, *x*, if specified).
904 .. method:: window.instr([y, x] [, n])
906 Returns a string of characters, extracted from the window starting at the
907 current cursor position, or at *y*, *x* if specified. Attributes are stripped
908 from the characters. If *n* is specified, :meth:`instr` returns return a string
909 at most *n* characters long (exclusive of the trailing NUL).
912 .. method:: window.is_linetouched(line)
914 Returns true if the specified line was modified since the last call to
915 :meth:`refresh`; otherwise returns false. Raises a :exc:`curses.error`
916 exception if *line* is not valid for the given window.
919 .. method:: window.is_wintouched()
921 Returns true if the specified window was modified since the last call to
922 :meth:`refresh`; otherwise returns false.
925 .. method:: window.keypad(yes)
927 If *yes* is 1, escape sequences generated by some keys (keypad, function keys)
928 will be interpreted by :mod:`curses`. If *yes* is 0, escape sequences will be
929 left as is in the input stream.
932 .. method:: window.leaveok(yes)
934 If *yes* is 1, cursor is left where it is on update, instead of being at "cursor
935 position." This reduces cursor movement where possible. If possible the cursor
936 will be made invisible.
938 If *yes* is 0, cursor will always be at "cursor position" after an update.
941 .. method:: window.move(new_y, new_x)
943 Move cursor to ``(new_y, new_x)``.
946 .. method:: window.mvderwin(y, x)
948 Moves the window inside its parent window. The screen-relative parameters of
949 the window are not changed. This routine is used to display different parts of
950 the parent window at the same physical position on the screen.
953 .. method:: window.mvwin(new_y, new_x)
955 Move the window so its upper-left corner is at ``(new_y, new_x)``.
958 .. method:: window.nodelay(yes)
960 If *yes* is ``1``, :meth:`getch` will be non-blocking.
963 .. method:: window.notimeout(yes)
965 If *yes* is ``1``, escape sequences will not be timed out.
967 If *yes* is ``0``, after a few milliseconds, an escape sequence will not be
968 interpreted, and will be left in the input stream as is.
971 .. method:: window.noutrefresh()
973 Mark for refresh but wait. This function updates the data structure
974 representing the desired state of the window, but does not force an update of
975 the physical screen. To accomplish that, call :func:`doupdate`.
978 .. method:: window.overlay(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])
980 Overlay the window on top of *destwin*. The windows need not be the same size,
981 only the overlapping region is copied. This copy is non-destructive, which means
982 that the current background character does not overwrite the old contents of
985 To get fine-grained control over the copied region, the second form of
986 :meth:`overlay` can be used. *sminrow* and *smincol* are the upper-left
987 coordinates of the source window, and the other variables mark a rectangle in
988 the destination window.
991 .. method:: window.overwrite(destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])
993 Overwrite the window on top of *destwin*. The windows need not be the same size,
994 in which case only the overlapping region is copied. This copy is destructive,
995 which means that the current background character overwrites the old contents of
998 To get fine-grained control over the copied region, the second form of
999 :meth:`overwrite` can be used. *sminrow* and *smincol* are the upper-left
1000 coordinates of the source window, the other variables mark a rectangle in the
1004 .. method:: window.putwin(file)
1006 Writes all data associated with the window into the provided file object. This
1007 information can be later retrieved using the :func:`getwin` function.
1010 .. method:: window.redrawln(beg, num)
1012 Indicates that the *num* screen lines, starting at line *beg*, are corrupted and
1013 should be completely redrawn on the next :meth:`refresh` call.
1016 .. method:: window.redrawwin()
1018 Touches the entire window, causing it to be completely redrawn on the next
1019 :meth:`refresh` call.
1022 .. method:: window.refresh([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])
1024 Update the display immediately (sync actual screen with previous
1025 drawing/deleting methods).
1027 The 6 optional arguments can only be specified when the window is a pad created
1028 with :func:`newpad`. The additional parameters are needed to indicate what part
1029 of the pad and screen are involved. *pminrow* and *pmincol* specify the upper
1030 left-hand corner of the rectangle to be displayed in the pad. *sminrow*,
1031 *smincol*, *smaxrow*, and *smaxcol* specify the edges of the rectangle to be
1032 displayed on the screen. The lower right-hand corner of the rectangle to be
1033 displayed in the pad is calculated from the screen coordinates, since the
1034 rectangles must be the same size. Both rectangles must be entirely contained
1035 within their respective structures. Negative values of *pminrow*, *pmincol*,
1036 *sminrow*, or *smincol* are treated as if they were zero.
1039 .. method:: window.scroll([lines=1])
1041 Scroll the screen or scrolling region upward by *lines* lines.
1044 .. method:: window.scrollok(flag)
1046 Controls what happens when the cursor of a window is moved off the edge of the
1047 window or scrolling region, either as a result of a newline action on the bottom
1048 line, or typing the last character of the last line. If *flag* is false, the
1049 cursor is left on the bottom line. If *flag* is true, the window is scrolled up
1050 one line. Note that in order to get the physical scrolling effect on the
1051 terminal, it is also necessary to call :meth:`idlok`.
1054 .. method:: window.setscrreg(top, bottom)
1056 Set the scrolling region from line *top* to line *bottom*. All scrolling actions
1057 will take place in this region.
1060 .. method:: window.standend()
1062 Turn off the standout attribute. On some terminals this has the side effect of
1063 turning off all attributes.
1066 .. method:: window.standout()
1068 Turn on attribute *A_STANDOUT*.
1071 .. method:: window.subpad([nlines, ncols,] begin_y, begin_x)
1073 Return a sub-window, whose upper-left corner is at ``(begin_y, begin_x)``, and
1074 whose width/height is *ncols*/*nlines*.
1077 .. method:: window.subwin([nlines, ncols,] begin_y, begin_x)
1079 Return a sub-window, whose upper-left corner is at ``(begin_y, begin_x)``, and
1080 whose width/height is *ncols*/*nlines*.
1082 By default, the sub-window will extend from the specified position to the lower
1083 right corner of the window.
1086 .. method:: window.syncdown()
1088 Touches each location in the window that has been touched in any of its ancestor
1089 windows. This routine is called by :meth:`refresh`, so it should almost never
1090 be necessary to call it manually.
1093 .. method:: window.syncok(flag)
1095 If called with *flag* set to true, then :meth:`syncup` is called automatically
1096 whenever there is a change in the window.
1099 .. method:: window.syncup()
1101 Touches all locations in ancestors of the window that have been changed in the
1105 .. method:: window.timeout(delay)
1107 Sets blocking or non-blocking read behavior for the window. If *delay* is
1108 negative, blocking read is used (which will wait indefinitely for input). If
1109 *delay* is zero, then non-blocking read is used, and -1 will be returned by
1110 :meth:`getch` if no input is waiting. If *delay* is positive, then
1111 :meth:`getch` will block for *delay* milliseconds, and return -1 if there is
1112 still no input at the end of that time.
1115 .. method:: window.touchline(start, count[, changed])
1117 Pretend *count* lines have been changed, starting with line *start*. If
1118 *changed* is supplied, it specifies whether the affected lines are marked as
1119 having been changed (*changed*\ =1) or unchanged (*changed*\ =0).
1122 .. method:: window.touchwin()
1124 Pretend the whole window has been changed, for purposes of drawing
1128 .. method:: window.untouchwin()
1130 Marks all lines in the window as unchanged since the last call to
1134 .. method:: window.vline([y, x,] ch, n)
1136 Display a vertical line starting at ``(y, x)`` with length *n* consisting of the
1143 The :mod:`curses` module defines the following data members:
1148 Some curses routines that return an integer, such as :func:`getch`, return
1149 :const:`ERR` upon failure.
1154 Some curses routines that return an integer, such as :func:`napms`, return
1155 :const:`OK` upon success.
1160 A string representing the current version of the module. Also available as
1161 :const:`__version__`.
1163 Several constants are available to specify character cell attributes:
1165 +------------------+-------------------------------+
1166 | Attribute | Meaning |
1167 +==================+===============================+
1168 | ``A_ALTCHARSET`` | Alternate character set mode. |
1169 +------------------+-------------------------------+
1170 | ``A_BLINK`` | Blink mode. |
1171 +------------------+-------------------------------+
1172 | ``A_BOLD`` | Bold mode. |
1173 +------------------+-------------------------------+
1174 | ``A_DIM`` | Dim mode. |
1175 +------------------+-------------------------------+
1176 | ``A_NORMAL`` | Normal attribute. |
1177 +------------------+-------------------------------+
1178 | ``A_STANDOUT`` | Standout mode. |
1179 +------------------+-------------------------------+
1180 | ``A_UNDERLINE`` | Underline mode. |
1181 +------------------+-------------------------------+
1183 Keys are referred to by integer constants with names starting with ``KEY_``.
1184 The exact keycaps available are system dependent.
1186 .. XXX this table is far too large! should it be alphabetized?
1188 +-------------------+--------------------------------------------+
1189 | Key constant | Key |
1190 +===================+============================================+
1191 | ``KEY_MIN`` | Minimum key value |
1192 +-------------------+--------------------------------------------+
1193 | ``KEY_BREAK`` | Break key (unreliable) |
1194 +-------------------+--------------------------------------------+
1195 | ``KEY_DOWN`` | Down-arrow |
1196 +-------------------+--------------------------------------------+
1197 | ``KEY_UP`` | Up-arrow |
1198 +-------------------+--------------------------------------------+
1199 | ``KEY_LEFT`` | Left-arrow |
1200 +-------------------+--------------------------------------------+
1201 | ``KEY_RIGHT`` | Right-arrow |
1202 +-------------------+--------------------------------------------+
1203 | ``KEY_HOME`` | Home key (upward+left arrow) |
1204 +-------------------+--------------------------------------------+
1205 | ``KEY_BACKSPACE`` | Backspace (unreliable) |
1206 +-------------------+--------------------------------------------+
1207 | ``KEY_F0`` | Function keys. Up to 64 function keys are |
1209 +-------------------+--------------------------------------------+
1210 | ``KEY_Fn`` | Value of function key *n* |
1211 +-------------------+--------------------------------------------+
1212 | ``KEY_DL`` | Delete line |
1213 +-------------------+--------------------------------------------+
1214 | ``KEY_IL`` | Insert line |
1215 +-------------------+--------------------------------------------+
1216 | ``KEY_DC`` | Delete character |
1217 +-------------------+--------------------------------------------+
1218 | ``KEY_IC`` | Insert char or enter insert mode |
1219 +-------------------+--------------------------------------------+
1220 | ``KEY_EIC`` | Exit insert char mode |
1221 +-------------------+--------------------------------------------+
1222 | ``KEY_CLEAR`` | Clear screen |
1223 +-------------------+--------------------------------------------+
1224 | ``KEY_EOS`` | Clear to end of screen |
1225 +-------------------+--------------------------------------------+
1226 | ``KEY_EOL`` | Clear to end of line |
1227 +-------------------+--------------------------------------------+
1228 | ``KEY_SF`` | Scroll 1 line forward |
1229 +-------------------+--------------------------------------------+
1230 | ``KEY_SR`` | Scroll 1 line backward (reverse) |
1231 +-------------------+--------------------------------------------+
1232 | ``KEY_NPAGE`` | Next page |
1233 +-------------------+--------------------------------------------+
1234 | ``KEY_PPAGE`` | Previous page |
1235 +-------------------+--------------------------------------------+
1236 | ``KEY_STAB`` | Set tab |
1237 +-------------------+--------------------------------------------+
1238 | ``KEY_CTAB`` | Clear tab |
1239 +-------------------+--------------------------------------------+
1240 | ``KEY_CATAB`` | Clear all tabs |
1241 +-------------------+--------------------------------------------+
1242 | ``KEY_ENTER`` | Enter or send (unreliable) |
1243 +-------------------+--------------------------------------------+
1244 | ``KEY_SRESET`` | Soft (partial) reset (unreliable) |
1245 +-------------------+--------------------------------------------+
1246 | ``KEY_RESET`` | Reset or hard reset (unreliable) |
1247 +-------------------+--------------------------------------------+
1248 | ``KEY_PRINT`` | Print |
1249 +-------------------+--------------------------------------------+
1250 | ``KEY_LL`` | Home down or bottom (lower left) |
1251 +-------------------+--------------------------------------------+
1252 | ``KEY_A1`` | Upper left of keypad |
1253 +-------------------+--------------------------------------------+
1254 | ``KEY_A3`` | Upper right of keypad |
1255 +-------------------+--------------------------------------------+
1256 | ``KEY_B2`` | Center of keypad |
1257 +-------------------+--------------------------------------------+
1258 | ``KEY_C1`` | Lower left of keypad |
1259 +-------------------+--------------------------------------------+
1260 | ``KEY_C3`` | Lower right of keypad |
1261 +-------------------+--------------------------------------------+
1262 | ``KEY_BTAB`` | Back tab |
1263 +-------------------+--------------------------------------------+
1264 | ``KEY_BEG`` | Beg (beginning) |
1265 +-------------------+--------------------------------------------+
1266 | ``KEY_CANCEL`` | Cancel |
1267 +-------------------+--------------------------------------------+
1268 | ``KEY_CLOSE`` | Close |
1269 +-------------------+--------------------------------------------+
1270 | ``KEY_COMMAND`` | Cmd (command) |
1271 +-------------------+--------------------------------------------+
1272 | ``KEY_COPY`` | Copy |
1273 +-------------------+--------------------------------------------+
1274 | ``KEY_CREATE`` | Create |
1275 +-------------------+--------------------------------------------+
1276 | ``KEY_END`` | End |
1277 +-------------------+--------------------------------------------+
1278 | ``KEY_EXIT`` | Exit |
1279 +-------------------+--------------------------------------------+
1280 | ``KEY_FIND`` | Find |
1281 +-------------------+--------------------------------------------+
1282 | ``KEY_HELP`` | Help |
1283 +-------------------+--------------------------------------------+
1284 | ``KEY_MARK`` | Mark |
1285 +-------------------+--------------------------------------------+
1286 | ``KEY_MESSAGE`` | Message |
1287 +-------------------+--------------------------------------------+
1288 | ``KEY_MOVE`` | Move |
1289 +-------------------+--------------------------------------------+
1290 | ``KEY_NEXT`` | Next |
1291 +-------------------+--------------------------------------------+
1292 | ``KEY_OPEN`` | Open |
1293 +-------------------+--------------------------------------------+
1294 | ``KEY_OPTIONS`` | Options |
1295 +-------------------+--------------------------------------------+
1296 | ``KEY_PREVIOUS`` | Prev (previous) |
1297 +-------------------+--------------------------------------------+
1298 | ``KEY_REDO`` | Redo |
1299 +-------------------+--------------------------------------------+
1300 | ``KEY_REFERENCE`` | Ref (reference) |
1301 +-------------------+--------------------------------------------+
1302 | ``KEY_REFRESH`` | Refresh |
1303 +-------------------+--------------------------------------------+
1304 | ``KEY_REPLACE`` | Replace |
1305 +-------------------+--------------------------------------------+
1306 | ``KEY_RESTART`` | Restart |
1307 +-------------------+--------------------------------------------+
1308 | ``KEY_RESUME`` | Resume |
1309 +-------------------+--------------------------------------------+
1310 | ``KEY_SAVE`` | Save |
1311 +-------------------+--------------------------------------------+
1312 | ``KEY_SBEG`` | Shifted Beg (beginning) |
1313 +-------------------+--------------------------------------------+
1314 | ``KEY_SCANCEL`` | Shifted Cancel |
1315 +-------------------+--------------------------------------------+
1316 | ``KEY_SCOMMAND`` | Shifted Command |
1317 +-------------------+--------------------------------------------+
1318 | ``KEY_SCOPY`` | Shifted Copy |
1319 +-------------------+--------------------------------------------+
1320 | ``KEY_SCREATE`` | Shifted Create |
1321 +-------------------+--------------------------------------------+
1322 | ``KEY_SDC`` | Shifted Delete char |
1323 +-------------------+--------------------------------------------+
1324 | ``KEY_SDL`` | Shifted Delete line |
1325 +-------------------+--------------------------------------------+
1326 | ``KEY_SELECT`` | Select |
1327 +-------------------+--------------------------------------------+
1328 | ``KEY_SEND`` | Shifted End |
1329 +-------------------+--------------------------------------------+
1330 | ``KEY_SEOL`` | Shifted Clear line |
1331 +-------------------+--------------------------------------------+
1332 | ``KEY_SEXIT`` | Shifted Dxit |
1333 +-------------------+--------------------------------------------+
1334 | ``KEY_SFIND`` | Shifted Find |
1335 +-------------------+--------------------------------------------+
1336 | ``KEY_SHELP`` | Shifted Help |
1337 +-------------------+--------------------------------------------+
1338 | ``KEY_SHOME`` | Shifted Home |
1339 +-------------------+--------------------------------------------+
1340 | ``KEY_SIC`` | Shifted Input |
1341 +-------------------+--------------------------------------------+
1342 | ``KEY_SLEFT`` | Shifted Left arrow |
1343 +-------------------+--------------------------------------------+
1344 | ``KEY_SMESSAGE`` | Shifted Message |
1345 +-------------------+--------------------------------------------+
1346 | ``KEY_SMOVE`` | Shifted Move |
1347 +-------------------+--------------------------------------------+
1348 | ``KEY_SNEXT`` | Shifted Next |
1349 +-------------------+--------------------------------------------+
1350 | ``KEY_SOPTIONS`` | Shifted Options |
1351 +-------------------+--------------------------------------------+
1352 | ``KEY_SPREVIOUS`` | Shifted Prev |
1353 +-------------------+--------------------------------------------+
1354 | ``KEY_SPRINT`` | Shifted Print |
1355 +-------------------+--------------------------------------------+
1356 | ``KEY_SREDO`` | Shifted Redo |
1357 +-------------------+--------------------------------------------+
1358 | ``KEY_SREPLACE`` | Shifted Replace |
1359 +-------------------+--------------------------------------------+
1360 | ``KEY_SRIGHT`` | Shifted Right arrow |
1361 +-------------------+--------------------------------------------+
1362 | ``KEY_SRSUME`` | Shifted Resume |
1363 +-------------------+--------------------------------------------+
1364 | ``KEY_SSAVE`` | Shifted Save |
1365 +-------------------+--------------------------------------------+
1366 | ``KEY_SSUSPEND`` | Shifted Suspend |
1367 +-------------------+--------------------------------------------+
1368 | ``KEY_SUNDO`` | Shifted Undo |
1369 +-------------------+--------------------------------------------+
1370 | ``KEY_SUSPEND`` | Suspend |
1371 +-------------------+--------------------------------------------+
1372 | ``KEY_UNDO`` | Undo |
1373 +-------------------+--------------------------------------------+
1374 | ``KEY_MOUSE`` | Mouse event has occurred |
1375 +-------------------+--------------------------------------------+
1376 | ``KEY_RESIZE`` | Terminal resize event |
1377 +-------------------+--------------------------------------------+
1378 | ``KEY_MAX`` | Maximum key value |
1379 +-------------------+--------------------------------------------+
1381 On VT100s and their software emulations, such as X terminal emulators, there are
1382 normally at least four function keys (:const:`KEY_F1`, :const:`KEY_F2`,
1383 :const:`KEY_F3`, :const:`KEY_F4`) available, and the arrow keys mapped to
1384 :const:`KEY_UP`, :const:`KEY_DOWN`, :const:`KEY_LEFT` and :const:`KEY_RIGHT` in
1385 the obvious way. If your machine has a PC keyboard, it is safe to expect arrow
1386 keys and twelve function keys (older PC keyboards may have only ten function
1387 keys); also, the following keypad mappings are standard:
1389 +------------------+-----------+
1390 | Keycap | Constant |
1391 +==================+===========+
1392 | :kbd:`Insert` | KEY_IC |
1393 +------------------+-----------+
1394 | :kbd:`Delete` | KEY_DC |
1395 +------------------+-----------+
1396 | :kbd:`Home` | KEY_HOME |
1397 +------------------+-----------+
1398 | :kbd:`End` | KEY_END |
1399 +------------------+-----------+
1400 | :kbd:`Page Up` | KEY_NPAGE |
1401 +------------------+-----------+
1402 | :kbd:`Page Down` | KEY_PPAGE |
1403 +------------------+-----------+
1405 The following table lists characters from the alternate character set. These are
1406 inherited from the VT100 terminal, and will generally be available on software
1407 emulations such as X terminals. When there is no graphic available, curses
1408 falls back on a crude printable ASCII approximation.
1412 These are available only after :func:`initscr` has been called.
1414 +------------------+------------------------------------------+
1415 | ACS code | Meaning |
1416 +==================+==========================================+
1417 | ``ACS_BBSS`` | alternate name for upper right corner |
1418 +------------------+------------------------------------------+
1419 | ``ACS_BLOCK`` | solid square block |
1420 +------------------+------------------------------------------+
1421 | ``ACS_BOARD`` | board of squares |
1422 +------------------+------------------------------------------+
1423 | ``ACS_BSBS`` | alternate name for horizontal line |
1424 +------------------+------------------------------------------+
1425 | ``ACS_BSSB`` | alternate name for upper left corner |
1426 +------------------+------------------------------------------+
1427 | ``ACS_BSSS`` | alternate name for top tee |
1428 +------------------+------------------------------------------+
1429 | ``ACS_BTEE`` | bottom tee |
1430 +------------------+------------------------------------------+
1431 | ``ACS_BULLET`` | bullet |
1432 +------------------+------------------------------------------+
1433 | ``ACS_CKBOARD`` | checker board (stipple) |
1434 +------------------+------------------------------------------+
1435 | ``ACS_DARROW`` | arrow pointing down |
1436 +------------------+------------------------------------------+
1437 | ``ACS_DEGREE`` | degree symbol |
1438 +------------------+------------------------------------------+
1439 | ``ACS_DIAMOND`` | diamond |
1440 +------------------+------------------------------------------+
1441 | ``ACS_GEQUAL`` | greater-than-or-equal-to |
1442 +------------------+------------------------------------------+
1443 | ``ACS_HLINE`` | horizontal line |
1444 +------------------+------------------------------------------+
1445 | ``ACS_LANTERN`` | lantern symbol |
1446 +------------------+------------------------------------------+
1447 | ``ACS_LARROW`` | left arrow |
1448 +------------------+------------------------------------------+
1449 | ``ACS_LEQUAL`` | less-than-or-equal-to |
1450 +------------------+------------------------------------------+
1451 | ``ACS_LLCORNER`` | lower left-hand corner |
1452 +------------------+------------------------------------------+
1453 | ``ACS_LRCORNER`` | lower right-hand corner |
1454 +------------------+------------------------------------------+
1455 | ``ACS_LTEE`` | left tee |
1456 +------------------+------------------------------------------+
1457 | ``ACS_NEQUAL`` | not-equal sign |
1458 +------------------+------------------------------------------+
1459 | ``ACS_PI`` | letter pi |
1460 +------------------+------------------------------------------+
1461 | ``ACS_PLMINUS`` | plus-or-minus sign |
1462 +------------------+------------------------------------------+
1463 | ``ACS_PLUS`` | big plus sign |
1464 +------------------+------------------------------------------+
1465 | ``ACS_RARROW`` | right arrow |
1466 +------------------+------------------------------------------+
1467 | ``ACS_RTEE`` | right tee |
1468 +------------------+------------------------------------------+
1469 | ``ACS_S1`` | scan line 1 |
1470 +------------------+------------------------------------------+
1471 | ``ACS_S3`` | scan line 3 |
1472 +------------------+------------------------------------------+
1473 | ``ACS_S7`` | scan line 7 |
1474 +------------------+------------------------------------------+
1475 | ``ACS_S9`` | scan line 9 |
1476 +------------------+------------------------------------------+
1477 | ``ACS_SBBS`` | alternate name for lower right corner |
1478 +------------------+------------------------------------------+
1479 | ``ACS_SBSB`` | alternate name for vertical line |
1480 +------------------+------------------------------------------+
1481 | ``ACS_SBSS`` | alternate name for right tee |
1482 +------------------+------------------------------------------+
1483 | ``ACS_SSBB`` | alternate name for lower left corner |
1484 +------------------+------------------------------------------+
1485 | ``ACS_SSBS`` | alternate name for bottom tee |
1486 +------------------+------------------------------------------+
1487 | ``ACS_SSSB`` | alternate name for left tee |
1488 +------------------+------------------------------------------+
1489 | ``ACS_SSSS`` | alternate name for crossover or big plus |
1490 +------------------+------------------------------------------+
1491 | ``ACS_STERLING`` | pound sterling |
1492 +------------------+------------------------------------------+
1493 | ``ACS_TTEE`` | top tee |
1494 +------------------+------------------------------------------+
1495 | ``ACS_UARROW`` | up arrow |
1496 +------------------+------------------------------------------+
1497 | ``ACS_ULCORNER`` | upper left corner |
1498 +------------------+------------------------------------------+
1499 | ``ACS_URCORNER`` | upper right corner |
1500 +------------------+------------------------------------------+
1501 | ``ACS_VLINE`` | vertical line |
1502 +------------------+------------------------------------------+
1504 The following table lists the predefined colors:
1506 +-------------------+----------------------------+
1507 | Constant | Color |
1508 +===================+============================+
1509 | ``COLOR_BLACK`` | Black |
1510 +-------------------+----------------------------+
1511 | ``COLOR_BLUE`` | Blue |
1512 +-------------------+----------------------------+
1513 | ``COLOR_CYAN`` | Cyan (light greenish blue) |
1514 +-------------------+----------------------------+
1515 | ``COLOR_GREEN`` | Green |
1516 +-------------------+----------------------------+
1517 | ``COLOR_MAGENTA`` | Magenta (purplish red) |
1518 +-------------------+----------------------------+
1519 | ``COLOR_RED`` | Red |
1520 +-------------------+----------------------------+
1521 | ``COLOR_WHITE`` | White |
1522 +-------------------+----------------------------+
1523 | ``COLOR_YELLOW`` | Yellow |
1524 +-------------------+----------------------------+
1527 :mod:`curses.textpad` --- Text input widget for curses programs
1528 ===============================================================
1530 .. module:: curses.textpad
1531 :synopsis: Emacs-like input editing in a curses window.
1532 .. moduleauthor:: Eric Raymond <esr@thyrsus.com>
1533 .. sectionauthor:: Eric Raymond <esr@thyrsus.com>
1536 .. versionadded:: 1.6
1538 The :mod:`curses.textpad` module provides a :class:`Textbox` class that handles
1539 elementary text editing in a curses window, supporting a set of keybindings
1540 resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x,
1541 FrameMaker, and many other programs). The module also provides a
1542 rectangle-drawing function useful for framing text boxes or for other purposes.
1544 The module :mod:`curses.textpad` defines the following function:
1547 .. function:: rectangle(win, uly, ulx, lry, lrx)
1549 Draw a rectangle. The first argument must be a window object; the remaining
1550 arguments are coordinates relative to that window. The second and third
1551 arguments are the y and x coordinates of the upper left hand corner of the
1552 rectangle to be drawn; the fourth and fifth arguments are the y and x
1553 coordinates of the lower right hand corner. The rectangle will be drawn using
1554 VT100/IBM PC forms characters on terminals that make this possible (including
1555 xterm and most other software terminal emulators). Otherwise it will be drawn
1556 with ASCII dashes, vertical bars, and plus signs.
1559 .. _curses-textpad-objects:
1564 You can instantiate a :class:`Textbox` object as follows:
1567 .. class:: Textbox(win)
1569 Return a textbox widget object. The *win* argument should be a curses
1570 :class:`WindowObject` in which the textbox is to be contained. The edit cursor
1571 of the textbox is initially located at the upper left hand corner of the
1572 containing window, with coordinates ``(0, 0)``. The instance's
1573 :attr:`stripspaces` flag is initially on.
1575 :class:`Textbox` objects have the following methods:
1578 .. method:: Textbox.edit([validator])
1580 This is the entry point you will normally use. It accepts editing keystrokes
1581 until one of the termination keystrokes is entered. If *validator* is supplied,
1582 it must be a function. It will be called for each keystroke entered with the
1583 keystroke as a parameter; command dispatch is done on the result. This method
1584 returns the window contents as a string; whether blanks in the window are
1585 included is affected by the :attr:`stripspaces` member.
1588 .. method:: Textbox.do_command(ch)
1590 Process a single command keystroke. Here are the supported special keystrokes:
1592 +------------------+-------------------------------------------+
1593 | Keystroke | Action |
1594 +==================+===========================================+
1595 | :kbd:`Control-A` | Go to left edge of window. |
1596 +------------------+-------------------------------------------+
1597 | :kbd:`Control-B` | Cursor left, wrapping to previous line if |
1599 +------------------+-------------------------------------------+
1600 | :kbd:`Control-D` | Delete character under cursor. |
1601 +------------------+-------------------------------------------+
1602 | :kbd:`Control-E` | Go to right edge (stripspaces off) or end |
1603 | | of line (stripspaces on). |
1604 +------------------+-------------------------------------------+
1605 | :kbd:`Control-F` | Cursor right, wrapping to next line when |
1607 +------------------+-------------------------------------------+
1608 | :kbd:`Control-G` | Terminate, returning the window contents. |
1609 +------------------+-------------------------------------------+
1610 | :kbd:`Control-H` | Delete character backward. |
1611 +------------------+-------------------------------------------+
1612 | :kbd:`Control-J` | Terminate if the window is 1 line, |
1613 | | otherwise insert newline. |
1614 +------------------+-------------------------------------------+
1615 | :kbd:`Control-K` | If line is blank, delete it, otherwise |
1616 | | clear to end of line. |
1617 +------------------+-------------------------------------------+
1618 | :kbd:`Control-L` | Refresh screen. |
1619 +------------------+-------------------------------------------+
1620 | :kbd:`Control-N` | Cursor down; move down one line. |
1621 +------------------+-------------------------------------------+
1622 | :kbd:`Control-O` | Insert a blank line at cursor location. |
1623 +------------------+-------------------------------------------+
1624 | :kbd:`Control-P` | Cursor up; move up one line. |
1625 +------------------+-------------------------------------------+
1627 Move operations do nothing if the cursor is at an edge where the movement is not
1628 possible. The following synonyms are supported where possible:
1630 +------------------------+------------------+
1631 | Constant | Keystroke |
1632 +========================+==================+
1633 | :const:`KEY_LEFT` | :kbd:`Control-B` |
1634 +------------------------+------------------+
1635 | :const:`KEY_RIGHT` | :kbd:`Control-F` |
1636 +------------------------+------------------+
1637 | :const:`KEY_UP` | :kbd:`Control-P` |
1638 +------------------------+------------------+
1639 | :const:`KEY_DOWN` | :kbd:`Control-N` |
1640 +------------------------+------------------+
1641 | :const:`KEY_BACKSPACE` | :kbd:`Control-h` |
1642 +------------------------+------------------+
1644 All other keystrokes are treated as a command to insert the given character and
1645 move right (with line wrapping).
1648 .. method:: Textbox.gather()
1650 This method returns the window contents as a string; whether blanks in the
1651 window are included is affected by the :attr:`stripspaces` member.
1654 .. attribute:: Textbox.stripspaces
1656 This data member is a flag which controls the interpretation of blanks in the
1657 window. When it is on, trailing blanks on each line are ignored; any cursor
1658 motion that would land the cursor on a trailing blank goes to the end of that
1659 line instead, and trailing blanks are stripped when the window contents are
1663 :mod:`curses.wrapper` --- Terminal handler for curses programs
1664 ==============================================================
1666 .. module:: curses.wrapper
1667 :synopsis: Terminal configuration wrapper for curses programs.
1668 .. moduleauthor:: Eric Raymond <esr@thyrsus.com>
1669 .. sectionauthor:: Eric Raymond <esr@thyrsus.com>
1672 .. versionadded:: 1.6
1674 This module supplies one function, :func:`wrapper`, which runs another function
1675 which should be the rest of your curses-using application. If the application
1676 raises an exception, :func:`wrapper` will restore the terminal to a sane state
1677 before re-raising the exception and generating a traceback.
1680 .. function:: wrapper(func, ...)
1682 Wrapper function that initializes curses and calls another function, *func*,
1683 restoring normal keyboard/screen behavior on error. The callable object *func*
1684 is then passed the main window 'stdscr' as its first argument, followed by any
1685 other arguments passed to :func:`wrapper`.
1687 Before calling the hook function, :func:`wrapper` turns on cbreak mode, turns
1688 off echo, enables the terminal keypad, and initializes colors if the terminal
1689 has color support. On exit (whether normally or by exception) it restores
1690 cooked mode, turns on echo, and disables the terminal keypad.