contrib/ncurses-5.4/doc/html/man/curs_attr.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   * t
   4   ****************************************************************************
   5   * Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
   6   *                                                                          *
   7   * Permission is hereby granted, free of charge, to any person obtaining a  *
   8   * copy of this software and associated documentation files (the            *
   9   * "Software"), to deal in the Software without restriction, including      *
  10   * without limitation the rights to use, copy, modify, merge, publish,      *
  11   * distribute, distribute with modifications, sublicense, and/or sell       *
  12   * copies of the Software, and to permit persons to whom the Software is    *
  13   * furnished to do so, subject to the following conditions:                 *
  14   *                                                                          *
  15   * The above copyright notice and this permission notice shall be included  *
  16   * in all copies or substantial portions of the Software.                   *
  17   *                                                                          *
  18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  25   *                                                                          *
  26   * Except as contained in this notice, the name(s) of the above copyright   *
  27   * holders shall not be used in advertising or otherwise to promote the     *
  28   * sale, use or other dealings in this Software without prior written       *
  29   * authorization.                                                           *
  30   ****************************************************************************
  31   * @Id: curs_attr.3x,v 1.27 2003/12/27 18:50:51 tom Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>curs_attr 3x</TITLE>
  36 <link rev=made href="mailto:bug-ncurses@gnu.org">
  37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  38 </HEAD>
  39 <BODY>
  40 <H1>curs_attr 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44 <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>                                       <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2>NAME</H2><PRE>
  51        <STRONG>attroff</STRONG>,  <STRONG>wattroff</STRONG>,  <STRONG>attron</STRONG>,  <STRONG>wattron</STRONG>,  <STRONG>attrset</STRONG>, <STRONG>wattrset</STRONG>,
  52        <STRONG>color_set</STRONG>,  <STRONG>wcolor_set</STRONG>,  <STRONG>standend</STRONG>,  <STRONG>wstandend</STRONG>,   <STRONG>standout</STRONG>,
  53        <STRONG>wstandout</STRONG>,   <STRONG>attr_get</STRONG>,   <STRONG>wattr_get</STRONG>,  <STRONG>attr_off</STRONG>,  <STRONG>wattr_off</STRONG>,
  54        <STRONG>attr_on</STRONG>, <STRONG>wattr_on</STRONG>,  <STRONG>attr_set</STRONG>,  <STRONG>wattr_set</STRONG>,  <STRONG>chgat</STRONG>,  <STRONG>wchgat</STRONG>,
  55        <STRONG>mvchgat</STRONG>, <STRONG>mvwchgat</STRONG>, <STRONG>PAIR_NUMBER</STRONG> - <STRONG>curses</STRONG> character and win-
  56        dow attribute control routines
  57
  58
  59 </PRE>
  60 <H2>SYNOPSIS</H2><PRE>
  61        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  62        <STRONG>int</STRONG> <STRONG>attroff(int</STRONG> <STRONG>attrs);</STRONG>
  63        <STRONG>int</STRONG> <STRONG>wattroff(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG>
  64        <STRONG>int</STRONG> <STRONG>attron(int</STRONG> <STRONG>attrs);</STRONG>
  65        <STRONG>int</STRONG> <STRONG>wattron(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG>
  66        <STRONG>int</STRONG> <STRONG>attrset(int</STRONG> <STRONG>attrs);</STRONG>
  67        <STRONG>int</STRONG> <STRONG>wattrset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG>
  68        <STRONG>int</STRONG> <STRONG>color_set(short</STRONG> <STRONG>color_pair_number,</STRONG> <STRONG>void*</STRONG> <STRONG>opts);</STRONG>
  69        <STRONG>int</STRONG> <STRONG>wcolor_set(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>short</STRONG> <STRONG>color_pair_number,</STRONG>
  70              <STRONG>void*</STRONG> <STRONG>opts);</STRONG>
  71        <STRONG>int</STRONG> <STRONG>standend(void);</STRONG>
  72        <STRONG>int</STRONG> <STRONG>wstandend(WINDOW</STRONG> <STRONG>*win);</STRONG>
  73        <STRONG>int</STRONG> <STRONG>standout(void);</STRONG>
  74        <STRONG>int</STRONG> <STRONG>wstandout(WINDOW</STRONG> <STRONG>*win);</STRONG>
  75        <STRONG>int</STRONG> <STRONG>attr_get(attr_t</STRONG> <STRONG>*attrs,</STRONG> <STRONG>short</STRONG> <STRONG>*pair,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  76        <STRONG>int</STRONG> <STRONG>wattr_get(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>*attrs,</STRONG> <STRONG>short</STRONG> <STRONG>*pair,</STRONG>
  77               <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  78        <STRONG>int</STRONG> <STRONG>attr_off(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  79        <STRONG>int</STRONG> <STRONG>wattr_off(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  80        <STRONG>int</STRONG> <STRONG>attr_on(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  81        <STRONG>int</STRONG> <STRONG>wattr_on(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  82        <STRONG>int</STRONG> <STRONG>attr_set(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>short</STRONG> <STRONG>pair,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  83        <STRONG>int</STRONG> <STRONG>wattr_set(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>short</STRONG> <STRONG>pair,</STRONG>  <STRONG>void</STRONG>
  84        <STRONG>*opts);</STRONG>
  85        <STRONG>int</STRONG> <STRONG>chgat(int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> <STRONG>short</STRONG> <STRONG>color,</STRONG>
  86              <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
  87        <STRONG>int</STRONG> <STRONG>wchgat(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG>
  88              <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
  89        <STRONG>int</STRONG> <STRONG>mvchgat(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG>
  90              <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
  91        <STRONG>int</STRONG> <STRONG>mvwchgat(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG>
  92              <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
  93
  94
  95 </PRE>
  96 <H2>DESCRIPTION</H2><PRE>
  97        These  routines  manipulate  the current attributes of the
  98        named window.  The current attributes of a window apply to
  99        all  characters that are written into the window with <STRONG>wad-</STRONG>
 100        <STRONG>dch</STRONG>, <STRONG>waddstr</STRONG> and <STRONG>wprintw</STRONG>.  Attributes are  a  property  of
 101        the  character,  and  move  with the character through any
 102        scrolling and insert/delete line/character operations.  To
 103        the  extent  possible,  they  are displayed as appropriate
 104        modifications to the graphic rendition of  characters  put
 105        on the screen.
 106
 107        The  routine  <STRONG>attrset</STRONG>  sets  the current attributes of the
 108        given window to <EM>attrs</EM>.  The routine <STRONG>attroff</STRONG> turns off  the
 109        named  attributes  without turning any other attributes on
 110        or off.  The routine <STRONG>attron</STRONG> turns on the named  attributes
 111        without affecting any others.  The routine <STRONG>standout</STRONG> is the
 112        same as <STRONG>attron(A_STANDOUT)</STRONG>.  The routine <STRONG>standend</STRONG>  is  the
 113        same as <STRONG>attrset(A_NORMAL)</STRONG> or <STRONG>attrset(0)</STRONG>, that is, it turns
 114        off all attributes.
 115
 116        The  <STRONG>attrset</STRONG>  and  related  routines  do  not  affect  the
 117        attributes  used when erasing portions of the window.  See
 118        <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG> for functions which  modify  the  attributes
 119        used for erasing and clearing.
 120
 121        The  routine <STRONG>color_set</STRONG> sets the current color of the given
 122        window to the foreground/background combination  described
 123        by  the  color_pair_number. The parameter opts is reserved
 124        for future use, applications must supply a null pointer.
 125
 126        The routine <STRONG>wattr_get</STRONG> returns the  current  attribute  and
 127        color pair for the given window; <STRONG>attr_get</STRONG> returns the cur-
 128        rent attribute and color pair for <STRONG>stdscr</STRONG>.   The  remaining
 129        <STRONG>attr_</STRONG>*  functions  operate  exactly like the corresponding
 130        <STRONG>attr</STRONG>* functions, except that they take arguments  of  type
 131        <STRONG>attr_t</STRONG> rather than <STRONG>int</STRONG>.
 132
 133        The routine <STRONG>chgat</STRONG> changes the attributes of a given number
 134        of characters starting at the current cursor  location  of
 135        <STRONG>stdscr</STRONG>.   It  does not update the cursor and does not per-
 136        form wrapping.  A character count of -1  or  greater  than
 137        the  remaining window width means to change attributes all
 138        the way to the end of the current line.  The <STRONG>wchgat</STRONG>  func-
 139        tion generalizes this to any window; the <STRONG>mvwchgat</STRONG> function
 140        does a cursor move before acting.  In these functions, the
 141        color  argument  is  a  color-pair  index (as in the first
 142        argument of  <EM>init</EM><STRONG>_</STRONG><EM>pair</EM>,  see  <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>).   The  <STRONG>opts</STRONG>
 143        argument  is  not  presently used, but is reserved for the
 144        future (leave it <STRONG>NULL</STRONG>).  Note that changing the attributes
 145        does  not  imply that a subsequent <STRONG>refresh</STRONG> will update the
 146        screen to match, since the character values are not  modi-
 147        fied.   Use  <STRONG>touchwin</STRONG>  to  force  the  screen to match the
 148        updated attributes.
 149
 150    <STRONG>Attributes</STRONG>
 151        The following video attributes, defined in <STRONG>&lt;curses.h&gt;</STRONG>, can
 152        be passed to the routines <STRONG>attron</STRONG>, <STRONG>attroff</STRONG>, and <STRONG>attrset</STRONG>, or
 153        OR'ed with the characters passed to <STRONG>addch</STRONG>.
 154
 155         <STRONG>A_NORMAL</STRONG>        Normal display (no highlight)
 156         <STRONG>A_STANDOUT</STRONG>      Best highlighting mode of the terminal.
 157         <STRONG>A_UNDERLINE</STRONG>     Underlining
 158         <STRONG>A_REVERSE</STRONG>       Reverse video
 159         <STRONG>A_BLINK</STRONG>         Blinking
 160         <STRONG>A_DIM</STRONG>           Half bright
 161         <STRONG>A_BOLD</STRONG>          Extra bright or bold
 162         <STRONG>A_PROTECT</STRONG>       Protected mode
 163         <STRONG>A_INVIS</STRONG>         Invisible or blank mode
 164         <STRONG>A_ALTCHARSET</STRONG>    Alternate character set
 165         <STRONG>A_CHARTEXT</STRONG>      Bit-mask to extract a character
 166         <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG>   Color-pair number <EM>n</EM>
 167
 168        The following macro is the reverse of <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG>:
 169
 170        <STRONG>PAIR_NUMBER(</STRONG><EM>attrs</EM>) Returns the pair number associated
 171                           with the <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG> attribute.
 172
 173        The return values of many of these routines are not  mean-
 174        ingful (they are implemented as macro-expanded assignments
 175        and simply return their argument).  The SVr4  manual  page
 176        claims (falsely) that these routines always return <STRONG>1</STRONG>.
 177
 178
 179 </PRE>
 180 <H2>NOTES</H2><PRE>
 181        Note  that  <STRONG>attroff</STRONG>,  <STRONG>wattroff</STRONG>,  <STRONG>attron</STRONG>, <STRONG>wattron</STRONG>, <STRONG>attrset</STRONG>,
 182        <STRONG>wattrset</STRONG>, <STRONG>standend</STRONG> and <STRONG>standout</STRONG> may be macros.
 183
 184
 185 </PRE>
 186 <H2>PORTABILITY</H2><PRE>
 187        All these functions are supported in the XSI Curses  stan-
 188        dard,  Issue  4.   The standard defined the dedicated type
 189        for highlights, <STRONG>attr_t</STRONG>,  which  is  not  defined  in  SVr4
 190        curses. The functions taking <STRONG>attr_t</STRONG> arguments are not sup-
 191        ported under SVr4.
 192
 193        The XSI Curses standard states  that  whether  the  tradi-
 194        tional  functions  <STRONG>attron</STRONG>/<STRONG>attroff</STRONG>/<STRONG>attrset</STRONG>  can  manipulate
 195        attributes other than <STRONG>A_BLINK</STRONG>, <STRONG>A_BOLD</STRONG>,  <STRONG>A_DIM</STRONG>,  <STRONG>A_REVERSE</STRONG>,
 196        <STRONG>A_STANDOUT</STRONG>,  or  <STRONG>A_UNDERLINE</STRONG> is "unspecified".  Under this
 197        implementation as well as  SVr4  curses,  these  functions
 198        correctly  manipulate  all other highlights (specifically,
 199        <STRONG>A_ALTCHARSET</STRONG>, <STRONG>A_PROTECT</STRONG>, and <STRONG>A_INVIS</STRONG>).
 200
 201        XSI Curses added the new entry points, <STRONG>attr_get</STRONG>,  <STRONG>attr_on</STRONG>,
 202        <STRONG>attr_off</STRONG>,   <STRONG>attr_set</STRONG>,   <STRONG>wattr_on</STRONG>,   <STRONG>wattr_off</STRONG>,  <STRONG>wattr_get</STRONG>,
 203        <STRONG>wattr_set</STRONG>.  These are intended to work with a  new  series
 204        of highlight macros prefixed with <STRONG>WA_</STRONG>.
 205
 206         <STRONG>WA_NORMAL</STRONG>       Normal display (no highlight)
 207         <STRONG>WA_STANDOUT</STRONG>     Best highlighting mode of the terminal.
 208         <STRONG>WA_UNDERLINE</STRONG>    Underlining
 209         <STRONG>WA_REVERSE</STRONG>      Reverse video
 210         <STRONG>WA_BLINK</STRONG>        Blinking
 211         <STRONG>WA_DIM</STRONG>          Half bright
 212         <STRONG>WA_BOLD</STRONG>         Extra bright or bold
 213         <STRONG>WA_ALTCHARSET</STRONG>   Alternate character set
 214
 215        The XSI curses standard specifies that each pair of corre-
 216        sponding <STRONG>A_</STRONG> and <STRONG>WA_</STRONG>-using functions operates on  the  same
 217        current-highlight information.
 218
 219        The XSI standard extended conformance level adds new high-
 220        lights <STRONG>A_HORIZONTAL</STRONG>, <STRONG>A_LEFT</STRONG>, <STRONG>A_LOW</STRONG>, <STRONG>A_RIGHT</STRONG>, <STRONG>A_TOP</STRONG>, <STRONG>A_VER-</STRONG>
 221        <STRONG>TICAL</STRONG>  (and  corresponding <STRONG>WA_</STRONG> macros for each) which this
 222        curses does not yet support.
 223
 224
 225 </PRE>
 226 <H2>SEE ALSO</H2><PRE>
 227        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,        <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>,        <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>,
 228        <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>, <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>
 229
 230
 231
 232                                                     <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
 233 </PRE>
 234 <HR>
 235 <ADDRESS>
 236 Man(1) output converted with
 237 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 238 </ADDRESS>
 239 </BODY>
 240 </HTML>