usr/src/man/man3curses/curs_attr.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH CURS_ATTR 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_attr, attroff, wattroff, attron, wattron, attrset, wattrset, standend,
  10 wstandend, standout, wstandout \- curses character and window attribute control
  11 routines
  12 .SH SYNOPSIS
  13 .LP
  14 .nf
  15 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  16 #include <curses.h>
  17
  18 \fBint\fR \fBattroff\fR(\fBint\fR \fIattrs\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBwattroff\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIattrs\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBattron\fR(\fBint\fR \fIattrs\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBint\fR \fBwattron\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIattrs\fR);
  34 .fi
  35
  36 .LP
  37 .nf
  38 \fBint\fR \fBattrset\fR(\fBint\fR \fIattrs\fR);
  39 .fi
  40
  41 .LP
  42 .nf
  43 \fBint\fR \fBwattrset\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIattrs\fR);
  44 .fi
  45
  46 .LP
  47 .nf
  48 \fBint\fR \fBstandend\fR(\fBvoid\fR);
  49 .fi
  50
  51 .LP
  52 .nf
  53 \fBint\fR \fBwstandend\fR(\fBWINDOW *\fR\fIwin\fR);
  54 .fi
  55
  56 .LP
  57 .nf
  58 \fBint\fR \fBstandout\fR(\fBvoid\fR);
  59 .fi
  60
  61 .LP
  62 .nf
  63 \fBint\fR \fBwstandout\fR(\fBWINDOW *\fR\fIwin\fR);
  64 .fi
  65
  66 .SH DESCRIPTION
  67 .sp
  68 .LP
  69 All of these routines manipulate the current attributes of the named window.
  70 The current attributes of a window are applied to all characters that are
  71 written into the window with \fBwaddch()\fR, \fBwaddstr()\fR, and
  72 \fBwprintw()\fR. Attributes are a property of the character, and move with the
  73 character through any scrolling and insert/delete line/character operations. To
  74 the extent possible on the particular terminal, they are displayed as the
  75 graphic rendition of characters put on the screen.
  76 .sp
  77 .LP
  78 The routine \fBattrset()\fR sets the current attributes of the given window to
  79 \fIattrs\fR. The routine \fBattroff()\fR turns off the named attributes without
  80 turning any other attributes on or off. The routine \fBattron()\fR turns on the
  81 named attributes without affecting any others. The routine \fBstandout()\fR is
  82 the same as \fBattron(\fR\fBA_STANDOUT)\fR. The routine \fBstandend()\fR is the
  83 same as \fBattrset()\fR, that is, it turns off all attributes.
  84 .SS "Attributes"
  85 .sp
  86 .LP
  87 The following video attributes, defined in \fB<curses.h>\fR, can be passed to
  88 the routines \fBattron()\fR, \fBattroff()\fR, and \fBattrset()\fR, or OR-ed
  89 with the characters passed to \fBaddch()\fR.
  90 .sp
  91 .ne 2
  92 .na
  93 \fBA_STANDOUT\fR
  94 .ad
  95 .RS 17n
  96 Best highlighting mode of the terminal
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fBA_UNDERLINE\fR
 103 .ad
 104 .RS 17n
 105 Underlining
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fBA_REVERSE\fR
 112 .ad
 113 .RS 17n
 114 Reverse video
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fBA_BLINK\fR
 121 .ad
 122 .RS 17n
 123 Blinking
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fBA_DIM\fR
 130 .ad
 131 .RS 17n
 132 Half bright
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fBA_BOLD\fR
 139 .ad
 140 .RS 17n
 141 Extra bright or bold
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fBA_ALTCHARSET\fR
 148 .ad
 149 .RS 17n
 150 Alternate character set
 151 .RE
 152
 153 .sp
 154 .ne 2
 155 .na
 156 \fBA_CHARTEXT\fR
 157 .ad
 158 .RS 17n
 159 Bit-mask to extract a character
 160 .RE
 161
 162 .sp
 163 .ne 2
 164 .na
 165 \fBCOLOR_PAIR(\fIn\fR)\fR
 166 .ad
 167 .RS 17n
 168 Color-pair number \fIn\fR
 169 .RE
 170
 171 .sp
 172 .LP
 173 The following macro is the reverse of \fBCOLOR_PAIR(\fR\fIn\fR\fB):\fR
 174 .sp
 175 .ne 2
 176 .na
 177 \fBPAIR_NUMBER(\fIattrs\fR)\fR
 178 .ad
 179 .RS 22n
 180 Returns the pair number associated with the \fBCOLOR_PAIR(\fR\fIn\fR) attribute
 181 .RE
 182
 183 .SH RETURN VALUES
 184 .sp
 185 .LP
 186 These routines always return 1.
 187 .SH ATTRIBUTES
 188 .sp
 189 .LP
 190 See \fBattributes\fR(5) for descriptions of the following attributes:
 191 .sp
 192
 193 .sp
 194 .TS
 195 box;
 196 c | c
 197 l | l .
 198 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 199 _
 200 MT-Level        Unsafe
 201 .TE
 202
 203 .SH SEE ALSO
 204 .sp
 205 .LP
 206 \fBcurs_addch\fR(3CURSES), \fBcurs_addstr\fR(3CURSES),
 207 \fBcurs_printw\fR(3CURSES), \fBcurses\fR(3CURSES), \fBattributes\fR(5)
 208 .SH NOTES
 209 .sp
 210 .LP
 211 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
 212 and <\fBunctrl.h\fR>.
 213 .sp
 214 .LP
 215 Note that \fBattroff()\fR, \fBwattroff()\fR, \fBattron()\fR, \fBwattron()\fR,
 216 \fBwattrset()\fR, \fBstandend()\fR, and \fBstandout()\fR may be macros.