X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_attr.3x.html;h=3d6c5941febd837c8bd550cd92c3720399ed6c74;hp=fbb1e131d4fffe172934143fc04c46bfac888682;hb=31c4bcf3307145fc5368b4aaf15e41bdd66a984b;hpb=2035f48ed0fc56ec4e5caf9b7c10e00ba43e160f diff --git a/doc/html/man/curs_attr.3x.html b/doc/html/man/curs_attr.3x.html index fbb1e131..3d6c5941 100644 --- a/doc/html/man/curs_attr.3x.html +++ b/doc/html/man/curs_attr.3x.html @@ -28,14 +28,8 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_attr.3x,v 1.80 2023/09/09 21:13:26 tom Exp @ + * @Id: curs_attr.3x,v 1.84 2023/09/16 23:34:43 tom Exp @ * --------------------------------------------------------------------------- - * attr_get - * .br - * .br - * .br - * .br - * .br * --------------------------------------------------------------------------- * --------------------------------------------------------------------------- * --------------------------------------------------------------------------- @@ -56,12 +50,12 @@
-curs_attr(3x) Library calls curs_attr(3x) @@ -71,9 +65,9 @@
attr_get, wattr_get, attr_set, wattr_set, attr_off, wattr_off, attr_on, wattr_on, attroff, wattroff, attron, wattron, attrset, wattrset, chgat, - wchgat, mvchgat, mvwchgat, color_set, wcolor_set, standend, wstandend, - standout, wstandout - curses character and window attribute control - routines + wchgat, mvchgat, mvwchgat, color_set, wcolor_set, standend, wstandend, + standout, wstandout - manipulate attributes of character cells in + curses windows
@@ -117,14 +111,14 @@ These routines manipulate the current attributes of the named window, which then apply to all characters that are written into the window with waddch, waddstr and wprintw. Attributes are a property of the - character, and move with the character through any scrolling and in- - sert/delete line/character operations. To the extent possible, they + character, and move with the character through any scrolling and + insert/delete line/character operations. To the extent possible, they are displayed as appropriate modifications to the graphic rendition of characters put on the screen. These routines do not affect the attributes used when erasing portions - of the window. See curs_bkgd(3x) for functions which modify the at- - tributes used for erasing and clearing. + of the window. See curs_bkgd(3x) for functions which modify the + attributes used for erasing and clearing. Routines which do not have a WINDOW* parameter apply to stdscr. For example, attr_set is the stdscr variant of wattr_set. @@ -133,8 +127,8 @@
There are two sets of functions: - o functions for manipulating the window attributes and color: wat- - tr_set and wattr_get. + 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. @@ -145,8 +139,8 @@ 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 other attributes. Use at- - tr_off and wattr_off to turn off window attributes, again values OR'd + OR'd together in attr, without affecting other attributes. Use + attr_off and wattr_off to turn off window attributes, again values OR'd together in attr, without affecting other attributes. @@ -157,11 +151,11 @@ because X/Open simply added an underscore (_) for the newer names. The int datatype used in the legacy routines is treated as if it is the - same size as chtype (used by addch(3x)). It holds the common video at- - tributes (such as bold, reverse), as well as a few bits for color. - Those bits correspond to the A_COLOR symbol. The COLOR_PAIR macro pro- - vides a value which can be OR'd into the attribute parameter. For ex- - ample, as long as that value fits into the A_COLOR mask, then these + same size as chtype (used by addch(3x)). It holds the common video + attributes (such as bold, reverse), as well as a few bits for color. + Those bits correspond to the A_COLOR symbol. The COLOR_PAIR macro + provides a value which can be OR'd into the attribute parameter. For + example, as long as that value fits into the A_COLOR mask, then these calls produce similar results: attrset(A_BOLD | COLOR_PAIR(pair)); @@ -180,8 +174,8 @@ int output = PAIR_NUMBER(value); The attrset routine is a legacy feature predating SVr4 curses but kept - in X/Open Curses for the same reason that SVr4 curses kept it: compati- - bility. + in X/Open Curses for the same reason that SVr4 curses kept it: + compatibility. The remaining attr* functions operate exactly like the corresponding attr_* functions, except that they take arguments of type int rather @@ -192,13 +186,13 @@
- The routine chgat changes the attributes of a given number of charac- - ters starting at the current cursor location of stdscr. It does not - update the cursor and does not perform wrapping. A character count of - -1 or greater than the remaining window width means to change at- - tributes all the way to the end of the current line. The wchgat func- - tion generalizes this to any window; the mvwchgat function does a cur- - sor move before acting. + The routine chgat changes the attributes of a given number of + characters starting at the current cursor location of stdscr. It does + not update the cursor and does not perform wrapping. A character count + of -1 or greater than the remaining window width means to change + attributes all the way to the end of the current line. The wchgat + function generalizes this to any window; the mvwchgat function does a + cursor move before acting. In these functions, the color pair argument is a color-pair index (as in the first argument of init_pair, see curs_color(3x)). @@ -206,8 +200,8 @@
The routine color_set sets the current color of the given window to the - foreground/background combination described by the color pair parame- - ter. + foreground/background combination described by the color pair + parameter.
@@ -219,8 +213,8 @@ o they have well established legacy use, and - o there is no ambiguity about the way the attributes might be com- - bined with a color pair. + o there is no ambiguity about the way the attributes might be + combined with a color pair.
@@ -277,9 +271,9 @@
X/Open Curses is largely based on SVr4 curses, adding support for - "wide-characters" (not specific to Unicode). Some of the X/Open dif- - ferences from SVr4 curses address the way video attributes can be ap- - plied to wide-characters. But aside from that, attrset and attr_set + "wide-characters" (not specific to Unicode). Some of the X/Open + differences from SVr4 curses address the way video attributes can be + applied to wide-characters. But aside from that, attrset and attr_set are similar. SVr4 curses provided the basic features for manipulating video attributes. However, earlier versions of curses provided a part of these features. @@ -290,11 +284,11 @@ standout and standend which were carried along into X/Open Curses due to their pervasive use in legacy applications. - Some terminals in the 1980s could support a variety of video at- - tributes, although the BSD curses library could do nothing with those. - System V (1983) provided an improved curses library. It defined the A_ - symbols for use by applications to manipulate the other attributes. - There are few useful references for the chronology. + Some terminals in the 1980s could support a variety of video + attributes, although the BSD curses library could do nothing with + those. System V (1983) provided an improved curses library. It + defined the A_ symbols for use by applications to manipulate the other + attributes. There are few useful references for the chronology. Goodheart's book UNIX Curses Explained (1991) describes SVr3 (1987), commenting on several functions: @@ -322,9 +316,9 @@ This table showing the number of bits for A_COLOR and A_CHARTEXT was gleaned from the curses header files for various operating systems and architectures. The inferred architecture and notes reflect the format - and size of the defined constants as well as clues such as the alter- - nate character set implementation. A 32-bit library can be used on a - 64-bit system, but not necessarily the reverse. + and size of the defined constants as well as clues such as the + alternate character set implementation. A 32-bit library can be used + on a 64-bit system, but not necessarily the reverse. Year System Arch Color Char Notes ---------------------------------------------------------------- @@ -353,11 +347,11 @@ Regarding OSF/1 (and Tru64), - o These used 64-bit hardware. Like ncurses, the OSF/1 curses in- - terface is not customized for 32-bit and 64-bit versions. + o These used 64-bit hardware. Like ncurses, the OSF/1 curses + interface is not customized for 32-bit and 64-bit versions. - o Unlike other systems which evolved from AT&T code, OSF/1 provid- - ed a new implementation for X/Open curses. + o Unlike other systems which evolved from AT&T code, OSF/1 + provided a new implementation for X/Open curses. Regarding Solaris, @@ -367,8 +361,8 @@ Sun's copyright began in 1996. o Sun updated the X/Open curses interface after 64-bit support was - introduced in 1997, but did not modify the SVr4 curses inter- - face. + introduced in 1997, but did not modify the SVr4 curses + interface. Regarding U/Win, @@ -398,17 +392,17 @@
This implementation provides the A_ITALIC attribute for terminals which - have the enter_italics_mode (sitm) and exit_italics_mode (ritm) capa- - bilities. Italics are not mentioned in X/Open Curses. Unlike the oth- - er video attributes, A_ITALIC is unrelated to the set_attributes capa- - bilities. This implementation makes the assumption that exit_attri- - bute_mode may also reset italics. + 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 re- - served for future use, saying that it should be NULL. This implementa- - tion uses that parameter in ABI 6 for the functions which have a color- - pair parameter to support extended color pairs: + 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 + have a color-pair parameter to support extended color pairs: 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 @@ -436,14 +430,14 @@ 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, + 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: - attr_get, attr_on, attr_off, attr_set, wattr_on, wattr_off, wat- - tr_get, wattr_set + 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 macros prefixed with WA_. The older macros have direct counterparts in @@ -467,12 +461,12 @@ A_ and WA_-using functions operates on the same current-highlight information. - o However, in some implementations, those symbols have unrelated val- - ues. + o However, in some implementations, those symbols have unrelated + values. 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 + an unsigned short integer (16-bits), while chtype is a unsigned + integer (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. @@ -482,16 +476,16 @@ 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. + window's color. If the color pair information in the attribute + parameter 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 - these highlights (i.e., via the sgr1 capability). + The XSI standard 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).
@@ -503,8 +497,8 @@ o returns an error if the window pointer is null. - o returns an error if the color pair parameter for wcolor_set is out- - side the range 0..COLOR_PAIRS-1. + o returns an error 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. @@ -520,7 +514,7 @@ -ncurses 6.4 2023-09-09 curs_attr(3x) +ncurses 6.4 2023-09-16 curs_attr(3x)