X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_attr.3x;h=21f4365f6cee8d63ee2a29d3e541b810de23ed28;hb=d79ff7b4d5f5ac63e7d9d7e76706d95a1ddb243c;hp=73ea47a84ad2e96d5fdc629b4168afeda29e5ff0;hpb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;p=ncurses.git diff --git a/man/curs_attr.3x b/man/curs_attr.3x index 73ea47a8..21f4365f 100644 --- a/man/curs_attr.3x +++ b/man/curs_attr.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2017,2018 Free Software Foundation, Inc. * +.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_attr.3x,v 1.64 2018/07/28 22:15:59 tom Exp $ -.TH curs_attr 3X "" +.\" $Id: curs_attr.3x,v 1.77 2023/07/01 15:43:20 tom Exp $ +.TH curs_attr 3X 2023-07-01 "ncurses 6.4" "Library calls" .ie \n(.g .ds `` \(lq .el .ds `` `` .ie \n(.g .ds '' \(rq @@ -39,7 +40,7 @@ .ie n .in +4 .el .in +2 .nf -.ft C \" Courier +.ft CR \" Courier .. .de NE .fi @@ -56,97 +57,96 @@ .\" --------------------------------------------------------------------------- .SH NAME .\" attr_get -\fBattr_get\fR, -\fBwattr_get\fR, -\fBattr_set\fR, -\fBwattr_set\fR, +\fBattr_get\fP, +\fBwattr_get\fP, +\fBattr_set\fP, +\fBwattr_set\fP, .\" .br -\fBattr_off\fR, -\fBwattr_off\fR, -\fBattr_on\fR, -\fBwattr_on\fR, +\fBattr_off\fP, +\fBwattr_off\fP, +\fBattr_on\fP, +\fBwattr_on\fP, .\" .br -\fBattroff\fR, -\fBwattroff\fR, -\fBattron\fR, -\fBwattron\fR, -\fBattrset\fR, -\fBwattrset\fR, +\fBattroff\fP, +\fBwattroff\fP, +\fBattron\fP, +\fBwattron\fP, +\fBattrset\fP, +\fBwattrset\fP, .\" .br -\fBchgat\fR, -\fBwchgat\fR, -\fBmvchgat\fR, -\fBmvwchgat\fR, +\fBchgat\fP, +\fBwchgat\fP, +\fBmvchgat\fP, +\fBmvwchgat\fP, .\" .br -\fBcolor_set\fR, -\fBwcolor_set\fR, +\fBcolor_set\fP, +\fBwcolor_set\fP, .\" .br -\fBstandend\fR, -\fBwstandend\fR, -\fBstandout\fR, -\fBwstandout\fR \- \fBcurses\fR character and window attribute control routines +\fBstandend\fP, +\fBwstandend\fP, +\fBstandout\fP, +\fBwstandout\fP \- \fBcurses\fP character and window attribute control routines .ad .hy .\" --------------------------------------------------------------------------- .SH SYNOPSIS -\fB#include \fR +\fB#include \fP .sp -\fBint attr_get(attr_t *\fP\fIattrs\fP\fB, short *\fP\fIpair\fP\fB, void *\fP\fIopts\fP\fB);\fR +\fBint attr_get(attr_t *\fIattrs\fB, short *\fIpair\fB, void *\fIopts\fB);\fR .br -\fBint wattr_get(WINDOW *\fP\fIwin\fP\fB, attr_t *\fP\fIattrs\fP\fB, short *\fP\fIpair\fP\fB,\fR \fBvoid *\fP\fIopts\fP\fB);\fR +\fBint wattr_get(WINDOW *\fIwin\fB, attr_t *\fIattrs\fB, short *\fIpair\fB,\fR \fBvoid *\fIopts\fB);\fR .br -\fBint attr_set(attr_t \fP\fIattrs\fP\fB, short \fP\fIpair\fP\fB, void *\fP\fIopts\fP\fB);\fR +\fBint attr_set(attr_t \fIattrs\fB, short \fIpair\fB, void *\fIopts\fB);\fR .br -\fBint wattr_set(WINDOW *\fP\fIwin\fP\fB, attr_t \fP\fIattrs\fP\fB, short \fP\fIpair\fP\fB, void *\fP\fIopts\fP\fB);\fR +\fBint wattr_set(WINDOW *\fIwin\fB, attr_t \fIattrs\fB, short \fIpair\fB, void *\fIopts\fB);\fR .sp -\fBint attr_off(attr_t \fP\fIattrs\fP\fB, void *\fP\fIopts\fP\fB);\fR +\fBint attr_off(attr_t \fIattrs\fB, void *\fIopts\fB);\fR .br -\fBint wattr_off(WINDOW *\fP\fIwin\fP\fB, attr_t \fP\fIattrs\fP\fB, void *\fP\fIopts\fP\fB);\fR +\fBint wattr_off(WINDOW *\fIwin\fB, attr_t \fIattrs\fB, void *\fIopts\fB);\fR .br -\fBint attr_on(attr_t \fP\fIattrs\fP\fB, void *\fP\fIopts\fP\fB);\fR +\fBint attr_on(attr_t \fIattrs\fB, void *\fIopts\fB);\fR .br -\fBint wattr_on(WINDOW *\fP\fIwin\fP\fB, attr_t \fP\fIattrs\fP\fB, void *\fP\fIopts\fP\fB);\fR +\fBint wattr_on(WINDOW *\fIwin\fB, attr_t \fIattrs\fB, void *\fIopts\fB);\fR .sp -\fBint attroff(int \fP\fIattrs);\fR +\fBint attroff(int \fIattrs);\fR .br -\fBint wattroff(WINDOW *\fP\fIwin\fP\fB, int \fP\fIattrs\fP\fB);\fR +\fBint wattroff(WINDOW *\fIwin\fB, int \fIattrs\fB);\fR .br -\fBint attron(int \fP\fIattrs\fP\fB);\fR +\fBint attron(int \fIattrs\fB);\fR .br -\fBint wattron(WINDOW *\fP\fIwin\fP\fB, int \fP\fIattrs\fP\fB);\fR +\fBint wattron(WINDOW *\fIwin\fB, int \fIattrs\fB);\fR .br -\fBint attrset(int \fP\fIattrs\fP\fB);\fR +\fBint attrset(int \fIattrs\fB);\fR .br -\fBint wattrset(WINDOW *\fP\fIwin\fP\fB, int \fP\fIattrs\fP\fB);\fR +\fBint wattrset(WINDOW *\fIwin\fB, int \fIattrs\fB);\fR .sp -\fBint chgat(int \fP\fIn\fP\fB, attr_t \fP\fIattr\fP\fB, short \fP\fIpair\fP\fB,\fR \fBconst void *\fP\fIopts\fP\fB);\fR +\fBint chgat(int \fIn\fB, attr_t \fIattr\fB, short \fIpair\fB,\fR \fBconst void *\fIopts\fB);\fR .br -\fBint wchgat(WINDOW *\fP\fIwin\fP\fB,\fP - \fBint \fP\fIn\fP\fB, attr_t \fP\fIattr\fP\fB,\fR \fBshort \fP\fIpair\fP\fB, const void *\fP\fIopts\fP\fB);\fR +\fBint wchgat(WINDOW *\fIwin\fB,\fR + \fBint \fIn\fB, attr_t \fIattr\fB,\fR \fBshort \fIpair\fB, const void *\fIopts\fB);\fR .br -\fBint mvchgat(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB,\fP - \fBint \fP\fIn\fP\fB, attr_t \fP\fIattr\fP\fB,\fR \fBshort \fP\fIpair\fP\fB, const void *\fP\fIopts\fP\fB);\fR +\fBint mvchgat(int \fIy\fB, int \fIx\fB,\fR + \fBint \fIn\fB, attr_t \fIattr\fB,\fR \fBshort \fIpair\fB, const void *\fIopts\fB);\fR .br -\fBint mvwchgat(WINDOW *\fP\fIwin, int \fP\fIy, int \fP\fIx\fP\fB,\fP - \fBint \fP\fIn,\fR \fBattr_t \fP\fIattr\fP\fB, short \fP\fIpair\fP\fB, const void *\fP\fIopts\fP\fB);\fR +\fBint mvwchgat(WINDOW *\fIwin, int \fIy, int \fIx\fB,\fR + \fBint \fIn,\fR \fBattr_t \fIattr\fB, short \fIpair\fB, const void *\fIopts\fB);\fR .sp -\fBint color_set(short \fP\fIpair\fP\fB, void* \fP\fIopts\fP\fB);\fR +\fBint color_set(short \fIpair\fB, void* \fIopts\fB);\fR .br -\fBint wcolor_set(WINDOW *\fP\fIwin\fP\fB, short \fP\fIpair\fP\fB,\fR \fBvoid* \fP\fIopts);\fR +\fBint wcolor_set(WINDOW *\fIwin\fB, short \fIpair\fB,\fR \fBvoid* \fIopts);\fR .sp -\fBint standend(void);\fR +\fBint standend(void);\fP .br -\fBint wstandend(WINDOW *\fP\fIwin\fP\fB);\fR +\fBint wstandend(WINDOW *\fIwin\fB);\fR .br -\fBint standout(void);\fR +\fBint standout(void);\fP .br -\fBint wstandout(WINDOW *\fP\fIwin\fP\fB);\fR +\fBint wstandout(WINDOW *\fIwin\fB);\fR .\" --------------------------------------------------------------------------- .SH DESCRIPTION -.PP These routines manipulate the current attributes of the named window, which then apply to all characters that are written into -the window with \fBwaddch\fR, \fBwaddstr\fR and \fBwprintw\fR. +the window with \fBwaddch\fP, \fBwaddstr\fP and \fBwprintw\fP. Attributes are a property of the character, and move with the character through any scrolling and insert/delete line/character operations. @@ -156,7 +156,7 @@ put on the screen. .PP These routines do not affect the attributes used when erasing portions of the window. -See \fBcurs_bkgd\fR(3X) for functions which modify the attributes used for +See \fBcurs_bkgd\fP(3X) for functions which modify the attributes used for erasing and clearing. .PP Routines which do not have a \fBWINDOW*\fP parameter apply to \fBstdscr\fP. @@ -164,7 +164,6 @@ For example, \fBattr_set\fP is the \fBstdscr\fP variant of \fBwattr_set\fP. .\" --------------------------------------------------------------------------- .SS Window attributes -.PP There are two sets of functions: .bP functions for manipulating the window attributes and color: @@ -211,7 +210,7 @@ attr_set(A_BOLD, \fIpair\fP, NULL); However, if the value does not fit, then the \fBCOLOR_PAIR\fP macro uses only the bits that fit. For example, because in ncurses \fBA_COLOR\fP has eight (8) bits, -then \fBCOLOR_PAIR(\fP\fI259\fP\fB)\fP is 4 +then \fBCOLOR_PAIR(\fI259\fB)\fR is 4 (i.e., 259 is 4 more than the limit 255). .PP The \fBPAIR_NUMBER\fP macro extracts a pair number from an \fBint\fP @@ -227,42 +226,40 @@ The \fBattrset\fP routine is a legacy feature predating SVr4 curses but kept in X/Open Curses for the same reason that SVr4 curses kept it: compatibility. .PP -The remaining \fBattr\fR* functions operate exactly like the corresponding -\fBattr_\fR* functions, except that they take arguments of type \fBint\fR -rather than \fBattr_t\fR. +The remaining \fBattr\fP* functions operate exactly like the corresponding +\fBattr_\fP* functions, except that they take arguments of type \fBint\fP +rather than \fBattr_t\fP. .PP There is no corresponding \fBattrget\fP function as such in X/Open Curses, although ncurses provides \fBgetattrs\fP (see curs_legacy(3X)). .\" --------------------------------------------------------------------------- .SS Change character rendition -.PP -The routine \fBchgat\fR changes the attributes of a given number of characters -starting at the current cursor location of \fBstdscr\fR. +The routine \fBchgat\fP changes the attributes of a given number of characters +starting at the current cursor location of \fBstdscr\fP. 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 \fBwchgat\fR function generalizes this to any window; -the \fBmvwchgat\fR function does a cursor move before acting. +The \fBwchgat\fP function generalizes this to any window; +the \fBmvwchgat\fP function does a cursor move before acting. .PP In these functions, the color \fIpair\fP argument is a color-pair index -(as in the first argument of \fBinit_pair\fR, see \fBcurs_color\fR(3X)). +(as in the first argument of \fBinit_pair\fP, see \fBcurs_color\fP(3X)). .\" --------------------------------------------------------------------------- .SS Change window color -The routine \fBcolor_set\fR sets the current color of the given window to the +The routine \fBcolor_set\fP sets the current color of the given window to the foreground/background combination described by the color \fIpair\fP parameter. .\" --------------------------------------------------------------------------- .SS Standout -.PP -The routine \fBstandout\fR is -the same as \fBattron(A_STANDOUT)\fR. -The routine \fBstandend\fR is the same -as \fBattrset(A_NORMAL)\fR or \fBattrset(0)\fR, that is, it turns off all +The routine \fBstandout\fP is +the same as \fBattron(A_STANDOUT)\fP. +The routine \fBstandend\fP is the same +as \fBattrset(A_NORMAL)\fP or \fBattrset(0)\fP, that is, it turns off all attributes. .PP -X/Open does not mark these "restricted", because +X/Open does not mark these \*(``restricted\*('', because .bP they have well established legacy use, and .bP @@ -270,29 +267,29 @@ there is no ambiguity about the way the attributes might be combined with a color pair. .\" --------------------------------------------------------------------------- .SH VIDEO ATTRIBUTES -The following video attributes, defined in \fB\fR, can be passed to -the routines \fBattron\fR, \fBattroff\fR, and \fBattrset\fR, or OR'd with the -characters passed to \fBaddch\fR (see \fBcurs_addch\fR(3X)). +The following video attributes, defined in \fB\fP, can be passed to +the routines \fBattron\fP, \fBattroff\fP, and \fBattrset\fP, or OR'd with the +characters passed to \fBaddch\fP (see \fBcurs_addch\fP(3X)). .PP .RS .TS l l _ _ _ l l . -\fIName\fR \fIDescription\fR -\fBA_NORMAL\fR Normal display (no highlight) -\fBA_STANDOUT\fR Best highlighting mode of the terminal. -\fBA_UNDERLINE\fR Underlining -\fBA_REVERSE\fR Reverse video -\fBA_BLINK\fR Blinking -\fBA_DIM\fR Half bright -\fBA_BOLD\fR Extra bright or bold -\fBA_PROTECT\fR Protected mode -\fBA_INVIS\fR Invisible or blank mode -\fBA_ALTCHARSET\fR Alternate character set -\fBA_ITALIC\fR Italics (non-X/Open extension) -\fBA_CHARTEXT\fR Bit-mask to extract a character -\fBA_COLOR\fR Bit-mask to extract a color (legacy routines) +\fBName\fP \fBDescription\fP +\fBA_NORMAL\fP Normal display (no highlight) +\fBA_STANDOUT\fP Best highlighting mode of the terminal. +\fBA_UNDERLINE\fP Underlining +\fBA_REVERSE\fP Reverse video +\fBA_BLINK\fP Blinking +\fBA_DIM\fP Half bright +\fBA_BOLD\fP Extra bright or bold +\fBA_PROTECT\fP Protected mode +\fBA_INVIS\fP Invisible or blank mode +\fBA_ALTCHARSET\fP Alternate character set +\fBA_ITALIC\fP Italics (non-X/Open extension) +\fBA_CHARTEXT\fP Bit-mask to extract a character +\fBA_COLOR\fP Bit-mask to extract a color (legacy routines) .TE .RE .PP @@ -303,26 +300,26 @@ These video attributes are supported by \fBattr_on\fP and related functions l l _ _ _ l l . -\fIName\fR \fIDescription\fR -\fBWA_HORIZONTAL\fR Horizontal highlight -\fBWA_LEFT\fR Left highlight -\fBWA_LOW\fR Low highlight -\fBWA_RIGHT\fR Right highlight -\fBWA_TOP\fR Top highlight -\fBWA_VERTICAL\fR Vertical highlight +\fBName\fP \fBDescription\fP +\fBWA_HORIZONTAL\fP Horizontal highlight +\fBWA_LEFT\fP Left highlight +\fBWA_LOW\fP Low highlight +\fBWA_RIGHT\fP Right highlight +\fBWA_TOP\fP Top highlight +\fBWA_VERTICAL\fP Vertical highlight .TE .RE .PP The return values of many of these routines are not meaningful (they are implemented as macro-expanded assignments and simply return their argument). -The SVr4 manual page claims (falsely) that these routines always return \fB1\fR. +The SVr4 manual page claims (falsely) that these routines always return \fB1\fP. .\" --------------------------------------------------------------------------- .SH NOTES These functions may be macros: .sp .RS -\fBattroff\fR, \fBwattroff\fR, \fBattron\fR, \fBwattron\fR, -\fBattrset\fR, \fBwattrset\fR, \fBstandend\fR and \fBstandout\fR. +\fBattroff\fP, \fBwattroff\fP, \fBattron\fP, \fBwattron\fP, +\fBattrset\fP, \fBwattrset\fP, \fBstandend\fP and \fBstandout\fP. .RE .PP Color pair values can only be OR'd with attributes if the pair @@ -395,7 +392,7 @@ but not necessarily the reverse. l l l l l l _ _ _ _ _ _ l l l l l l . -\fIYear\fR \fISystem\fR \fIArch\fP \fIColor\fR \fIChar\fR \fINotes\fR +\fBYear\fP \fBSystem\fP \fBArch\fP \fBColor\fP \fBChar\fP \fBNotes\fP 1992 Solaris 5.2 32 6 17 SVr4 curses 1992 HPUX 9 32 no 8 SVr2 curses 1992 AIX 3.2 32 no 23 SVr2 curses @@ -458,7 +455,7 @@ members are not specified in X/Open Curses) could be extended as needed. Other interfaces are rarely used now: .bP BSD curses was improved slightly in 1993/1994 using Keith Bostic's -modification to make the library 8-bit clean for \fBnvi\fP. +modification to make the library 8-bit clean for \fBnvi\fP(1). He moved \fIstandout\fP attribute to a structure member. .IP The resulting 4.4BSD curses was replaced by ncurses over the next ten years. @@ -466,7 +463,6 @@ The resulting 4.4BSD curses was replaced by ncurses over the next ten years. U/Win is rarely used now. .\" --------------------------------------------------------------------------- .SH EXTENSIONS -.PP This implementation provides the \fBA_ITALIC\fP attribute for terminals which have the \fBenter_italics_mode\fP (\fBsitm\fP) and \fBexit_italics_mode\fP (\fBritm\fP) capabilities. @@ -483,7 +479,7 @@ This implementation uses that parameter in ABI 6 for the functions which have a color-pair parameter to support \fIextended color pairs\fP: .bP For functions which modify the color, e.g., -\fBwattr_set\fP, +\fBwattr_set\fP and \fBwattr_on\fP, if \fIopts\fP is set it is treated as a pointer to \fBint\fP, and used to set the color pair instead of the \fBshort\fP \fIpair\fP parameter. .bP @@ -491,42 +487,42 @@ For functions which retrieve the color, e.g., \fBwattr_get\fP, if \fIopts\fP is set it is treated as a pointer to \fBint\fP, and used to retrieve the color pair as an \fBint\fP value, -in addition +in addition to retrieving it via the standard pointer to \fBshort\fP parameter. -.PP -The remaining functions which have \fIopts\fP, -but do not manipulate color, -e.g., \fBwattr_on\fP and \fBwattr_off\fP -are not used by this implementation except to check that they are \fBNULL\fP. +.bP +For functions which turn attributes off, e.g., +\fBwattr_off\fP, +the \fIopts\fP parameter is ignored except +except to check that it is \fBNULL\fP. .\" --------------------------------------------------------------------------- .SH PORTABILITY These functions are supported in the XSI Curses standard, Issue 4. The standard defined the dedicated type for highlights, -\fBattr_t\fR, which was not defined in SVr4 curses. -The functions taking \fBattr_t\fR arguments were not supported under SVr4. +\fBattr_t\fP, which was not defined in SVr4 curses. +The functions taking \fBattr_t\fP arguments were not supported under SVr4. .PP Very old versions of this library did not force an update of the screen when changing the attributes. -Use \fBtouchwin\fR to force the screen to match the updated attributes. +Use \fBtouchwin\fP to force the screen to match the updated attributes. .PP The XSI Curses standard states that whether the traditional functions -\fBattron\fR/\fBattroff\fR/\fBattrset\fR can manipulate attributes other than -\fBA_BLINK\fR, \fBA_BOLD\fR, \fBA_DIM\fR, \fBA_REVERSE\fR, \fBA_STANDOUT\fR, or -\fBA_UNDERLINE\fR is "unspecified". +\fBattron\fP/\fBattroff\fP/\fBattrset\fP can manipulate attributes other than +\fBA_BLINK\fP, \fBA_BOLD\fP, \fBA_DIM\fP, \fBA_REVERSE\fP, \fBA_STANDOUT\fP, or +\fBA_UNDERLINE\fP is \*(``unspecified\*(''. Under this implementation as well as SVr4 curses, these functions correctly manipulate all other highlights -(specifically, \fBA_ALTCHARSET\fR, \fBA_PROTECT\fR, and \fBA_INVIS\fR). +(specifically, \fBA_ALTCHARSET\fP, \fBA_PROTECT\fP, and \fBA_INVIS\fP). .PP XSI Curses added these entry points: .sp .RS -\fBattr_get\fR, \fBattr_on\fR, -\fBattr_off\fR, \fBattr_set\fR, \fBwattr_on\fR, \fBwattr_off\fR, -\fBwattr_get\fR, \fBwattr_set\fR +\fBattr_get\fP, \fBattr_on\fP, +\fBattr_off\fP, \fBattr_set\fP, \fBwattr_on\fP, \fBwattr_off\fP, +\fBwattr_get\fP, \fBwattr_set\fP .RE .PP The new functions are intended to work with -a new series of highlight macros prefixed with \fBWA_\fR. +a new series of highlight macros prefixed with \fBWA_\fP. The older macros have direct counterparts in the newer set of names: .PP .RS @@ -535,15 +531,15 @@ The older macros have direct counterparts in the newer set of names: l l _ _ _ l l . -\fIName\fR \fIDescription\fR -\fBWA_NORMAL\fR Normal display (no highlight) -\fBWA_STANDOUT\fR Best highlighting mode of the terminal. -\fBWA_UNDERLINE\fR Underlining -\fBWA_REVERSE\fR Reverse video -\fBWA_BLINK\fR Blinking -\fBWA_DIM\fR Half bright -\fBWA_BOLD\fR Extra bright or bold -\fBWA_ALTCHARSET\fR Alternate character set +\fBName\fP \fBDescription\fP +\fBWA_NORMAL\fP Normal display (no highlight) +\fBWA_STANDOUT\fP Best highlighting mode of the terminal. +\fBWA_UNDERLINE\fP Underlining +\fBWA_REVERSE\fP Reverse video +\fBWA_BLINK\fP Blinking +\fBWA_DIM\fP Half bright +\fBWA_BOLD\fP Extra bright or bold +\fBWA_ALTCHARSET\fP Alternate character set .TE .RE .PP @@ -551,8 +547,8 @@ 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.: .bP -The XSI curses standard specifies that each pair of corresponding \fBA_\fR -and \fBWA_\fR-using functions operates on the same current-highlight +The XSI curses standard specifies that each pair of corresponding \fBA_\fP +and \fBWA_\fP-using functions operates on the same current-highlight information. .bP However, in some implementations, those symbols have unrelated values. @@ -567,16 +563,29 @@ represent \fBA_CHARTEXT\fP or \fBA_COLOR\fP. In this implementation (as in many others), the values happen to be the same because it simplifies copying information between \fBchtype\fP and \fBcchar_t\fP variables. +.bP +Because ncurses's \fBattr_t\fP can hold a color pair +(in the \fBA_COLOR\fP field), +a call to +\fBwattr_on\fP, +\fBwattr_off\fP, or +\fBwattr_set\fP +may alter the window's color. +If the color pair information in the attribute parameter is zero, +no change is made to the window's color. +.IP +This is consistent with SVr4 curses; +X/Open Curses does not specify this. .PP The XSI standard extended conformance level adds new highlights -\fBA_HORIZONTAL\fR, \fBA_LEFT\fR, \fBA_LOW\fR, \fBA_RIGHT\fR, \fBA_TOP\fR, -\fBA_VERTICAL\fR (and corresponding \fBWA_\fR macros for each). +\fBA_HORIZONTAL\fP, \fBA_LEFT\fP, \fBA_LOW\fP, \fBA_RIGHT\fP, \fBA_TOP\fP, +\fBA_VERTICAL\fP (and corresponding \fBWA_\fP macros for each). As of August 2013, no known terminal provides these highlights (i.e., via the \fBsgr1\fP capability). .\" --------------------------------------------------------------------------- .SH RETURN VALUE -All routines return the integer \fBOK\fR on success, or \fBERR\fP on failure. +All routines return the integer \fBOK\fP on success, or \fBERR\fP on failure. .PP X/Open does not define any error conditions. .PP @@ -590,15 +599,15 @@ for \fBwcolor_set\fP is outside the range 0..COLOR_PAIRS\-1. does not return an error if either of the parameters of \fBwattr_get\fP used for retrieving attribute or color-pair values is \fBNULL\fP. .PP -Functions with a "mv" prefix first perform a cursor movement using +Functions with a \*(``mv\*('' prefix first perform a cursor movement using \fBwmove\fP, and return an error if the position is outside the window, or if the window pointer is null. .\" --------------------------------------------------------------------------- .SH SEE ALSO .na -\fBcurses\fR(3X), -\fBcurs_addch\fR(3X), -\fBcurs_addstr\fR(3X), -\fBcurs_bkgd\fR(3X), -\fBcurs_printw\fR(3X), -\fBcurs_variables\fR(3X) +\fBcurses\fP(3X), +\fBcurs_addch\fP(3X), +\fBcurs_addstr\fP(3X), +\fBcurs_bkgd\fP(3X), +\fBcurs_printw\fP(3X), +\fBcurs_variables\fP(3X)