2 ****************************************************************************
3 * Copyright 2018-2022,2023 Thomas E. Dickey *
4 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_outopts.3x,v 1.46 2023/09/30 21:38:11 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_outopts 3x 2023-09-30 ncurses 6.4 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">curs_outopts 3x 2023-09-30 ncurses 6.4 Library calls</H1>
44 <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>clearok</STRONG>, <STRONG>idlok</STRONG>, <STRONG>idcok</STRONG>, <STRONG>immedok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>setscrreg</STRONG>, <STRONG>wsetscrreg</STRONG>,
51 <STRONG>scrollok</STRONG> - set <EM>curses</EM> output options
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>clearok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>idlok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
59 <STRONG>void</STRONG> <STRONG>idcok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
60 <STRONG>void</STRONG> <STRONG>immedok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>leaveok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
62 <STRONG>int</STRONG> <STRONG>scrollok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>setscrreg(int</STRONG> <EM>top</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>bot</EM><STRONG>);</STRONG>
65 <STRONG>int</STRONG> <STRONG>wsetscrreg(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>top</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>bot</EM><STRONG>);</STRONG>
68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69 These routines set options that change the style of output within
70 <STRONG>curses</STRONG>. All options are initially <STRONG>FALSE</STRONG>, unless otherwise stated. It
71 is not necessary to turn these options off before calling <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG>.
74 </PRE><H3><a name="h3-clearok">clearok</a></H3><PRE>
75 If <STRONG>clearok</STRONG> is called with <STRONG>TRUE</STRONG> as argument, the next call to <STRONG>wrefresh</STRONG>
76 with this window will clear the screen completely and redraw the entire
77 screen from scratch. This is useful when the contents of the screen
78 are uncertain, or in some cases for a more pleasing visual effect. If
79 the <EM>win</EM> argument to <STRONG>clearok</STRONG> is the global variable <STRONG>curscr</STRONG>, the next
80 call to <STRONG>wrefresh</STRONG> with any window causes the screen to be cleared and
81 repainted from scratch.
84 </PRE><H3><a name="h3-idlok">idlok</a></H3><PRE>
85 If <STRONG>idlok</STRONG> is called with <STRONG>TRUE</STRONG> as second argument, <STRONG>curses</STRONG> considers using
86 the hardware insert/delete line feature of terminals so equipped.
87 Calling <STRONG>idlok</STRONG> with <STRONG>FALSE</STRONG> as second argument disables use of line
88 insertion and deletion. This option should be enabled only if the
89 application needs insert/delete line, for example, for a screen editor.
90 It is disabled by default because insert/delete line tends to be
91 visually annoying when used in applications where it is not really
92 needed. If insert/delete line cannot be used, <STRONG>curses</STRONG> redraws the
93 changed portions of all lines.
96 </PRE><H3><a name="h3-idcok">idcok</a></H3><PRE>
97 If <STRONG>idcok</STRONG> is called with <STRONG>FALSE</STRONG> as second argument, <STRONG>curses</STRONG> no longer
98 considers using the hardware insert/delete character feature of
99 terminals so equipped. Use of character insert/delete is enabled by
100 default. Calling <STRONG>idcok</STRONG> with <STRONG>TRUE</STRONG> as second argument re-enables use of
101 character insertion and deletion.
104 </PRE><H3><a name="h3-immedok">immedok</a></H3><PRE>
105 If <STRONG>immedok</STRONG> is called with <STRONG>TRUE</STRONG> <STRONG>as</STRONG> <STRONG>argument</STRONG>, any change in the window
106 image, such as the ones caused by <STRONG>waddch,</STRONG> <STRONG>wclrtobot,</STRONG> <STRONG>wscrl</STRONG>, etc.,
107 automatically cause a call to <STRONG>wrefresh</STRONG>. However, it may degrade
108 performance considerably, due to repeated calls to <STRONG>wrefresh</STRONG>. It is
112 </PRE><H3><a name="h3-leaveok">leaveok</a></H3><PRE>
113 Normally, the hardware cursor is left at the location of the window
114 cursor being refreshed. The <STRONG>leaveok</STRONG> option allows the cursor to be
115 left wherever the update happens to leave it. It is useful for
116 applications where the cursor is not used, since it reduces the need
120 </PRE><H3><a name="h3-scrollok">scrollok</a></H3><PRE>
121 The <STRONG>scrollok</STRONG> option controls what happens when the cursor of a window
122 is moved off the edge of the window or scrolling region, either as a
123 result of a newline action on the bottom line, or typing the last
124 character of the last line. If disabled, (<EM>bf</EM> is <STRONG>FALSE</STRONG>), the cursor is
125 left on the bottom line. If enabled, (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the window is
126 scrolled up one line (Note that to get the physical scrolling effect on
127 the terminal, it is also necessary to call <STRONG>idlok</STRONG>).
130 </PRE><H3><a name="h3-setscrreg_wsetscrreg">setscrreg/wsetscrreg</a></H3><PRE>
131 The <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> routines allow the application programmer
132 to set a software scrolling region in a window. The <EM>top</EM> and <EM>bot</EM>
133 parameters are the line numbers of the top and bottom margin of the
134 scrolling region. (Line 0 is the top line of the window.) If this
135 option and <STRONG>scrollok</STRONG> are enabled, an attempt to move off the bottom
136 margin line causes all lines in the scrolling region to scroll one line
137 in the direction of the first line. Only the text of the window is
138 scrolled. (Note that this has nothing to do with the use of a physical
139 scrolling region capability in the terminal, like that in the VT100.
140 If <STRONG>idlok</STRONG> is enabled and the terminal has either a scrolling region or
141 insert/delete line capability, they will probably be used by the output
145 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
146 The functions <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> return <STRONG>OK</STRONG> upon success and <STRONG>ERR</STRONG>
147 upon failure. All other routines that return an integer always return
150 X/Open Curses does not define any error conditions.
152 In this implementation,
154 <STRONG>o</STRONG> those functions that have a window pointer will return an error if
155 the window pointer is null
157 <STRONG>o</STRONG> <STRONG>wsetscrreg</STRONG> returns an error if the scrolling region limits extend
160 X/Open does not define any error conditions. This implementation
161 returns an error if the window pointer is null.
164 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
165 These functions are described in the XSI Curses standard, Issue 4.
167 From the outset, ncurses used <STRONG>nl</STRONG>/<STRONG>nonl</STRONG> to control the conversion of
168 newlines to carriage return/line-feed on output as well as input. XSI
169 Curses documents only the use of these functions for input. This
170 difference arose from converting the <EM>pcurses</EM> source (which used <STRONG>ioctl</STRONG>
171 calls with the <STRONG>sgttyb</STRONG> structure) to termios (i.e., the POSIX terminal
172 interface). In the former, both input and output were controlled via a
173 single option <STRONG>CRMOD</STRONG>, while the latter separates these features.
174 Because that conversion interferes with output optimization, <STRONG>nl</STRONG>/<STRONG>nonl</STRONG>
175 were amended after ncurses 6.2 to eliminate their effect on output.
177 Some historic curses implementations had, as an undocumented feature,
178 the ability to do the equivalent of <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying
179 <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(stdscr)</STRONG>. This will not work under ncurses.
181 Earlier System V curses implementations specified that with <STRONG>scrollok</STRONG>
182 enabled, any window modification triggering a scroll also forced a
183 physical refresh. XSI Curses does not require this, and <STRONG>ncurses</STRONG> avoids
184 doing it to perform better vertical-motion optimization at <STRONG>wrefresh</STRONG>
187 The XSI Curses standard does not mention that the cursor should be made
188 invisible as a side-effect of <STRONG>leaveok</STRONG>. SVr4 curses documentation does
189 this, but the code does not. Use <STRONG>curs_set</STRONG> to make the cursor
193 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
194 Note that <STRONG>clearok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>scrollok</STRONG>, <STRONG>idcok</STRONG>, and <STRONG>setscrreg</STRONG> may be
197 The <STRONG>immedok</STRONG> routine is useful for windows that are used as terminal
201 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
202 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>,
203 <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
207 ncurses 6.4 2023-09-30 <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
211 <li><a href="#h2-NAME">NAME</a></li>
212 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
213 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
215 <li><a href="#h3-clearok">clearok</a></li>
216 <li><a href="#h3-idlok">idlok</a></li>
217 <li><a href="#h3-idcok">idcok</a></li>
218 <li><a href="#h3-immedok">immedok</a></li>
219 <li><a href="#h3-leaveok">leaveok</a></li>
220 <li><a href="#h3-scrollok">scrollok</a></li>
221 <li><a href="#h3-setscrreg_wsetscrreg">setscrreg/wsetscrreg</a></li>
224 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
225 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
226 <li><a href="#h2-NOTES">NOTES</a></li>
227 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>