X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_attr.3x.html;h=70dc7455b36b96514d76736638973c2894c80d7e;hp=cbb43d47000ce2b6e4bec98d18f8740502ce4a5b;hb=4c9f63c460cb7134f142aa65f6866c175ed77605;hpb=f8a52f8d51160dbfdd5449403bb157497f2b39c4;ds=sidebyside
diff --git a/doc/html/man/curs_attr.3x.html b/doc/html/man/curs_attr.3x.html
index cbb43d47..70dc7455 100644
--- a/doc/html/man/curs_attr.3x.html
+++ b/doc/html/man/curs_attr.3x.html
@@ -28,7 +28,7 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_attr.3x,v 1.71 2022/02/12 20:07:29 tom Exp @
+ * @Id: curs_attr.3x,v 1.72 2022/04/16 19:18:32 tom Exp @
* ---------------------------------------------------------------------------
* attr_get
* .br
@@ -410,35 +410,34 @@
tion uses that parameter in ABI 6 for the functions which have a color-
pair parameter to support extended color pairs:
- o For functions which modify the color, e.g., wattr_set, if opts is
- set it is treated as a pointer to int, and used to set the color
- pair instead of the short pair parameter.
+ 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
+ the color pair instead of the short pair 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 retrieving it via the stan-
- dard pointer to short parameter.
+ color pair as an int value, in addition to retrieving it via the
+ standard pointer to short parameter.
- The remaining functions which have opts, but do not manipulate color,
- e.g., wattr_on and wattr_off are not used by this implementation except
- to check that they are NULL.
+ 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 supported in the XSI Curses standard, Issue 4. The
- standard defined the dedicated type for highlights, attr_t, which was
+ 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 cor-
- rectly manipulate all other highlights (specifically, A_ALTCHARSET,
+ 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 cor-
+ rectly manipulate all other highlights (specifically, A_ALTCHARSET,
A_PROTECT, and A_INVIS).
XSI Curses added these entry points:
@@ -446,7 +445,7 @@
attr_get, attr_on, attr_off, attr_set, wattr_on, wattr_off, wat-
tr_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:
@@ -461,11 +460,11 @@
WA_BOLD Extra bright or bold
WA_ALTCHARSET Alternate character set
- XSI curses does not assign values to these symbols, nor does it state
+ 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.:
- o The XSI curses standard specifies that each pair of corresponding
- A_ and WA_-using functions operates on the same current-highlight
+ o The XSI curses standard 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 val-
@@ -473,17 +472,25 @@
For example, the Solaris xpg4 (X/Open) curses declares attr_t to be
an unsigned short integer (16-bits), while chtype is a unsigned in-
- teger (32-bits). The WA_ symbols in this case are different from
- the A_ symbols because they are used for a smaller datatype which
+ teger (32-bits). The WA_ symbols in this case are different from
+ the A_ symbols because they are used for a smaller datatype which
does not represent A_CHARTEXT or A_COLOR.
In this implementation (as in many others), the values happen to be
- the same because it simplifies copying information between chtype
+ the same because it simplifies copying information between chtype
and cchar_t variables.
+ o Because ncurses's attr_t can hold a color pair (in the A_COLOR
+ field), a call to wattr_on, wattr_off, or wattr_set may alter the
+ window's color. If the color pair information in the attribute pa-
+ rameter is zero, no change is made to the window's color.
+
+ This is consistent with SVr4 curses; X/Open Curses does not specify
+ this.
+
The XSI standard extended conformance level adds new highlights A_HORI-
- ZONTAL, A_LEFT, A_LOW, A_RIGHT, A_TOP, A_VERTICAL (and corresponding
- WA_ macros for each). As of August 2013, no known terminal provides
+ ZONTAL, 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).
@@ -499,10 +506,10 @@
o returns an error if the color pair parameter for wcolor_set is out-
side the range 0..COLOR_PAIRS-1.
- o does not return an error if either of the parameters of wattr_get
+ o does not return an error 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
+ 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.