Ada95/html/man/curs_attr.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4        <STRONG>attroff</STRONG>,  <STRONG>wattroff</STRONG>,  <STRONG>attron</STRONG>,  <STRONG>wattron</STRONG>,  <STRONG>attrset</STRONG>, <STRONG>wattrset</STRONG>,
   5        <STRONG>color_set</STRONG>,  <STRONG>wcolor_set</STRONG>,  <STRONG>standend</STRONG>,  <STRONG>wstandend</STRONG>,   <STRONG>standout</STRONG>,
   6        <STRONG>wstandout</STRONG>  - <STRONG>curses</STRONG> character and window attribute control
   7        routines
   8
   9
  10 </PRE>
  11 <H2>SYNOPSIS</H2><PRE>
  12        <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
  13        <STRONG>int</STRONG> <STRONG>attroff(int</STRONG> <STRONG>attrs);</STRONG>
  14        <STRONG>int</STRONG> <STRONG>wattroff(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG>
  15        <STRONG>int</STRONG> <STRONG>attron(int</STRONG> <STRONG>attrs);</STRONG>
  16        <STRONG>int</STRONG> <STRONG>wattron(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG>
  17        <STRONG>int</STRONG> <STRONG>attrset(int</STRONG> <STRONG>attrs);</STRONG>
  18        <STRONG>int</STRONG> <STRONG>wattrset(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>attrs);</STRONG>
  19        <STRONG>int</STRONG> <STRONG>color_set(short</STRONG> <STRONG>color_pair_number,</STRONG> <STRONG>void*</STRONG> <STRONG>opts);</STRONG>
  20        <STRONG>int</STRONG> <STRONG>wcolor_set(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>short</STRONG> <STRONG>color_pair_number,</STRONG>
  21              <STRONG>void*</STRONG> <STRONG>opts);</STRONG>
  22        <STRONG>int</STRONG> <STRONG>standend(void);</STRONG>
  23        <STRONG>int</STRONG> <STRONG>wstandend(WINDOW</STRONG> <STRONG>*win);</STRONG>
  24        <STRONG>int</STRONG> <STRONG>standout(void);</STRONG>
  25        <STRONG>int</STRONG> <STRONG>wstandout(WINDOW</STRONG> <STRONG>*win);</STRONG>
  26        <STRONG>int</STRONG> <STRONG>attr_get(attr_t</STRONG> <STRONG>*attrs,</STRONG> <STRONG>short</STRONG> <STRONG>*pair,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  27        <STRONG>int</STRONG> <STRONG>wattr_get(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>*attrs,</STRONG> <STRONG>short</STRONG> <STRONG>*pair,</STRONG>
  28               <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  29        <STRONG>int</STRONG> <STRONG>attr_off(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  30        <STRONG>int</STRONG> <STRONG>wattr_off(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  31        <STRONG>int</STRONG> <STRONG>attr_on(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  32        <STRONG>int</STRONG> <STRONG>wattr_on(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  33        <STRONG>int</STRONG> <STRONG>attr_set(attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  34        <STRONG>int</STRONG> <STRONG>wattr_set(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attrs,</STRONG> <STRONG>void</STRONG> <STRONG>*opts);</STRONG>
  35        <STRONG>int</STRONG> <STRONG>chgat(int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> <STRONG>short</STRONG> <STRONG>color,</STRONG>
  36              <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
  37        <STRONG>int</STRONG> <STRONG>wchgat(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n,</STRONG> <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG>
  38              <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
  39        <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>
  40              <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
  41        <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>
  42              <STRONG>attr_t</STRONG> <STRONG>attr,</STRONG> <STRONG>short</STRONG> <STRONG>color,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*opts)</STRONG>
  43
  44
  45 </PRE>
  46 <H2>DESCRIPTION</H2><PRE>
  47        These routines manipulate the current  attributes  of  the
  48        named window.  The current attributes of a window apply to
  49        all characters that are written into the window with  <STRONG>wad-</STRONG>
  50        <STRONG>dch</STRONG>,  <STRONG>waddstr</STRONG>  and  <STRONG>wprintw</STRONG>.  Attributes are a property of
  51        the character, and move with  the  character  through  any
  52        scrolling and insert/delete line/character operations.  To
  53        the extent possible, they  are  displayed  as  appropriate
  54        modifications  to  the graphic rendition of characters put
  55        on the screen.
  56
  57        The routine <STRONG>attrset</STRONG> sets the  current  attributes  of  the
  58        given  window to <EM>attrs</EM>.  The routine <STRONG>attroff</STRONG> turns off the
  59        named attributes without turning any other  attributes  on
  60        same  as  <STRONG>attron(A_STANDOUT)</STRONG>.  The routine <STRONG>standend</STRONG> is the
  61        same as <STRONG>attrset(A_NORMAL)</STRONG> or <STRONG>attrset(0)</STRONG>, that is, it turns
  62        off all attributes.
  63
  64        The  routine <STRONG>color_set</STRONG> sets the current color of the given
  65        window to the foreground/background combination  described
  66        by  the  color_pair_number. The parameter opts is reserved
  67        for future use, applications must supply a null pointer.
  68
  69        The routine <STRONG>wattr_get</STRONG> returns the  current  attribute  and
  70        color pair for the given window; <STRONG>attr_get</STRONG> returns the cur-
  71        rent attribute and color pair for <STRONG>stdscr</STRONG>.   The  remaining
  72        <STRONG>attr_</STRONG>*  functions  operate  exactly like the corresponding
  73        <STRONG>attr</STRONG>* functions, except that they take arguments  of  type
  74        <STRONG>attr_t</STRONG> rather than <STRONG>int</STRONG>.
  75
  76        The routine <STRONG>chgat</STRONG> changes the attributes of a given number
  77        of characters starting at the current cursor  location  of
  78        <STRONG>stdscr</STRONG>.   It  does not update the cursor and does not per-
  79        form wrapping.  A character count of -1  or  greater  than
  80        the  remaining window width means to change attributes all
  81        the way to the end of the current line.  The <STRONG>wchgat</STRONG>  func-
  82        tion generalizes this to any window; the <STRONG>mvwchgat</STRONG> function
  83        does a cursor move before acting.  In these functions, the
  84        color  argument  is  a  color-pair  index (as in the first
  85        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>
  86        argument  is  not  presently used, but is reserved for the
  87        future (leave it <STRONG>NULL</STRONG>).
  88
  89    <STRONG>Attributes</STRONG>
  90        The following video attributes, defined in <STRONG><curses.h></STRONG>, can
  91        be passed to the routines <STRONG>attron</STRONG>, <STRONG>attroff</STRONG>, and <STRONG>attrset</STRONG>, or
  92        OR'ed with the characters passed to <STRONG>addch</STRONG>.
  93
  94        center ; l l .  <STRONG>A_NORMAL</STRONG>  Normal  display  (no  highlight)
  95        <STRONG>A_STANDOUT</STRONG>     Best  highlighting  mode  of  the terminal.
  96        <STRONG>A_UNDERLINE</STRONG>    Underlining     <STRONG>A_REVERSE</STRONG> Reverse     video
  97        <STRONG>A_BLINK</STRONG>   Blinking  <STRONG>A_DIM</STRONG>     Half  bright <STRONG>A_BOLD</STRONG>    Extra
  98        bright or bold <STRONG>A_PROTECT</STRONG> Protected mode  <STRONG>A_INVIS</STRONG>   Invisi-
  99        ble  or  blank mode <STRONG>A_ALTCHARSET</STRONG>   Alternate character set
 100        <STRONG>A_CHARTEXT</STRONG>     Bit-mask    to    extract    a    character
 101        <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG>  Color-pair number <EM>n</EM>
 102
 103        The following macro is the reverse of <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG>:
 104
 105        <STRONG>PAIR_NUMBER(</STRONG><EM>attrs</EM>) Returns the pair number associated
 106                           with the <STRONG>COLOR_PAIR(</STRONG><EM>n</EM><STRONG>)</STRONG> attribute.
 107
 108        The  return values of many of these routines are not mean-
 109        ingful (they are implemented as macro-expanded assignments
 110        and  simply  return their argument).  The SVr4 manual page
 111        claims (falsely) that these routines always return <STRONG>1</STRONG>.
 112        Note that <STRONG>attroff</STRONG>,  <STRONG>wattroff</STRONG>,  <STRONG>attron</STRONG>,  <STRONG>wattron</STRONG>,  <STRONG>attrset</STRONG>,
 113        <STRONG>wattrset</STRONG>, <STRONG>standend</STRONG> and <STRONG>standout</STRONG> may be macros.
 114
 115
 116 </PRE>
 117 <H2>PORTABILITY</H2><PRE>
 118        All  these functions are supported in the XSI Curses stan-
 119        dard, Issue 4.  The standard defined  the  dedicated  type
 120        for  highlights,  <STRONG>attr_t</STRONG>,  which  is  not  defined in SVr4
 121        curses. The functions taking <STRONG>attr_t</STRONG> arguments are not sup-
 122        ported under SVr4.
 123
 124        The  XSI  Curses  standard  states that whether the tradi-
 125        tional  functions  <STRONG>attron</STRONG>/<STRONG>attroff</STRONG>/<STRONG>attrset</STRONG>  can  manipulate
 126        attributes  other  than <STRONG>A_BLINK</STRONG>, <STRONG>A_BOLD</STRONG>, <STRONG>A_DIM</STRONG>, <STRONG>A_REVERSE</STRONG>,
 127        <STRONG>A_STANDOUT</STRONG>, or <STRONG>A_UNDERLINE</STRONG> is "unspecified".   Under  this
 128        implementation  as  well  as  SVr4 curses, these functions
 129        correctly manipulate all other  highlights  (specifically,
 130        <STRONG>A_ALTCHARSET</STRONG>, <STRONG>A_PROTECT</STRONG>, and <STRONG>A_INVIS</STRONG>).
 131
 132        XSI  Curses added the new entry points, <STRONG>attr_get</STRONG>, <STRONG>attr_on</STRONG>,
 133        <STRONG>attr_off</STRONG>,  <STRONG>attr_set</STRONG>,   <STRONG>wattr_on</STRONG>,   <STRONG>wattr_off</STRONG>,   <STRONG>wattr_get</STRONG>,
 134        <STRONG>wattr_set</STRONG>.   These  are intended to work with a new series
 135        of highlight macros prefixed with <STRONG>WA_</STRONG>.
 136
 137        center ; l l .  <STRONG>WA_NORMAL</STRONG> Normal  display  (no  highlight)
 138        <STRONG>WA_STANDOUT</STRONG>    Best  highlighting  mode  of  the terminal.
 139        <STRONG>WA_UNDERLINE</STRONG>   Underlining  <STRONG>WA_REVERSE</STRONG>     Reverse   video
 140        <STRONG>WA_BLINK</STRONG>  Blinking  <STRONG>WA_DIM</STRONG>    Half  bright <STRONG>WA_BOLD</STRONG>   Extra
 141        bright or bold <STRONG>WA_ALTCHARSET</STRONG>  Alternate character set
 142
 143        The XSI curses standard specifies that each pair of corre-
 144        sponding  <STRONG>A_</STRONG>  and <STRONG>WA_</STRONG>-using functions operates on the same
 145        current-highlight information.
 146
 147        The XSI standard extended conformance level adds new high-
 148        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>
 149        <STRONG>TICAL</STRONG> (and corresponding <STRONG>WA_</STRONG> macros for each)  which  this
 150        curses does not yet support.
 151
 152
 153 </PRE>
 154 <H2>SEE ALSO</H2><PRE>
 155        <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>,
 156        <STRONG><A HREF="curs_printw.3x.html">curs_printw(3X)</A></STRONG>
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168 </PRE>
 169 </BODY>
 170 </HTML>