summaryrefslogtreecommitdiffstats
path: root/Doc/library/curses.rst
diff options
context:
space:
mode:
authorZackery Spytz <zspytz@gmail.com>2021-01-14 09:40:09 (GMT)
committerGitHub <noreply@github.com>2021-01-14 09:40:09 (GMT)
commit14cfa325c298ceb9eaf6b585a3cdcabf6c6378a9 (patch)
treed296971ebb25971ee313ef27e532d06f43f24686 /Doc/library/curses.rst
parenta330365ca5ae836075f306334ab648bf23471481 (diff)
downloadcpython-14cfa325c298ceb9eaf6b585a3cdcabf6c6378a9.zip
cpython-14cfa325c298ceb9eaf6b585a3cdcabf6c6378a9.tar.gz
cpython-14cfa325c298ceb9eaf6b585a3cdcabf6c6378a9.tar.bz2
bpo-39273: Expose BUTTON5_* constants in the curses module if available (GH-17996)
Diffstat (limited to 'Doc/library/curses.rst')
-rw-r--r--Doc/library/curses.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst
index 26121ac..f55bb03 100644
--- a/Doc/library/curses.rst
+++ b/Doc/library/curses.rst
@@ -220,11 +220,15 @@ The module :mod:`curses` defines the following functions:
multiple devices, and *x*, *y*, *z* are the event's coordinates. (*z* is
currently unused.) *bstate* is an integer value whose bits will be set to
indicate the type of event, and will be the bitwise OR of one or more of the
- following constants, where *n* is the button number from 1 to 4:
+ following constants, where *n* is the button number from 1 to 5:
:const:`BUTTONn_PRESSED`, :const:`BUTTONn_RELEASED`, :const:`BUTTONn_CLICKED`,
:const:`BUTTONn_DOUBLE_CLICKED`, :const:`BUTTONn_TRIPLE_CLICKED`,
:const:`BUTTON_SHIFT`, :const:`BUTTON_CTRL`, :const:`BUTTON_ALT`.
+ .. versionchanged:: 3.10
+ The ``BUTTON5_*`` constants are now exposed if they are provided by the
+ underlying curses library.
+
.. function:: getsyx()