X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_attr.3x.html;h=9a7b2a46963e9064a4789786f29c6687d132b9b1;hp=80ddcc99a8aeb61d4a3f39a9d7e9c099101657b7;hb=ca276baf720e3a44721b9e18955d3f546955c6c8;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_attr.3x.html b/doc/html/man/curs_attr.3x.html index 80ddcc99..9a7b2a46 100644 --- a/doc/html/man/curs_attr.3x.html +++ b/doc/html/man/curs_attr.3x.html @@ -2,7 +2,7 @@ @@ -41,19 +41,19 @@ 
 
-curs_attr(3x)                                       curs_attr(3x)
+curs_attr(3x)                                             curs_attr(3x)

NAME

-       attroff,  wattroff,  attron,  wattron,  attrset, wattrset,
-       color_set,  wcolor_set,  standend,  wstandend,   standout,
-       wstandout,   attr_get,   wattr_get,  attr_off,  wattr_off,
-       attr_on, wattr_on,  attr_set,  wattr_set,  chgat,  wchgat,
-       mvchgat, mvwchgat, PAIR_NUMBER - curses character and win-
-       dow attribute control routines
+       attroff, wattroff, attron, wattron, attrset, wattrset,
+       color_set, wcolor_set, standend, wstandend, standout,
+       wstandout, attr_get, wattr_get, attr_off, wattr_off,
+       attr_on, wattr_on, attr_set, wattr_set, chgat, wchgat,
+       mvchgat, mvwchgat, PAIR_NUMBER - curses character and
+       window attribute control routines
@@ -96,9 +96,9 @@

DESCRIPTION

        These  routines  manipulate  the current attributes of the
        named window.  The current attributes of a window apply to
-       all  characters that are written into the window with wad-
-       dch, waddstr and wprintw.  Attributes are  a  property  of
-       the  character,  and  move  with the character through any
+       all characters that are written into the window with wadd-
+       ch, waddstr and wprintw.  Attributes are a property of the
+       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
@@ -113,8 +113,8 @@
        same as attrset(A_NORMAL) or attrset(0), that is, it turns
        off all attributes.
 
-       The  attrset  and  related  routines  do  not  affect  the
-       attributes  used when erasing portions of the window.  See
+       The attrset and related routines do  not  affect  the  at-
+       tributes  used  when  erasing portions of the window.  See
        curs_bkgd(3x) for functions which  modify  the  attributes
        used for erasing and clearing.
 
@@ -138,19 +138,16 @@
        the way to the end of the current line.  The wchgat  func-
        tion generalizes this to any window; the mvwchgat function
        does a cursor move before acting.  In these functions, the
-       color  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).  Note that changing the attributes
-       does  not  imply that a subsequent refresh will update the
-       screen to match, since the character values are not  modi-
-       fied.   Use  touchwin  to  force  the  screen to match the
-       updated attributes.
+       color  argument is a color-pair index (as in the first ar-
+       gument of init_pair, see curs_color(3x)).  The opts  argu-
+       ment is not presently used, but is reserved for the future
+       (leave it NULL).
 
    Attributes
        The following video attributes, defined in <curses.h>, can
        be passed to the routines attron, attroff, and attrset, or
-       OR'ed with the characters passed to addch.
+       OR'd with the characters passed to addch.
+
 
         A_NORMAL        Normal display (no highlight)
         A_STANDOUT      Best highlighting mode of the terminal.
@@ -181,27 +178,39 @@
        Note  that  attroff,  wattroff,  attron, wattron, attrset,
        wattrset, standend and standout may be macros.
 
+       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.
+

PORTABILITY

-       All these functions are supported in the XSI Curses  stan-
-       dard,  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 sup-
-       ported under SVr4.
-
-       The XSI Curses standard states  that  whether  the  tradi-
-       tional  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,
+       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
+       under SVr4.
+
+       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,
        A_ALTCHARSET, A_PROTECT, and A_INVIS).
 
-       XSI Curses added the new entry points, attr_get,  attr_on,
-       attr_off,   attr_set,   wattr_on,   wattr_off,  wattr_get,
-       wattr_set.  These are intended to work with a  new  series
-       of highlight macros prefixed with WA_.
+       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_.
+
+       Older 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.
+
 
         WA_NORMAL       Normal display (no highlight)
         WA_STANDOUT     Best highlighting mode of the terminal.
@@ -213,13 +222,27 @@
         WA_ALTCHARSET   Alternate character set
 
        The XSI curses standard specifies that each pair of corre-
-       sponding A_ and WA_-using functions operates on  the  same
+       sponding  A_  and WA_-using functions operates on the same
        current-highlight information.
 
        The XSI standard extended conformance level adds new high-
        lights A_HORIZONTAL, A_LEFT, A_LOW, A_RIGHT, A_TOP, A_VER-
-       TICAL  (and  corresponding WA_ macros for each) which this
-       curses does not yet support.
+       TICAL (and corresponding WA_ macros for each)  which  this
+       implementation does not yet support.
+
+
+
+

RETURN VALUE

+       All  routines  return the integer OK on success, or ERR on
+       failure.
+
+       X/Open does not define any error conditions.
+
+       This implementation returns an error if the window pointer
+       is  null.  The wcolor_set function returns an error if the
+       color  pair  parameter  is  outside  the   range   0..COL-
+       OR_PAIRS-1.   This  implementation  also provides getattrs
+       for compatibility with older versions of curses.
@@ -229,7 +252,7 @@ - curs_attr(3x) + curs_attr(3x)