bpo-30176: Add missing curses cell attributes constants (GH-1302)

This commit is contained in:
Xiang Zhang 2017-06-16 11:20:07 +08:00 committed by Mariatta
parent c9318853bb
commit 116dd5eba6
3 changed files with 54 additions and 14 deletions

View File

@ -1271,34 +1271,70 @@ 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_ITALIC`` | Italic mode. |
| ``A_DIM`` | Dim mode |
+------------------+-------------------------------+
| ``A_DIM`` | Dim mode. |
| ``A_INVIS`` | Invisible or blank mode |
+------------------+-------------------------------+
| ``A_NORMAL`` | Normal attribute. |
| ``A_ITALIC`` | Italic mode |
+------------------+-------------------------------+
| ``A_NORMAL`` | Normal attribute |
+------------------+-------------------------------+
| ``A_PROTECT`` | Protected mode |
+------------------+-------------------------------+
| ``A_REVERSE`` | Reverse background and |
| | foreground colors. |
| | foreground colors |
+------------------+-------------------------------+
| ``A_STANDOUT`` | Standout mode. |
| ``A_STANDOUT`` | Standout mode |
+------------------+-------------------------------+
| ``A_UNDERLINE`` | Underline 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 |
+------------------+-------------------------------+
.. versionadded:: 3.7
``A_ITALIC`` was added.
Several constants are available to extract corresponding attributes returned
by some methods.
+------------------+-------------------------------+
| Bit-mask | Meaning |
+==================+===============================+
| ``A_ATTRIBUTES`` | Bit-mask to extract |
| | attributes |
+------------------+-------------------------------+
| ``A_CHARTEXT`` | Bit-mask to extract a |
| | character |
+------------------+-------------------------------+
| ``A_COLOR`` | Bit-mask to extract |
| | color-pair field information |
+------------------+-------------------------------+
Keys are referred to by integer constants with names starting with ``KEY_``.
The exact keycaps available are system dependent.

View File

@ -1216,6 +1216,8 @@ C API
Documentation
-------------
- bpo-30176: Add missing attribute related constants in curses documentation.
- Issue #30052: the link targets for :func:`bytes` and
:func:`bytearray` are now their respective type definitions, rather
than the corresponding builtin function entries. Use :ref:`bytes <func-bytes>`

View File

@ -3335,9 +3335,6 @@ PyInit__curses(void)
SetDictInt("A_BLINK", A_BLINK);
SetDictInt("A_DIM", A_DIM);
SetDictInt("A_BOLD", A_BOLD);
#ifdef A_ITALIC
SetDictInt("A_ITALIC", A_ITALIC);
#endif
SetDictInt("A_ALTCHARSET", A_ALTCHARSET);
#if !defined(__NetBSD__)
SetDictInt("A_INVIS", A_INVIS);
@ -3366,6 +3363,11 @@ PyInit__curses(void)
SetDictInt("A_VERTICAL", A_VERTICAL);
#endif
/* ncurses extension */
#ifdef A_ITALIC
SetDictInt("A_ITALIC", A_ITALIC);
#endif
SetDictInt("COLOR_BLACK", COLOR_BLACK);
SetDictInt("COLOR_RED", COLOR_RED);
SetDictInt("COLOR_GREEN", COLOR_GREEN);