diff options
| author | Xiang Zhang <angwerzx@126.com> | 2017-06-19 14:06:59 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-19 14:06:59 (GMT) |
| commit | 04521c275e47e4df59046ee0297810f06c208350 (patch) | |
| tree | 2957d77259044aa46329bfa9306688c861584d94 | |
| parent | 46e299c1536da541b9dbf76c0cb909bf8c79f589 (diff) | |
| download | cpython-04521c275e47e4df59046ee0297810f06c208350.zip cpython-04521c275e47e4df59046ee0297810f06c208350.tar.gz cpython-04521c275e47e4df59046ee0297810f06c208350.tar.bz2 | |
bpo-30176: Add missing curses cell attributes constants (#2277)
| -rw-r--r-- | Doc/library/curses.rst | 54 | ||||
| -rw-r--r-- | Misc/NEWS | 2 |
2 files changed, 47 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_``. @@ -270,6 +270,8 @@ C API Documentation ------------- +- bpo-30176: Add missing attribute related constants in curses documentation. + - bpo-26985: Add missing info of code object in inspect documentation. - bpo-28929: Link the documentation to its source file on GitHub. |