summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAnthony Sottile <asottile@umich.edu>2019-10-31 09:13:48 (GMT)
committerSerhiy Storchaka <storchaka@gmail.com>2019-10-31 09:13:48 (GMT)
commitb32cb97bce472dad337c6b2f071883f6234e21d8 (patch)
treee686243c05fbc57f9de6be1bd7fefde38d589fb6 /Doc
parentb15100fe7def8580c78ed16f0bb4b72b2ae7af3f (diff)
downloadcpython-b32cb97bce472dad337c6b2f071883f6234e21d8.zip
cpython-b32cb97bce472dad337c6b2f071883f6234e21d8.tar.gz
cpython-b32cb97bce472dad337c6b2f071883f6234e21d8.tar.bz2
bpo-38312: Add curses.{get,set}_escdelay and curses.{get,set}_tabsize. (GH-16938)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/curses.rst26
-rw-r--r--Doc/whatsnew/3.9.rst7
2 files changed, 33 insertions, 0 deletions
diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst
index f1803c6..1201e89 100644
--- a/Doc/library/curses.rst
+++ b/Doc/library/curses.rst
@@ -511,6 +511,32 @@ The module :mod:`curses` defines the following functions:
Save the current state of the terminal modes in a buffer, usable by
:func:`resetty`.
+.. function:: get_escdelay()
+
+ Retrieves the value set by :func:`set_escdelay`.
+
+ .. versionadded:: 3.9
+
+.. function:: set_escdelay(ms)
+
+ Sets the number of milliseconds to wait after reading an escape character,
+ to distinguish between an individual escape character entered on the
+ keyboard from escape sequences sent by cursor and function keys.
+
+ .. versionadded:: 3.9
+
+.. function:: get_tabsize()
+
+ Retrieves the value set by :func:`set_tabsize`.
+
+ .. versionadded:: 3.9
+
+.. function:: set_tabsize(size)
+
+ Sets the number of columns used by the curses library when converting a tab
+ character to spaces as it adds the tab to a window.
+
+ .. versionadded:: 3.9
.. function:: setsyx(y, x)
diff --git a/Doc/whatsnew/3.9.rst b/Doc/whatsnew/3.9.rst
index d41e708..7d7c502 100644
--- a/Doc/whatsnew/3.9.rst
+++ b/Doc/whatsnew/3.9.rst
@@ -130,6 +130,13 @@ that schedules a shutdown for the default executor that waits on the
:func:`asyncio.run` has been updated to use the new :term:`coroutine`.
(Contributed by Kyle Stanley in :issue:`34037`.)
+curses
+------
+
+Add :func:`curses.get_escdelay`, :func:`curses.set_escdelay`,
+:func:`curses.get_tabsize`, and :func:`curses.set_tabsize` functions.
+(Contributed by Anthony Sottile in :issue:`38312`.)
+
fcntl
-----