d6ad62471acf13b59a21f4cb7b89d0fe81e0ecb7
[ncurses.git] / man / curs_attr.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: curs_attr.3x,v 1.19 1998/12/26 19:25:35 tom Exp $
31 .TH curs_attr 3X ""
32 .SH NAME
33 \fBattroff\fR, \fBwattroff\fR, \fBattron\fR, \fBwattron\fR,
34 \fBattrset\fR, \fBwattrset\fR, \fBcolor_set\fR, \fBwcolor_set\fR,
35 \fBstandend\fR, \fBwstandend\fR, \fBstandout\fR,
36 \fBwstandout\fR - \fBcurses\fR character and window attribute control routines
37 .SH SYNOPSIS
38 \fB#include <curses.h>\fR
39 .br
40 \fBint attroff(int attrs);\fR
41 .br
42 \fBint wattroff(WINDOW *win, int attrs);\fR
43 .br
44 \fBint attron(int attrs);\fR
45 .br
46 \fBint wattron(WINDOW *win, int attrs);\fR
47 .br
48 \fBint attrset(int attrs);\fR
49 .br
50 \fBint wattrset(WINDOW *win, int attrs);\fR
51 .br
52 \fBint color_set(short color_pair_number, void* opts);\fR
53 .br
54 \fBint wcolor_set(WINDOW *win, short color_pair_number,\fR
55       \fBvoid* opts);\fR
56 .br
57 \fBint standend(void);\fR
58 .br
59 \fBint wstandend(WINDOW *win);\fR
60 .br
61 \fBint standout(void);\fR
62 .br
63 \fBint wstandout(WINDOW *win);\fR
64 .br
65 \fBint attr_get(attr_t *attrs, short *pair, void *opts);\fR
66 .br
67 \fBint wattr_get(WINDOW *win, attr_t *attrs, short *pair,\fR
68        \fBvoid *opts);\fR
69 .br
70 \fBint attr_off(attr_t attrs, void *opts);\fR
71 .br
72 \fBint wattr_off(WINDOW *win, attr_t attrs, void *opts);\fR
73 .br
74 \fBint attr_on(attr_t attrs, void *opts);\fR
75 .br
76 \fBint wattr_on(WINDOW *win, attr_t attrs, void *opts);\fR
77 .br
78 \fBint attr_set(attr_t attrs, void *opts);\fR
79 .br
80 \fBint wattr_set(WINDOW *win, attr_t attrs, void *opts);\fR
81 .br
82 \fBint chgat(int n, attr_t attr, short color,\fR
83       \fBconst void *opts)\fR
84 .br
85 \fBint wchgat(WINDOW *win, int n, attr_t attr,\fR
86       \fBshort color, const void *opts)\fR
87 .br
88 \fBint mvchgat(int y, int x, int n, attr_t attr,\fR
89       \fBshort color, const void *opts)\fR
90 .br
91 \fBint mvwchgat(WINDOW *win, int y, int x, int n,\fR
92       \fBattr_t attr, short color, const void *opts)\fR
93 .br
94 .SH DESCRIPTION
95 These routines manipulate the current attributes of the named window.  The
96 current attributes of a window apply to all characters that are written into
97 the window with \fBwaddch\fR, \fBwaddstr\fR and \fBwprintw\fR.  Attributes are
98 a property of the character, and move with the character through any scrolling
99 and insert/delete line/character operations.  To the extent possible, they are
100 displayed as appropriate modifications to the graphic rendition of characters
101 put on the screen.
102
103 The routine \fBattrset\fR sets the current attributes of the given window to
104 \fIattrs\fR.  The routine \fBattroff\fR turns off the named attributes without
105 turning any other attributes on or off.  The routine \fBattron\fR turns on the
106 named attributes without affecting any others.  The routine \fBstandout\fR is
107 the same as \fBattron(A_STANDOUT)\fR.  The routine \fBstandend\fR is the same
108 as \fBattrset(A_NORMAL)\fR or \fBattrset(0)\fR, that is, it turns off all
109 attributes.
110
111 The routine \fBcolor_set\fR sets the current color of the given window to the
112 foreground/background combination described by the color_pair_number. The
113 parameter opts is reserved for future use, applications must supply a null
114 pointer.
115
116 The routine \fBwattr_get\fR returns the current attribute and color pair for
117 the given window; \fBattr_get\fR returns the current attribute and color pair
118 for \fBstdscr\fR.
119 The remaining \fBattr_\fR* functions operate exactly like the corresponding
120 \fBattr\fR* functions, except that they take arguments of type \fBattr_t\fR
121 rather than \fBint\fR.
122
123 The routine \fBchgat\fR changes the attributes of a given number of characters
124 starting at the current cursor location of \fBstdscr\fR.  It does not update
125 the cursor and does not perform wrapping.  A character count of -1 or greater
126 than the remaining window width means to change attributes all the way to the
127 end of the current line.  The \fBwchgat\fR function generalizes this to any
128 window; the \fBmvwchgat\fR function does a cursor move before acting.  In these
129 functions, the color argument is a color-pair index (as in the first argument
130 of \fIinit_pair\fR, see \fBcurs_color\fR(3X)).  The \fBopts\fR argument is not
131 presently used, but is reserved for the future (leave it \fBNULL\fR).
132 .SS Attributes
133 The following video attributes, defined in \fB<curses.h>\fR, can be passed to
134 the routines \fBattron\fR, \fBattroff\fR, and \fBattrset\fR, or OR'ed with the
135 characters passed to \fBaddch\fR.
136
137 .TS
138 center ;
139 l l .
140 \fBA_NORMAL\fR  Normal display (no highlight)
141 \fBA_STANDOUT\fR        Best highlighting mode of the terminal.
142 \fBA_UNDERLINE\fR       Underlining
143 \fBA_REVERSE\fR Reverse video
144 \fBA_BLINK\fR   Blinking
145 \fBA_DIM\fR     Half bright
146 \fBA_BOLD\fR    Extra bright or bold
147 \fBA_PROTECT\fR Protected mode
148 \fBA_INVIS\fR   Invisible or blank mode
149 \fBA_ALTCHARSET\fR      Alternate character set
150 \fBA_CHARTEXT\fR        Bit-mask to extract a character
151 \fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR Color-pair number \fIn\fR
152 .TE
153
154 The following macro is the reverse of \fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR:
155
156 .DS C
157 \fBPAIR_NUMBER(\fR\fIattrs\fR) Returns the pair number associated
158                    with the \fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR attribute.
159 .DE
160
161 The return values of many of these routines are not meaningful (they are
162 implemented as macro-expanded assignments and simply return their argument).
163 The SVr4 manual page claims (falsely) that these routines always return \fB1\fR.
164
165 .SH NOTES
166 Note that \fBattroff\fR, \fBwattroff\fR, \fBattron\fR, \fBwattron\fR,
167 \fBattrset\fR, \fBwattrset\fR, \fBstandend\fR and \fBstandout\fR may be macros.
168 .SH PORTABILITY
169 All these functions are supported in the XSI Curses standard, Issue 4.  The
170 standard defined the dedicated type for highlights, \fBattr_t\fR, which is not
171 defined in SVr4 curses. The functions taking \fBattr_t\fR arguments are
172 not supported under SVr4.
173
174 The XSI Curses standard states that whether the traditional functions
175 \fBattron\fR/\fBattroff\fR/\fBattrset\fR can manipulate attributes other than
176 \fBA_BLINK\fR, \fBA_BOLD\fR, \fBA_DIM\fR, \fBA_REVERSE\fR, \fBA_STANDOUT\fR, or
177 \fBA_UNDERLINE\fR is "unspecified".  Under this implementation as well as
178 SVr4 curses, these functions correctly manipulate all other highlights
179 (specifically, \fBA_ALTCHARSET\fR, \fBA_PROTECT\fR, and \fBA_INVIS\fR).
180
181 XSI Curses added the new entry points, \fBattr_get\fR, \fBattr_on\fR,
182 \fBattr_off\fR, \fBattr_set\fR, \fBwattr_on\fR, \fBwattr_off\fR,
183 \fBwattr_get\fR, \fBwattr_set\fR.  These are intended to work with
184 a new series of highlight macros prefixed with \fBWA_\fR.
185
186 .TS
187 center ;
188 l l .
189 \fBWA_NORMAL\fR Normal display (no highlight)
190 \fBWA_STANDOUT\fR       Best highlighting mode of the terminal.
191 \fBWA_UNDERLINE\fR      Underlining
192 \fBWA_REVERSE\fR        Reverse video
193 \fBWA_BLINK\fR  Blinking
194 \fBWA_DIM\fR    Half bright
195 \fBWA_BOLD\fR   Extra bright or bold
196 \fBWA_ALTCHARSET\fR     Alternate character set
197 .TE
198
199 The XSI curses standard specifies that each pair of corresponding \fBA_\fR
200 and \fBWA_\fR-using functions operates on the same current-highlight
201 information.
202
203 The XSI standard extended conformance level adds new highlights
204 \fBA_HORIZONTAL\fR, \fBA_LEFT\fR, \fBA_LOW\fR, \fBA_RIGHT\fR, \fBA_TOP\fR,
205 \fBA_VERTICAL\fR (and corresponding \fBWA_\fR macros for each) which this
206 curses does not yet support.
207 .SH SEE ALSO
208 \fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_addstr\fR(3X),
209 \fBcurs_printw\fR(3X)
210 .\"#
211 .\"# The following sets edit modes for GNU EMACS
212 .\"# Local Variables:
213 .\"# mode:nroff
214 .\"# fill-column:79
215 .\"# End: