e884fa888bb0f3586d3b4ee984d8ad3a786b71f7
[ncurses.git] / man / curs_attr.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998,2000 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.22 2000/07/08 11:59:58 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, \fBwstandout\fR,
36 \fBattr_get\fR, \fBwattr_get\fR,
37 \fBattr_off\fR, \fBwattr_off\fR,
38 \fBattr_on\fR, \fBwattr_on\fR,
39 \fBattr_set\fR, \fBwattr_set\fR,
40 \fBchgat\fR, \fBwchgat\fR,
41 \fBmvchgat\fR, \fBmvwchgat\fR,
42 \fBPAIR_NUMBER\fR - \fBcurses\fR character and window attribute control routines
43 .SH SYNOPSIS
44 \fB#include <curses.h>\fR
45 .br
46 \fBint attroff(int attrs);\fR
47 .br
48 \fBint wattroff(WINDOW *win, int attrs);\fR
49 .br
50 \fBint attron(int attrs);\fR
51 .br
52 \fBint wattron(WINDOW *win, int attrs);\fR
53 .br
54 \fBint attrset(int attrs);\fR
55 .br
56 \fBint wattrset(WINDOW *win, int attrs);\fR
57 .br
58 \fBint color_set(short color_pair_number, void* opts);\fR
59 .br
60 \fBint wcolor_set(WINDOW *win, short color_pair_number,\fR
61       \fBvoid* opts);\fR
62 .br
63 \fBint standend(void);\fR
64 .br
65 \fBint wstandend(WINDOW *win);\fR
66 .br
67 \fBint standout(void);\fR
68 .br
69 \fBint wstandout(WINDOW *win);\fR
70 .br
71 \fBint attr_get(attr_t *attrs, short *pair, void *opts);\fR
72 .br
73 \fBint wattr_get(WINDOW *win, attr_t *attrs, short *pair,\fR
74        \fBvoid *opts);\fR
75 .br
76 \fBint attr_off(attr_t attrs, void *opts);\fR
77 .br
78 \fBint wattr_off(WINDOW *win, attr_t attrs, void *opts);\fR
79 .br
80 \fBint attr_on(attr_t attrs, void *opts);\fR
81 .br
82 \fBint wattr_on(WINDOW *win, attr_t attrs, void *opts);\fR
83 .br
84 \fBint attr_set(attr_t attrs, short pair, void *opts);\fR
85 .br
86 \fBint wattr_set(WINDOW *win, attr_t attrs, short pair, void *opts);\fR
87 .br
88 \fBint chgat(int n, attr_t attr, short color,\fR
89       \fBconst void *opts)\fR
90 .br
91 \fBint wchgat(WINDOW *win, int n, attr_t attr,\fR
92       \fBshort color, const void *opts)\fR
93 .br
94 \fBint mvchgat(int y, int x, int n, attr_t attr,\fR
95       \fBshort color, const void *opts)\fR
96 .br
97 \fBint mvwchgat(WINDOW *win, int y, int x, int n,\fR
98       \fBattr_t attr, short color, const void *opts)\fR
99 .br
100 .SH DESCRIPTION
101 These routines manipulate the current attributes of the named window.  The
102 current attributes of a window apply to all characters that are written into
103 the window with \fBwaddch\fR, \fBwaddstr\fR and \fBwprintw\fR.  Attributes are
104 a property of the character, and move with the character through any scrolling
105 and insert/delete line/character operations.  To the extent possible, they are
106 displayed as appropriate modifications to the graphic rendition of characters
107 put on the screen.
108
109 The routine \fBattrset\fR sets the current attributes of the given window to
110 \fIattrs\fR.  The routine \fBattroff\fR turns off the named attributes without
111 turning any other attributes on or off.  The routine \fBattron\fR turns on the
112 named attributes without affecting any others.  The routine \fBstandout\fR is
113 the same as \fBattron(A_STANDOUT)\fR.  The routine \fBstandend\fR is the same
114 as \fBattrset(A_NORMAL)\fR or \fBattrset(0)\fR, that is, it turns off all
115 attributes.
116
117 The routine \fBcolor_set\fR sets the current color of the given window to the
118 foreground/background combination described by the color_pair_number. The
119 parameter opts is reserved for future use, applications must supply a null
120 pointer.
121
122 The routine \fBwattr_get\fR returns the current attribute and color pair for
123 the given window; \fBattr_get\fR returns the current attribute and color pair
124 for \fBstdscr\fR.
125 The remaining \fBattr_\fR* functions operate exactly like the corresponding
126 \fBattr\fR* functions, except that they take arguments of type \fBattr_t\fR
127 rather than \fBint\fR.
128
129 The routine \fBchgat\fR changes the attributes of a given number of characters
130 starting at the current cursor location of \fBstdscr\fR.  It does not update
131 the cursor and does not perform wrapping.  A character count of -1 or greater
132 than the remaining window width means to change attributes all the way to the
133 end of the current line.  The \fBwchgat\fR function generalizes this to any
134 window; the \fBmvwchgat\fR function does a cursor move before acting.  In these
135 functions, the color argument is a color-pair index (as in the first argument
136 of \fIinit_pair\fR, see \fBcurs_color\fR(3X)).  The \fBopts\fR argument is not
137 presently used, but is reserved for the future (leave it \fBNULL\fR).
138 .SS Attributes
139 The following video attributes, defined in \fB<curses.h>\fR, can be passed to
140 the routines \fBattron\fR, \fBattroff\fR, and \fBattrset\fR, or OR'ed with the
141 characters passed to \fBaddch\fR.
142
143 .TS
144 center ;
145 l l .
146 \fBA_NORMAL\fR  Normal display (no highlight)
147 \fBA_STANDOUT\fR        Best highlighting mode of the terminal.
148 \fBA_UNDERLINE\fR       Underlining
149 \fBA_REVERSE\fR Reverse video
150 \fBA_BLINK\fR   Blinking
151 \fBA_DIM\fR     Half bright
152 \fBA_BOLD\fR    Extra bright or bold
153 \fBA_PROTECT\fR Protected mode
154 \fBA_INVIS\fR   Invisible or blank mode
155 \fBA_ALTCHARSET\fR      Alternate character set
156 \fBA_CHARTEXT\fR        Bit-mask to extract a character
157 \fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR Color-pair number \fIn\fR
158 .TE
159
160 The following macro is the reverse of \fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR:
161
162 .DS C
163 \fBPAIR_NUMBER(\fR\fIattrs\fR) Returns the pair number associated
164                    with the \fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR attribute.
165 .DE
166
167 The return values of many of these routines are not meaningful (they are
168 implemented as macro-expanded assignments and simply return their argument).
169 The SVr4 manual page claims (falsely) that these routines always return \fB1\fR.
170
171 .SH NOTES
172 Note that \fBattroff\fR, \fBwattroff\fR, \fBattron\fR, \fBwattron\fR,
173 \fBattrset\fR, \fBwattrset\fR, \fBstandend\fR and \fBstandout\fR may be macros.
174 .SH PORTABILITY
175 All these functions are supported in the XSI Curses standard, Issue 4.  The
176 standard defined the dedicated type for highlights, \fBattr_t\fR, which is not
177 defined in SVr4 curses. The functions taking \fBattr_t\fR arguments are
178 not supported under SVr4.
179
180 The XSI Curses standard states that whether the traditional functions
181 \fBattron\fR/\fBattroff\fR/\fBattrset\fR can manipulate attributes other than
182 \fBA_BLINK\fR, \fBA_BOLD\fR, \fBA_DIM\fR, \fBA_REVERSE\fR, \fBA_STANDOUT\fR, or
183 \fBA_UNDERLINE\fR is "unspecified".  Under this implementation as well as
184 SVr4 curses, these functions correctly manipulate all other highlights
185 (specifically, \fBA_ALTCHARSET\fR, \fBA_PROTECT\fR, and \fBA_INVIS\fR).
186
187 XSI Curses added the new entry points, \fBattr_get\fR, \fBattr_on\fR,
188 \fBattr_off\fR, \fBattr_set\fR, \fBwattr_on\fR, \fBwattr_off\fR,
189 \fBwattr_get\fR, \fBwattr_set\fR.  These are intended to work with
190 a new series of highlight macros prefixed with \fBWA_\fR.
191
192 .TS
193 center ;
194 l l .
195 \fBWA_NORMAL\fR Normal display (no highlight)
196 \fBWA_STANDOUT\fR       Best highlighting mode of the terminal.
197 \fBWA_UNDERLINE\fR      Underlining
198 \fBWA_REVERSE\fR        Reverse video
199 \fBWA_BLINK\fR  Blinking
200 \fBWA_DIM\fR    Half bright
201 \fBWA_BOLD\fR   Extra bright or bold
202 \fBWA_ALTCHARSET\fR     Alternate character set
203 .TE
204
205 The XSI curses standard specifies that each pair of corresponding \fBA_\fR
206 and \fBWA_\fR-using functions operates on the same current-highlight
207 information.
208
209 The XSI standard extended conformance level adds new highlights
210 \fBA_HORIZONTAL\fR, \fBA_LEFT\fR, \fBA_LOW\fR, \fBA_RIGHT\fR, \fBA_TOP\fR,
211 \fBA_VERTICAL\fR (and corresponding \fBWA_\fR macros for each) which this
212 curses does not yet support.
213 .SH SEE ALSO
214 \fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_addstr\fR(3X),
215 \fBcurs_printw\fR(3X)
216 .\"#
217 .\"# The following sets edit modes for GNU EMACS
218 .\"# Local Variables:
219 .\"# mode:nroff
220 .\"# fill-column:79
221 .\"# End: