X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_attr.3x.html;h=cb1449d2d1e1bd1790879ff95eece4935ace0c51;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;hp=a497bf8f586b6bc637ccc5f13074cd6b6e3f1f9e;hpb=bf2c36c4930ac5bb04cd2b1ba209cd09b6f510ab;p=ncurses.git
diff --git a/doc/html/man/curs_attr.3x.html b/doc/html/man/curs_attr.3x.html
index a497bf8f..cb1449d2 100644
--- a/doc/html/man/curs_attr.3x.html
+++ b/doc/html/man/curs_attr.3x.html
@@ -28,19 +28,19 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_attr.3x,v 1.96 2024/01/13 22:05:39 tom Exp @
+ * @Id: curs_attr.3x,v 1.108 2024/05/25 20:10:58 tom Exp @
-->
-curs_attr 3x 2024-01-13 ncurses 6.4 Library calls
+curs_attr 3x 2024-05-25 ncurses 6.5 Library calls
-
curs_attr 3x 2024-01-13 ncurses 6.4 Library calls
+
curs_attr 3x 2024-05-25 ncurses 6.5 Library calls
curs_attr(3x) Library calls curs_attr(3x)
@@ -191,7 +191,7 @@
standend is the same as attrset(A_NORMAL) or attrset(0), that is, it
turns off all attributes.
- X/Open does not mark these "restricted", because
+ X/Open Curses does not mark these "restricted", because
o they have well established legacy use, and
@@ -220,6 +220,10 @@
A_CHARTEXT Bit-mask to extract a character
A_COLOR Bit-mask to extract a color (legacy routines)
+ You can thus use A_CHARTEXT to extract the character from a chtype,
+ A_ATTRIBUTES to obtain its rendering attributes, and A_COLOR to find
+ the color pair it uses.
+
These video attributes are supported by attr_on and related functions
(which also support the attributes recognized by attron, etc.):
@@ -241,86 +245,85 @@
All routines return the integer OK on success, or ERR on failure.
- X/Open does not define any error conditions.
+ X/Open Curses does not specify any error conditions.
This implementation
- o returns an error if the window pointer is null.
+ o returns ERR if the window pointer is null.
- o returns an error if the color pair parameter for wcolor_set is
- outside the range 0..COLOR_PAIRS-1.
+ o returns ERR if the color pair parameter for wcolor_set is outside
+ the range 0..COLOR_PAIRS-1.
- o does not return an error if either of the parameters of wattr_get
- used for retrieving attribute or color pair values is NULL.
+ o does not fail if either of the parameters of wattr_get used for
+ retrieving attribute or color pair values is NULL.
- Functions with a "mv" prefix first perform a cursor movement using
- wmove, and return an error if the position is outside the window, or if
- the window pointer is null.
+ Functions prefixed with "mv" first perform cursor movement and fail if
+ the position (y, x) is outside the window boundaries.
These functions may be macros:
- attroff, wattroff, attron, wattron, attrset, wattrset, standend
+ attroff, wattroff, attron, wattron, attrset, wattrset, standend
and standout.
- Color pair values can only be OR'd with attributes if the pair number
+ Color pair values can only be OR'd with attributes if the pair number
is less than 256. The alternate functions such as color_set can pass a
color pair value directly. However, ncurses ABI 4 and 5 simply OR this
- value within the alternate functions. You must use ncurses ABI 6 to
+ value within the alternate functions. You must use ncurses ABI 6 to
support more than 256 color pairs.
This implementation provides the A_ITALIC attribute for terminals which
- have the enter_italics_mode (sitm) and exit_italics_mode (ritm)
- capabilities. Italics are not mentioned in X/Open Curses. Unlike the
- other video attributes, A_ITALIC is unrelated to the set_attributes
- capabilities. This implementation makes the assumption that
+ have the enter_italics_mode (sitm) and exit_italics_mode (ritm)
+ capabilities. Italics are not mentioned in X/Open Curses. Unlike the
+ other video attributes, A_ITALIC is unrelated to the set_attributes
+ capabilities. This implementation makes the assumption that
exit_attribute_mode may also reset italics.
- Each of the functions added by XSI Curses has a parameter opts, which
- X/Open Curses still (after more than twenty years) documents as
+ Each of the functions added by XSI Curses has a parameter opts, which
+ X/Open Curses still (after more than twenty years) documents as
reserved for future use, saying that it should be NULL. This
- implementation uses that parameter in ABI 6 for the functions which
+ implementation uses that parameter in ABI 6 for the functions which
have a color pair parameter to support extendedcolorpairs:
o For functions which modify the color, e.g., wattr_set and wattr_on,
- if opts is set it is treated as a pointer to int, and used to set
+ if opts is set it is treated as a pointer to int, and used to set
the color pair instead of the shortpair parameter.
o For functions which retrieve the color, e.g., wattr_get, if opts is
- set it is treated as a pointer to int, and used to retrieve the
- color pair as an int value, in addition to retrieving it via the
+ set it is treated as a pointer to int, and used to retrieve the
+ color pair as an int value, in addition to retrieving it via the
standard pointer to short parameter.
- o For functions which turn attributes off, e.g., wattr_off, the opts
+ o For functions which turn attributes off, e.g., wattr_off, the opts
parameter is ignored except except to check that it is NULL.
- These functions are described in the XSI Curses standard, Issue 4. The
- standard defined the dedicated type for highlights, attr_t, which was
- not defined in SVr4 curses. The functions taking attr_t arguments were
- not supported under SVr4.
+ These functions are described in X/Open Curses, Issue 4. The standard
+ defined the dedicated type for highlights, attr_t, which was not
+ defined in SVr4 curses. The functions taking attr_t arguments were not
+ supported under SVr4.
Very old versions of this library did not force an update of the screen
- when changing the attributes. Use touchwin to force the screen to
+ when changing the attributes. Use touchwin to force the screen to
match the updated attributes.
- The XSI Curses standard states that whether the traditional functions
- attron/attroff/attrset can manipulate attributes other than A_BLINK,
- A_BOLD, A_DIM, A_REVERSE, A_STANDOUT, or A_UNDERLINE is "unspecified".
- Under this implementation as well as SVr4 curses, these functions
- correctly manipulate all other highlights (specifically, A_ALTCHARSET,
+ X/Open Curses states that whether the traditional functions
+ attron/attroff/attrset can manipulate attributes other than A_BLINK,
+ A_BOLD, A_DIM, A_REVERSE, A_STANDOUT, or A_UNDERLINE is "unspecified".
+ Under this implementation as well as SVr4 curses, these functions
+ correctly manipulate all other highlights (specifically, A_ALTCHARSET,
A_PROTECT, and A_INVIS).
- XSI Curses added these entry points:
+ X/Open Curses added these entry points:
attr_get, attr_on, attr_off, attr_set, wattr_on, wattr_off,
wattr_get, wattr_set
- The new functions are intended to work with a new series of highlight
+ The new functions are intended to work with a new series of highlight
macros prefixed with WA_. The older macros have direct counterparts in
the newer set of names:
@@ -333,14 +336,14 @@
WA_BLINK Blinking
WA_DIM Half bright
WA_BOLD Extra bright or bold
-
WA_ALTCHARSET Alternate character set
- XSI curses does not assign values to these symbols, nor does it state
- whether or not they are related to the similarly-named A_NORMAL, etc.:
+ X/Open Curses does not assign values to these symbols, nor does it
+ state whether or not they are related to the similarly-named A_NORMAL,
+ etc.:
- o The XSI curses standard specifies that each pair of corresponding
- A_ and WA_-using functions operates on the same current-highlight
+ o X/Open Curses specifies that each pair of corresponding A_ and
+ WA_-using functions operates on the same current-highlight
information.
o However, in some implementations, those symbols have unrelated
@@ -364,7 +367,7 @@
This is consistent with SVr4 curses; X/Open Curses does not specify
this.
- The XSI standard extended conformance level adds new highlights
+ The X/Open Curses extended conformance level adds new highlights
A_HORIZONTAL, A_LEFT, A_LOW, A_RIGHT, A_TOP, A_VERTICAL (and
corresponding WA_ macros for each). As of August 2013, no known
terminal provides these highlights (i.e., via the sgr1 capability).
@@ -497,7 +500,7 @@
-ncurses 6.4 2024-01-13 curs_attr(3x)
+ncurses 6.5 2024-05-25 curs_attr(3x)