2 ****************************************************************************
3 * Copyright 2018-2023,2024 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.67 2024/05/25 20:10:58 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 2024-05-25 ncurses 6.5 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">curs_outopts 3x 2024-05-25 ncurses 6.5 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>idcok</STRONG>, <STRONG>idlok</STRONG>, <STRONG>immedok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>scrollok</STRONG>, <STRONG>setscrreg</STRONG>,
51 <STRONG>wsetscrreg</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>void</STRONG> <STRONG>idcok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>idlok(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-idcok">idcok</a></H3><PRE>
85 If <STRONG>idcok</STRONG> is called with <STRONG>FALSE</STRONG> as second argument, <STRONG>curses</STRONG> no longer
86 considers using the hardware insert/delete character feature of
87 terminals so equipped. Use of character insert/delete is enabled by
88 default. Calling <STRONG>idcok</STRONG> with <STRONG>TRUE</STRONG> as second argument re-enables use of
89 character insertion and deletion.
92 </PRE><H3><a name="h3-idlok">idlok</a></H3><PRE>
93 If <STRONG>idlok</STRONG> is called with <STRONG>TRUE</STRONG> as second argument, <STRONG>curses</STRONG> considers using
94 the hardware insert/delete line feature of terminals so equipped.
95 Calling <STRONG>idlok</STRONG> with <STRONG>FALSE</STRONG> as second argument disables use of line
96 insertion and deletion. This option should be enabled only if the
97 application needs insert/delete line, for example, for a screen editor.
98 It is disabled by default because insert/delete line tends to be
99 visually annoying when used in applications where it is not really
100 needed. If insert/delete line cannot be used, <STRONG>curses</STRONG> redraws the
101 changed portions of all lines.
104 </PRE><H3><a name="h3-immedok">immedok</a></H3><PRE>
105 If <STRONG>immedok</STRONG> is called with <STRONG>TRUE</STRONG> as second argument, any change in the
106 window image, such as the ones caused by <STRONG>waddch,</STRONG> <STRONG>wclrtobot,</STRONG> <STRONG>wscrl</STRONG>,
107 etc., automatically causes a call to <STRONG>wrefresh</STRONG>. However, it may degrade
108 performance considerably, due to repeated calls to <STRONG>wrefresh</STRONG>. Calling
109 <STRONG>immedok</STRONG> with <STRONG>FALSE</STRONG> as second argument restores the default behavior,
110 i.e., deferring screen updates until a refresh is needed.
113 </PRE><H3><a name="h3-leaveok">leaveok</a></H3><PRE>
114 Normally, the hardware cursor is left at the location of the window
115 cursor being refreshed. The <STRONG>leaveok</STRONG> option allows the cursor to be
116 left wherever the update happens to leave it. It is useful for
117 applications where the cursor is not used, since it reduces the need
121 </PRE><H3><a name="h3-scrollok">scrollok</a></H3><PRE>
122 The <STRONG>scrollok</STRONG> option controls what happens when the cursor of a window
123 is moved off the edge of the window or scrolling region, either as a
124 result of a newline action on the bottom line, or typing the last
125 character of the last line. If disabled, (<EM>bf</EM> is <STRONG>FALSE</STRONG>), the cursor is
126 left on the bottom line. If enabled, (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the window is
127 scrolled up one line (Note that to get the physical scrolling effect on
128 the terminal, it is also necessary to call <STRONG>idlok</STRONG>).
131 </PRE><H3><a name="h3-setscrreg_wsetscrreg">setscrreg, wsetscrreg</a></H3><PRE>
132 The <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> routines allow the application programmer
133 to set a software scrolling region in a window. The <EM>top</EM> and <EM>bot</EM>
134 parameters are the line numbers of the top and bottom margin of the
135 scrolling region. (Line 0 is the top line of the window.) If this
136 option and <STRONG>scrollok</STRONG> are enabled, an attempt to move off the bottom
137 margin line causes all lines in the scrolling region to scroll one line
138 in the direction of the first line. Only the text of the window is
139 scrolled. (Note that this has nothing to do with the use of a physical
140 scrolling region capability in the terminal, like that in the VT100.
141 If <STRONG>idlok</STRONG> is enabled and the terminal has either a scrolling region or
142 insert/delete line capability, they will probably be used by the output
146 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
147 The functions <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> return <STRONG>OK</STRONG> upon success and <STRONG>ERR</STRONG>
148 upon failure. All other routines that return an integer always return
151 X/Open Curses does not specify any error conditions.
153 In this implementation,
155 <STRONG>o</STRONG> those functions that have a window pointer will return <STRONG>ERR</STRONG> if the
156 window pointer is null
158 <STRONG>o</STRONG> <STRONG>wsetscrreg</STRONG> returns <STRONG>ERR</STRONG> if the scrolling region limits extend
159 outside the window boundaries.
162 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
163 Note that <STRONG>clearok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>scrollok</STRONG>, <STRONG>idcok</STRONG>, and <STRONG>setscrreg</STRONG> may be
166 The <STRONG>immedok</STRONG> routine is useful for windows that are used as terminal
170 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
171 These functions are described in X/Open Curses, Issue 4.
173 Some historic curses implementations had, as an undocumented feature,
174 the ability to do the equivalent of <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying
175 <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(stdscr)</STRONG>. This will not work under <EM>ncurses</EM>.
177 Earlier System V curses implementations specified that with <STRONG>scrollok</STRONG>
178 enabled, any window modification triggering a scroll also forced a
179 physical refresh. X/Open Curses does not require this, and <EM>ncurses</EM>
180 avoids doing it to perform better vertical-motion optimization at
181 <STRONG>wrefresh</STRONG> time.
183 X/Open Curses does not mention that the cursor should be made invisible
184 as a side-effect of <STRONG>leaveok</STRONG>. SVr4 curses documentation does this, but
185 the code does not. Use <STRONG>curs_set</STRONG> to make the cursor invisible.
188 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
189 <EM>ncurses</EM> formerly treated <STRONG><A HREF="curs_inopts.3x.html">nl(3x)</A></STRONG> and <STRONG><A HREF="curs_inopts.3x.html">nonl(3x)</A></STRONG> as both input <EM>and</EM> output
190 options, but no longer; see <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>.
193 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
194 <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>,
195 <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
199 ncurses 6.5 2024-05-25 <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
203 <li><a href="#h2-NAME">NAME</a></li>
204 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
205 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
207 <li><a href="#h3-clearok">clearok</a></li>
208 <li><a href="#h3-idcok">idcok</a></li>
209 <li><a href="#h3-idlok">idlok</a></li>
210 <li><a href="#h3-immedok">immedok</a></li>
211 <li><a href="#h3-leaveok">leaveok</a></li>
212 <li><a href="#h3-scrollok">scrollok</a></li>
213 <li><a href="#h3-setscrreg_wsetscrreg">setscrreg, wsetscrreg</a></li>
216 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
217 <li><a href="#h2-NOTES">NOTES</a></li>
218 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
219 <li><a href="#h2-HISTORY">HISTORY</a></li>
220 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>