Commit b39a7481 authored by Xiang Zhang's avatar Xiang Zhang Committed by GitHub

bpo-30176: Add missing curses cell attributes constants (#2278)

parent c3c9db89
...@@ -1234,27 +1234,63 @@ The :mod:`curses` module defines the following data members: ...@@ -1234,27 +1234,63 @@ The :mod:`curses` module defines the following data members:
A string representing the current version of the module. Also available as A string representing the current version of the module. Also available as
:const:`__version__`. :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 | | 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 | | ``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_``. Keys are referred to by integer constants with names starting with ``KEY_``.
......
...@@ -184,6 +184,8 @@ Library ...@@ -184,6 +184,8 @@ Library
Documentation Documentation
------------- -------------
- bpo-30176: Add missing attribute related constants in curses documentation.
- bpo-28929: Link the documentation to its source file on GitHub. - bpo-28929: Link the documentation to its source file on GitHub.
- Issue #26355: Add canonical header link on each page to corresponding major - Issue #26355: Add canonical header link on each page to corresponding major
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment