ncurses 5.7 - patch 20101002
[ncurses.git] / man / curs_outopts.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2007,2010 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.24 2010/10/02 23:20:43 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 The \fItop\fR and
122 \fIbot\fR parameters
123 are the line numbers of the top and bottom margin of the scrolling
124 region.
125 (Line 0 is the top line of the window.)  If this option and
126 \fBscrollok\fR are enabled, an attempt to move off the bottom margin line
127 causes all lines in the scrolling region to scroll one line in the direction
128 of the first line.
129 Only the text of the window is scrolled.
130 (Note that this
131 has nothing to do with the use of a physical scrolling region capability in the
132 terminal, like that in the VT100.
133 If \fBidlok\fR is enabled and the terminal
134 has either a scrolling region or insert/delete line capability, they will
135 probably be used by the output routines.)
136 .PP
137 The \fBscrollok\fR option controls what happens when the cursor of a window is
138 moved off the edge of the window or scrolling region, either as a result of a
139 newline action on the bottom line, or typing the last character of the last
140 line.
141 If disabled, (\fIbf\fR is \fBFALSE\fR), the cursor is left on the bottom
142 line.
143 If enabled, (\fIbf\fR is \fBTRUE\fR), the window is scrolled up one line
144 (Note that to get the physical scrolling effect on the terminal, it is
145 also necessary to call \fBidlok\fR).
146 .PP
147 The \fBnl\fR and \fBnonl\fR routines control whether the underlying display
148 device translates the return key into newline on input, and whether it
149 translates newline into return and line-feed on output (in either case, the
150 call \fBaddch('\\n')\fR does the equivalent of return and line feed on the
151 virtual screen).
152 Initially, these translations do occur.
153 If you disable them
154 using \fBnonl\fR, \fBcurses\fR will be able to make better use of the line-feed
155 capability, resulting in faster cursor motion.
156 Also, \fBcurses\fR will then be
157 able to detect the return key.
158 .SH RETURN VALUE
159 The functions \fBsetscrreg\fR and \fBwsetscrreg\fR return \fBOK\fR upon success
160 and \fBERR\fR upon failure.
161 All other routines that return an integer always
162 return \fBOK\fR.
163 .PP
164 X/Open does not define any error conditions.
165 .PP
166 In this implementation, those functions that have a window pointer
167 will return an error if the window pointer is null.
168 .RS
169 .TP 5
170 .B wclrtoeol
171 returns an error
172 if the cursor position is about to wrap.
173 .TP 5
174 .B wsetscrreg
175 returns an error if the scrolling region limits extend outside the window.
176 .RE
177 .PP
178 X/Open does not define any error conditions.
179 This implementation returns an error
180 if the window pointer is null.
181 .SH PORTABILITY
182 These functions are described in the XSI Curses standard, Issue 4.
183 .PP
184 The XSI Curses standard is ambiguous on the question of whether \fBraw\fR()
185 should disable the CRLF translations controlled by \fBnl\fR() and \fBnonl\fR().
186 BSD curses did turn off these translations; AT&T curses (at least as late as
187 SVr1) did not.
188 We choose to do so, on the theory that a programmer requesting
189 raw input wants a clean (ideally 8-bit clean) connection that the operating
190 system will not alter.
191 .PP
192 Some historic curses implementations had, as an undocumented feature, the
193 ability to do the equivalent of \fBclearok(..., 1)\fR by saying
194 \fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR.
195 This will not work under
196 ncurses.
197 .PP
198 Earlier System V curses implementations specified that with \fBscrollok\fR
199 enabled, any window modification triggering a scroll also forced a physical
200 refresh.
201 XSI Curses does not require this, and \fBncurses\fR avoids doing
202 it to perform better vertical-motion optimization at \fBwrefresh\fR
203 time.
204 .PP
205 The XSI Curses standard does not mention that the cursor should be
206 made invisible as a side-effect of \fBleaveok\fR.
207 SVr4 curses documentation does this, but the code does not.
208 Use \fBcurs_set\fR to make the cursor invisible.
209 .SH NOTES
210 Note that \fBclearok\fR, \fBleaveok\fR, \fBscrollok\fR, \fBidcok\fR, \fBnl\fR,
211 \fBnonl\fR and \fBsetscrreg\fR may be macros.
212 .PP
213 The \fBimmedok\fR routine is useful for windows that are used as terminal
214 emulators.
215 .SH SEE ALSO
216 \fBcurses\fR(3X),
217 \fBcurs_addch\fR(3X),
218 \fBcurs_clear\fR(3X),
219 \fBcurs_initscr\fR(3X),
220 \fBcurs_scroll\fR(3X),
221 \fBcurs_refresh\fR(3X),
222 \fBcurs_variables\fR(3X).
223 .\"#
224 .\"# The following sets edit modes for GNU EMACS
225 .\"# Local Variables:
226 .\"# mode:nroff
227 .\"# fill-column:79
228 .\"# End: