ncurses 5.1
[ncurses.git] / man / curs_outopts.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998 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.14 2000/02/27 01:41:58 tom Exp $
30 .TH curs_outopts 3X ""
31 .SH NAME
32 \fBclearok\fR, \fBidlok\fR, \fBidcok immedok\fR,
33 \fBleaveok\fR, \fBsetscrreg\fR, \fBwsetscrreg\fR, \fBscrollok\fR,
34 \fBnl\fR, \fBnonl\fR - \fBcurses\fR output options
35 .SH SYNOPSIS
36 \fB#include <curses.h>\fR
37
38 \fBint clearok(WINDOW *win, bool bf);\fR
39 .br
40 \fBint idlok(WINDOW *win, bool bf);\fR
41 .br
42 \fBvoid idcok(WINDOW *win, bool bf);\fR
43 .br
44 \fBvoid immedok(WINDOW *win, bool bf);\fR
45 .br
46 \fBint leaveok(WINDOW *win, bool bf);\fR
47 .br
48 \fBint setscrreg(int top, int bot);\fR
49 .br
50 \fBint wsetscrreg(WINDOW *win, int top, int bot);\fR
51 .br
52 \fBint scrollok(WINDOW *win, bool bf);\fR
53 .br
54 \fBint nl(void);\fR
55 .br
56 \fBint nonl(void);\fR
57 .br
58 .SH DESCRIPTION
59 These routines set options that change the style of output within
60 \fBcurses\fR.  All options are initially \fBFALSE\fR, unless otherwise stated.
61 It is not necessary to turn these options off before calling \fBendwin\fR.
62
63 If \fBclearok\fR is called with \fBTRUE\fR as argument, the next
64 call to \fBwrefresh\fR with this window will clear the screen completely and
65 redraw the entire screen from scratch.  This is useful when the contents of the
66 screen are uncertain, or in some cases for a more pleasing visual effect.  If
67 the \fIwin\fR argument to \fBclearok\fR is the global variable \fBcurscr\fR,
68 the next call to \fBwrefresh\fR with any window causes the screen to be cleared
69 and repainted from scratch.
70
71 If \fBidlok\fR is called with \fBTRUE\fR as second argument, \fBcurses\fR
72 considers using the hardware insert/delete line feature of terminals so
73 equipped.  Calling \fBidlok\fR with \fBFALSE\fR as second argument disables use
74 of line insertion and deletion.  This option should be enabled only if the
75 application needs insert/delete line, for example, for a screen editor.  It is
76 disabled by default because insert/delete line tends to be visually annoying
77 when used in applications where it isn't really needed.  If insert/delete line
78 cannot be used, \fBcurses\fR redraws the changed portions of all lines.
79
80 If \fBidcok\fR is called with \fBFALSE\fR as second argument, \fBcurses\fR
81 no longer considers using the hardware insert/delete character feature of
82 terminals so equipped.  Use of character insert/delete is enabled by default.
83 Calling \fBidcok\fR with \fBTRUE\fR as second argument re-enables use
84 of character insertion and deletion.
85
86 If \fBimmedok\fR is called with \fBTRUE as argument\fR, any change
87 in the window image, such as the ones caused by \fBwaddch, wclrtobot, wscrl\fR,
88 \fIetc\fR., automatically cause a call to \fBwrefresh\fR.  However, it may
89 degrade performance considerably, due to repeated calls to \fBwrefresh\fR.
90 It is disabled by default.
91
92 Normally, the hardware cursor is left at the location of the window cursor
93 being refreshed.  The \fBleaveok\fR option allows the cursor to be left
94 wherever the update happens to leave it.  It is useful for applications where
95 the cursor is not used, since it reduces the need for cursor motions.  If
96 possible, the cursor is made invisible when this option is enabled.
97
98 The \fBsetscrreg\fR and \fBwsetscrreg\fR routines allow the application
99 programmer to set a software scrolling region in a window.  \fItop\fR and
100 \fIbot\fR are the line numbers of the top and bottom margin of the scrolling
101 region.  (Line 0 is the top line of the window.)  If this option and
102 \fBscrollok\fR are enabled, an attempt to move off the bottom margin line
103 causes all lines in the scrolling region to scroll one line in the direction
104 of the first line.  Only the text of the window is scrolled.  (Note that this
105 has nothing to do with the use of a physical scrolling region capability in the
106 terminal, like that in the VT100.  If \fBidlok\fR is enabled and the terminal
107 has either a scrolling region or insert/delete line capability, they will
108 probably be used by the output routines.)
109
110 The \fBscrollok\fR option controls what happens when the cursor of a window is
111 moved off the edge of the window or scrolling region, either as a result of a
112 newline action on the bottom line, or typing the last character of the last
113 line.  If disabled, (\fIbf\fR is \fBFALSE\fR), the cursor is left on the bottom
114 line.  If enabled, (\fIbf\fR is \fBTRUE\fR), the window is scrolled up one line
115 (Note that in order to get the physical scrolling effect on the terminal, it is
116 also necessary to call \fBidlok\fR).
117
118 The \fBnl\fR and \fBnonl\fR routines control whether the underlying display
119 device translates the return key into newline on input, and whether it
120 translates newline into return and line-feed on output (in either case, the
121 call \fBaddch('\\n')\fR does the equivalent of return and line feed on the
122 virtual screen).  Initially, these translations do occur.  If you disable them
123 using \fBnonl\fR, \fBcurses\fR will be able to make better use of the line-feed
124 capability, resulting in faster cursor motion.  Also, \fBcurses\fR will then be
125 able to detect the return key.
126 .SH RETURN VALUE
127 The functions \fBsetscrreg\fR and \fBwsetscrreg\fR return \fBOK\fR upon success
128 and \fBERR\fR upon failure. All other routines that return an integer always
129 return \fBOK\fR.
130 .SH PORTABILITY
131 These functions are described in the XSI Curses standard, Issue 4.
132
133 The XSI Curses standard is ambiguous on the question of whether \fBraw\fR()
134 should disable the CRLF translations controlled by \fBnl\fR() and \fBnonl\fR().
135 BSD curses did turn off these translations; AT&T curses (at least as late as
136 SVr1) did not.  We choose to do so, on the theory that a programmer requesting
137 raw input wants a clean (ideally 8-bit clean) connection that the operating
138 system does not mess with.
139
140 Some historic curses implementations had, as an undocumented feature, the
141 ability to do the equivalent of \fBclearok(..., 1)\fR by saying
142 \fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR.  This will not work under
143 ncurses.
144
145 Earlier System V curses implementations specified that with \fBscrollok\fR 
146 enabled, any window modification triggering a scroll also forced a physical
147 refresh.  XSI Curses does not require this, and \fBncurses\fR avoids doing
148 it in order to perform better vertical-motion optimization at \fBwrefresh\fR
149 time.
150
151 The XSI Curses standard does not mention that the cursor should be
152 made invisible as a side-effect of \fBleaveok\fR.
153 SVr4 curses documentation does this, but the code does not.
154 Use \fBcurs_set\fR to make the cursor invisible.
155 .SH NOTES
156 Note that \fBclearok\fR, \fBleaveok\fR, \fBscrollok\fR, \fBidcok\fR, \fBnl\fR,
157 \fBnonl\fR and \fBsetscrreg\fR may be macros.
158
159 The \fBimmedok\fR routine is useful for windows that are used as terminal
160 emulators.
161 .SH SEE ALSO
162 \fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_clear\fR(3X),
163 \fBcurs_initscr\fR(3X), \fBcurs_scroll\fR(3X), \fBcurs_refresh\fR(3X)
164 .\"#
165 .\"# The following sets edit modes for GNU EMACS
166 .\"# Local Variables:
167 .\"# mode:nroff
168 .\"# fill-column:79
169 .\"# End: