diff options
| author | Mariatta <Mariatta@users.noreply.github.com> | 2017-06-16 14:19:56 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-16 14:19:56 (GMT) |
| commit | 304a96e5868c1b38a87692668f297aaf041e6e67 (patch) | |
| tree | a82170ca71aa91cab25b96716e59b965ac0fc7da /Doc | |
| parent | e9f4d8db5f30a9603fa0c005382bff78aa1ce232 (diff) | |
| download | cpython-304a96e5868c1b38a87692668f297aaf041e6e67.zip cpython-304a96e5868c1b38a87692668f297aaf041e6e67.tar.gz cpython-304a96e5868c1b38a87692668f297aaf041e6e67.tar.bz2 | |
bpo-30176: Add missing curses cell attributes constants (GH-1302). (GH-2241)
(cherry picked from commit 116dd5eba60a940b35db6aaf4e8c998ac30ad440)
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/curses.rst | 54 |
1 files changed, 45 insertions, 9 deletions
diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst index 3442e4e..668d282 100644 --- a/Doc/library/curses.rst +++ b/Doc/library/curses.rst @@ -1271,27 +1271,63 @@ The :mod:`curses` module defines the following data members: A string representing the current version of the module. Also available as :const:`__version__`. -Several constants are available to specify character cell attributes: +Some constants are available to specify character cell attributes. +The exact constants available are system dependent. +------------------+-------------------------------+ | Attribute | Meaning | +==================+===============================+ -| ``A_ALTCHARSET`` | Alternate character set mode. | +| ``A_ALTCHARSET`` | Alternate character set mode | +------------------+-------------------------------+ -| ``A_BLINK`` | Blink mode. | +| ``A_BLINK`` | Blink mode | +------------------+-------------------------------+ -| ``A_BOLD`` | Bold mode. | +| ``A_BOLD`` | Bold mode | +------------------+-------------------------------+ -| ``A_DIM`` | Dim mode. | +| ``A_DIM`` | Dim mode | +------------------+-------------------------------+ -| ``A_NORMAL`` | Normal attribute. | +| ``A_INVIS`` | Invisible or blank mode | ++------------------+-------------------------------+ +| ``A_NORMAL`` | Normal attribute | ++------------------+-------------------------------+ +| ``A_PROTECT`` | Protected mode | +------------------+-------------------------------+ | ``A_REVERSE`` | Reverse background and | -| | foreground colors. | +| | foreground colors | ++------------------+-------------------------------+ +| ``A_STANDOUT`` | Standout mode | ++------------------+-------------------------------+ +| ``A_UNDERLINE`` | Underline mode | ++------------------+-------------------------------+ +| ``A_HORIZONTAL`` | Horizontal highlight | ++------------------+-------------------------------+ +| ``A_LEFT`` | Left highlight | ++------------------+-------------------------------+ +| ``A_LOW`` | Low highlight | ++------------------+-------------------------------+ +| ``A_RIGHT`` | Right highlight | ++------------------+-------------------------------+ +| ``A_TOP`` | Top highlight | ++------------------+-------------------------------+ +| ``A_VERTICAL`` | Vertical highlight | ++------------------+-------------------------------+ +| ``A_CHARTEXT`` | Bit-mask to extract a | +| | character | ++------------------+-------------------------------+ + +Several constants are available to extract corresponding attributes returned +by some methods. + ++------------------+-------------------------------+ +| Bit-mask | Meaning | ++==================+===============================+ +| ``A_ATTRIBUTES`` | Bit-mask to extract | +| | attributes | +------------------+-------------------------------+ -| ``A_STANDOUT`` | Standout mode. | +| ``A_CHARTEXT`` | Bit-mask to extract a | +| | character | +------------------+-------------------------------+ -| ``A_UNDERLINE`` | Underline mode. | +| ``A_COLOR`` | Bit-mask to extract | +| | color-pair field information | +------------------+-------------------------------+ Keys are referred to by integer constants with names starting with ``KEY_``. |