ncurses 5.7 - patch 20090725
[ncurses.git] / man / curs_outopts.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2005,2007 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_outopts.3x,v 1.21 2007/06/02 20:40:07 tom Exp $
30 .TH curs_outopts 3X ""
31 .na
32 .hy 0
33 .SH NAME
34 \fBclearok\fR,
35 \fBidlok\fR,
36 \fBidcok\fR,
37 \fBimmedok\fR,
38 \fBleaveok\fR,
39 \fBsetscrreg\fR,
40 \fBwsetscrreg\fR,
41 \fBscrollok\fR,
42 \fBnl\fR,
43 \fBnonl\fR - \fBcurses\fR output options
44 .ad
45 .hy
46 .SH SYNOPSIS
47 \fB#include <curses.h>\fR
48 .sp
49 \fBint clearok(WINDOW *win, bool bf);\fR
50 .br
51 \fBint idlok(WINDOW *win, bool bf);\fR
52 .br
53 \fBvoid idcok(WINDOW *win, bool bf);\fR
54 .br
55 \fBvoid immedok(WINDOW *win, bool bf);\fR
56 .br
57 \fBint leaveok(WINDOW *win, bool bf);\fR
58 .br
59 \fBint setscrreg(int top, int bot);\fR
60 .br
61 \fBint wsetscrreg(WINDOW *win, int top, int bot);\fR
62 .br
63 \fBint scrollok(WINDOW *win, bool bf);\fR
64 .br
65 \fBint nl(void);\fR
66 .br
67 \fBint nonl(void);\fR
68 .br
69 .SH DESCRIPTION
70 These routines set options that change the style of output within
71 \fBcurses\fR.
72 All options are initially \fBFALSE\fR, unless otherwise stated.
73 It is not necessary to turn these options off before calling \fBendwin\fR.
74 .PP
75 If \fBclearok\fR is called with \fBTRUE\fR as argument, the next
76 call to \fBwrefresh\fR with this window will clear the screen completely and
77 redraw the entire screen from scratch.
78 This is useful when the contents of the
79 screen are uncertain, or in some cases for a more pleasing visual effect.
80 If
81 the \fIwin\fR argument to \fBclearok\fR is the global variable \fBcurscr\fR,
82 the next call to \fBwrefresh\fR with any window causes the screen to be cleared
83 and repainted from scratch.
84 .PP
85 If \fBidlok\fR is called with \fBTRUE\fR as second argument, \fBcurses\fR
86 considers using the hardware insert/delete line feature of terminals so
87 equipped.
88 Calling \fBidlok\fR with \fBFALSE\fR as second argument disables use
89 of line insertion and deletion.
90 This option should be enabled only if the
91 application needs insert/delete line, for example, for a screen editor.
92 It is
93 disabled by default because insert/delete line tends to be visually annoying
94 when used in applications where it is not really needed.
95 If insert/delete line
96 cannot be used, \fBcurses\fR redraws the changed portions of all lines.
97 .PP
98 If \fBidcok\fR is called with \fBFALSE\fR as second argument, \fBcurses\fR
99 no longer considers using the hardware insert/delete character feature of
100 terminals so equipped.
101 Use of character insert/delete is enabled by default.
102 Calling \fBidcok\fR with \fBTRUE\fR as second argument re-enables use
103 of character insertion and deletion.
104 .PP
105 If \fBimmedok\fR is called with \fBTRUE as argument\fR, any change
106 in the window image, such as the ones caused by \fBwaddch, wclrtobot, wscrl\fR,
107 etc., automatically cause a call to \fBwrefresh\fR.
108 However, it may
109 degrade performance considerably, due to repeated calls to \fBwrefresh\fR.
110 It is disabled by default.
111 .PP
112 Normally, the hardware cursor is left at the location of the window cursor
113 being refreshed.
114 The \fBleaveok\fR option allows the cursor to be left
115 wherever the update happens to leave it.
116 It is useful for applications where
117 the cursor is not used, since it reduces the need for cursor motions.
118 .PP
119 The \fBsetscrreg\fR and \fBwsetscrreg\fR routines allow the application
120 programmer to set a software scrolling region in a window.
121 \fItop\fR and
122 \fIbot\fR are the line numbers of the top and bottom margin of the scrolling
123 region.
124 (Line 0 is the top line of the window.)  If this option and
125 \fBscrollok\fR are enabled, an attempt to move off the bottom margin line
126 causes all lines in the scrolling region to scroll one line in the direction
127 of the first line.
128 Only the text of the window is scrolled.
129 (Note that this
130 has nothing to do with the use of a physical scrolling region capability in the
131 terminal, like that in the VT100.
132 If \fBidlok\fR is enabled and the terminal
133 has either a scrolling region or insert/delete line capability, they will
134 probably be used by the output routines.)
135 .PP
136 The \fBscrollok\fR option controls what happens when the cursor of a window is
137 moved off the edge of the window or scrolling region, either as a result of a
138 newline action on the bottom line, or typing the last character of the last
139 line.
140 If disabled, (\fIbf\fR is \fBFALSE\fR), the cursor is left on the bottom
141 line.
142 If enabled, (\fIbf\fR is \fBTRUE\fR), the window is scrolled up one line
143 (Note that to get the physical scrolling effect on the terminal, it is
144 also necessary to call \fBidlok\fR).
145 .PP
146 The \fBnl\fR and \fBnonl\fR routines control whether the underlying display
147 device translates the return key into newline on input, and whether it
148 translates newline into return and line-feed on output (in either case, the
149 call \fBaddch('\\n')\fR does the equivalent of return and line feed on the
150 virtual screen).
151 Initially, these translations do occur.
152 If you disable them
153 using \fBnonl\fR, \fBcurses\fR will be able to make better use of the line-feed
154 capability, resulting in faster cursor motion.
155 Also, \fBcurses\fR will then be
156 able to detect the return key.
157 .SH RETURN VALUE
158 The functions \fBsetscrreg\fR and \fBwsetscrreg\fR return \fBOK\fR upon success
159 and \fBERR\fR upon failure.
160 All other routines that return an integer always
161 return \fBOK\fR.
162 .PP
163 X/Open does not define any error conditions.
164 .PP
165 In this implementation, those functions that have a window pointer
166 will return an error if the window pointer is null.
167 .RS
168 .TP 5
169 .B wclrtoeol
170 returns an error
171 if the cursor position is about to wrap.
172 .TP 5
173 .B wsetscrreg
174 returns an error if the scrolling region limits extend outside the window.
175 .RE
176 .PP
177 X/Open does not define any error conditions.
178 This implementation returns an error
179 if the window pointer is null.
180 .SH PORTABILITY
181 These functions are described in the XSI Curses standard, Issue 4.
182 .PP
183 The XSI Curses standard is ambiguous on the question of whether \fBraw\fR()
184 should disable the CRLF translations controlled by \fBnl\fR() and \fBnonl\fR().
185 BSD curses did turn off these translations; AT&T curses (at least as late as
186 SVr1) did not.
187 We choose to do so, on the theory that a programmer requesting
188 raw input wants a clean (ideally 8-bit clean) connection that the operating
189 system will not alter.
190 .PP
191 Some historic curses implementations had, as an undocumented feature, the
192 ability to do the equivalent of \fBclearok(..., 1)\fR by saying
193 \fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR.
194 This will not work under
195 ncurses.
196 .PP
197 Earlier System V curses implementations specified that with \fBscrollok\fR
198 enabled, any window modification triggering a scroll also forced a physical
199 refresh.
200 XSI Curses does not require this, and \fBncurses\fR avoids doing
201 it to perform better vertical-motion optimization at \fBwrefresh\fR
202 time.
203 .PP
204 The XSI Curses standard does not mention that the cursor should be
205 made invisible as a side-effect of \fBleaveok\fR.
206 SVr4 curses documentation does this, but the code does not.
207 Use \fBcurs_set\fR to make the cursor invisible.
208 .SH NOTES
209 Note that \fBclearok\fR, \fBleaveok\fR, \fBscrollok\fR, \fBidcok\fR, \fBnl\fR,
210 \fBnonl\fR and \fBsetscrreg\fR may be macros.
211 .PP
212 The \fBimmedok\fR routine is useful for windows that are used as terminal
213 emulators.
214 .SH SEE ALSO
215 \fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_clear\fR(3X),
216 \fBcurs_initscr\fR(3X), \fBcurs_scroll\fR(3X), \fBcurs_refresh\fR(3X)
217 .\"#
218 .\"# The following sets edit modes for GNU EMACS
219 .\"# Local Variables:
220 .\"# mode:nroff
221 .\"# fill-column:79
222 .\"# End: