X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_attr.3x.html;h=b0bb4980f94e33c5ca908cd2478e0005d3808eb1;hp=cca759ac81d93ce2a201e91dbe0214a7dc6ccea2;hb=3eda6f30a84d53844d2ebceadb457e2e7e9cfbf3;hpb=58552e8c761a70f8f0bd591fecdf576fa8216e3e
diff --git a/doc/html/man/curs_attr.3x.html b/doc/html/man/curs_attr.3x.html
index cca759ac..b0bb4980 100644
--- a/doc/html/man/curs_attr.3x.html
+++ b/doc/html/man/curs_attr.3x.html
@@ -27,7 +27,7 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_attr.3x,v 1.49 2017/01/07 19:25:15 tom Exp @
+ * @Id: curs_attr.3x,v 1.53 2017/03/28 23:31:39 tom Exp @
* attr_get
* .br
* .br
@@ -123,17 +123,23 @@
clearing.
Routines which do not have a WINDOW* parameter apply to
- stdscr.
+ stdscr. For example, attr_set is the stdscr variant of
+ wattr_set.
- The attr_set and wattr_set functions set the current at-
- tributes of the given window to attrs, with color speci-
- fied by pair. X/Open specified an additional parameter
- opts which is unused in all implementations.
+ There are two sets of functions:
- Use attr_get and wattr_get to retrieve attributes for the
- given window.
+ o functions for manipulating the window attributes and
+ color: wattr_set and wattr_get.
+
+ o functions for manipulating only the window attributes
+ (not color): wattr_on and wattr_off.
+
+ The wattr_set function sets the current attributes of the
+ given window to attrs, with color specified by pair.
+
+ Use wattr_get to retrieve attributes for the given window.
Use attr_on and wattr_on to turn on window attributes,
i.e., values OR'd together in attr, without affecting oth-
@@ -173,35 +179,32 @@
In these functions, the color pair argument is a color-
pair index (as in the first argument of init_pair, see
- curs_color(3x)). The opts argument is not presently used,
- but is reserved for the future (leave it NULL).
+ curs_color(3x)).
- The routine color_set sets the current color of the given
- window to the foreground/background combination described
- by the color pair parameter. The parameter opts is re-
- served for future use; applications must supply a null
- pointer.
+ The routine color_set sets the current color of the given
+ window to the foreground/background combination described
+ by the color pair parameter.
- The routine standout is the same as attron(A_STANDOUT).
- The routine standend is the same as attrset(A_NORMAL) or
+ The routine standout is the same as attron(A_STANDOUT).
+ The routine 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
o they have well established legacy use, and
- o there is no ambiguity about the way the attributes
+ o there is no ambiguity about the way the attributes
might be combined with a color pair.
The following video attributes, defined in <curses.h>, can
be passed to the routines attron, attroff, and attrset, or
- OR'd with the characters passed to addch (see curs_add-
+ OR'd with the characters passed to addch (see curs_add-
ch(3x)).
Name Description
@@ -232,52 +235,85 @@
WA_TOP Top highlight
WA_VERTICAL Vertical highlight
- The return values of many of these routines are not mean-
+ The return values of many of these routines are not mean-
ingful (they are implemented as macro-expanded assignments
- and simply return their argument). The SVr4 manual page
+ and simply return their argument). The SVr4 manual page
claims (falsely) that these routines always return 1.
- These functions may be macros: attroff, wattroff, attron,
- wattron, attrset, wattrset, standend and standout.
-
- 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
+ These functions may be macros:
+
+ attroff, wattroff, attron, wattron, attrset, wat-
+ trset, standend and standout.
+
+ 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
support more than 256 color pairs.
+
+ This implementation provides the A_ITALIC attribute for
+ terminals which have the enter_italics_mode (sitm) and ex-
+ it_italics_mode (ritm) capabilities. Italics are not men-
+ tioned in X/Open Curses. Unlike the other video at-
+ tributes, A_ITALIC is unrelated to the set_attributes ca-
+ pabilities. 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 reserved for future use, saying that
+ it should be NULL. This implementation uses that parame-
+ ter in ABI 6 for the functions which have a color-pair pa-
+ rameter 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 retrieve the color, e.g., wat-
+ tr_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 standard
+ pointer to short parameter.
+
+ The remaining functions which have opts, but do not manip-
+ ulate color, e.g., wattr_on and wattr_off are not used by
+ this implementation except to check that they are NULL.
+
+
- These functions are supported in the XSI Curses standard,
- Issue 4. The standard defined the dedicated type for
- highlights, attr_t, which is not defined in SVr4 curses.
- The functions taking attr_t arguments are not supported
+ These functions are supported 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.
+ 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 match the updated attributes.
+
The XSI Curses standard states that whether the tradition-
- al functions attron/attroff/attrset can manipulate at-
- tributes 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,
+ al functions attron/attroff/attrset can manipulate at-
+ tributes 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).
- This implementation provides the A_ITALIC attribute for
- terminals which have the enter_italics_mode (sitm) and ex-
- it_italics_mode (ritm) capabilities. Italics are not men-
- tioned in X/Open Curses. Unlike the other video at-
- tributes, A_ITALIC is unrelated to the set_attributes ca-
- pabilities. This implementation makes the assumption that
- exit_attribute_mode may also reset italics.
+ XSI Curses added these entry points:
+
+ attr_get, attr_on, attr_off, attr_set, wattr_on,
+ wattr_off, wattr_get, wattr_set
- XSI Curses added the new entry points, attr_get, attr_on,
- attr_off, attr_set, wattr_on, wattr_off, wattr_get, wat-
- tr_set. These 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:
+ 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:
Name Description
------------------------------------------------------------
@@ -290,10 +326,6 @@
WA_BOLD Extra bright or bold
WA_ALTCHARSET Alternate character set
- 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 match the updated attributes.
-
The XSI curses standard specifies that each pair of corre-
sponding A_ and WA_-using functions operates on the same
current-highlight information.
@@ -318,6 +350,10 @@
o returns an error if the color pair parameter for wcol-
or_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.
+
Functions with a "mv" prefix first perform a cursor move-
ment using wmove, and return an error if the position is
outside the window, or if the window pointer is null.
@@ -346,6 +382,7 @@
VIDEO ATTRIBUTES
NOTES
+EXTENSIONS
PORTABILITY
RETURN VALUE
SEE ALSO