ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / curs_outopts.3x.html
1 <!--
2   ****************************************************************************
3   * Copyright 2018,2020 Thomas E. Dickey                                     *
4   * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
5   *                                                                          *
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:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
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.                               *
24   *                                                                          *
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       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: curs_outopts.3x,v 1.33 2020/10/03 22:04:09 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
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</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_outopts 3X</H1>
43 <PRE>
44 <B><A HREF="curs_outopts.3X.html">curs_outopts(3X)</A></B>                                              <B><A HREF="curs_outopts.3X.html">curs_outopts(3X)</A></B>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <B>clearok</B>, <B>idlok</B>, <B>idcok</B>, <B>immedok</B>, <B>leaveok</B>, <B>setscrreg</B>, <B>wsetscrreg</B>,
51        <B>scrollok</B> - <B>curses</B> output options
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <B>#include</B> <B>&lt;curses.h&gt;</B>
56
57        <B>int</B> <B>clearok(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>bool</B> <I>bf</I><B>);</B>
58        <B>int</B> <B>idlok(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>bool</B> <I>bf</I><B>);</B>
59        <B>void</B> <B>idcok(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>bool</B> <I>bf</I><B>);</B>
60        <B>void</B> <B>immedok(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>bool</B> <I>bf</I><B>);</B>
61        <B>int</B> <B>leaveok(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>bool</B> <I>bf</I><B>);</B>
62        <B>int</B> <B>scrollok(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>bool</B> <I>bf</I><B>);</B>
63
64        <B>int</B> <B>setscrreg(int</B> <I>top</I><B>,</B> <B>int</B> <I>bot</I><B>);</B>
65        <B>int</B> <B>wsetscrreg(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>top</I><B>,</B> <B>int</B> <I>bot</I><B>);</B>
66
67
68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69        These routines set options that change the style of output within <B>curs-</B>
70        <B>es</B>.   All  options are initially <B>FALSE</B>, unless otherwise stated.  It is
71        not necessary to turn these options off before calling <B><A HREF="curs_initscr.3X.html">endwin(3X)</A></B>.
72
73
74 </PRE><H3><a name="h3-clearok">clearok</a></H3><PRE>
75        If <B>clearok</B> is called with <B>TRUE</B> as argument, the next call  to  <B>wrefresh</B>
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 <I>win</I> argument to <B>clearok</B> is the global  variable  <B>curscr</B>,  the  next
80        call  to  <B>wrefresh</B>  with any window causes the screen to be cleared and
81        repainted from scratch.
82
83
84 </PRE><H3><a name="h3-idlok">idlok</a></H3><PRE>
85        If <B>idlok</B> is called with <B>TRUE</B> as second argument, <B>curses</B> considers using
86        the  hardware  insert/delete  line  feature  of  terminals so equipped.
87        Calling <B>idlok</B> with <B>FALSE</B> as second argument disables use of line inser-
88        tion  and deletion.  This option should be enabled only if the applica-
89        tion needs insert/delete line, for example, for a screen editor.  It is
90        disabled by default because insert/delete line tends to be visually an-
91        noying when used in applications where it is not really needed.  If in-
92        sert/delete line cannot be used, <B>curses</B> redraws the changed portions of
93        all lines.
94
95
96 </PRE><H3><a name="h3-idcok">idcok</a></H3><PRE>
97        If <B>idcok</B> is called with <B>FALSE</B> as second argument, <B>curses</B> no longer con-
98        siders  using the hardware insert/delete character feature of terminals
99        so equipped.  Use of character insert/delete  is  enabled  by  default.
100        Calling  <B>idcok</B> with <B>TRUE</B> as second argument re-enables use of character
101        insertion and deletion.
102
103
104 </PRE><H3><a name="h3-immedok">immedok</a></H3><PRE>
105        If <B>immedok</B> is called with <B>TRUE</B> <B>as</B> <B>argument</B>, any change  in  the  window
106        image, such as the ones caused by <B>waddch,</B> <B>wclrtobot,</B> <B>wscrl</B>, etc., auto-
107        matically cause a call to <B>wrefresh</B>.  However, it  may  degrade  perfor-
108        mance  considerably, due to repeated calls to <B>wrefresh</B>.  It is disabled
109        by default.
110
111
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  <B>leaveok</B> option allows the cursor to be
115        left wherever the update happens to leave it.  It is useful for  appli-
116        cations  where  the  cursor  is not used, since it reduces the need for
117        cursor motions.
118
119
120 </PRE><H3><a name="h3-scrollok">scrollok</a></H3><PRE>
121        The <B>scrollok</B> 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 char-
124        acter of the last line.  If disabled, (<I>bf</I> is <B>FALSE</B>), the cursor is left
125        on the bottom line.  If enabled, (<I>bf</I> is <B>TRUE</B>), the window  is  scrolled
126        up one line (Note that to get the physical scrolling effect on the ter-
127        minal, it is also necessary to call <B>idlok</B>).
128
129
130 </PRE><H3><a name="h3-setscrreg_wsetscrreg">setscrreg/wsetscrreg</a></H3><PRE>
131        The <B>setscrreg</B> and <B>wsetscrreg</B> routines allow the application  programmer
132        to set a software scrolling region in a window.  The <I>top</I> and <I>bot</I> param-
133        eters 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 op-
135        tion and <B>scrollok</B> are enabled, an attempt to move off the bottom margin
136        line causes all lines in the scrolling region to scroll one line in the
137        direction of the first line.  Only the text of the window is  scrolled.
138        (Note  that this has nothing to do with the use of a physical scrolling
139        region capability in the terminal, like that in the VT100.  If <B>idlok</B> is
140        enabled and the terminal has either a scrolling region or insert/delete
141        line capability, they will probably be used by the output routines.)
142
143
144 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
145        The functions <B>setscrreg</B> and <B>wsetscrreg</B> return <B>OK</B> upon success  and  <B>ERR</B>
146        upon  failure.  All other routines that return an integer always return
147        <B>OK</B>.
148
149        X/Open Curses does not define any error conditions.
150
151        In this implementation,
152
153        <B>o</B>   those functions that have a window pointer will return an error  if
154            the window pointer is null
155
156        <B>o</B>   <B>wsetscrreg</B>  returns  an error if the scrolling region limits extend
157            outside the window.
158
159        X/Open does not define any error conditions.  This  implementation  re-
160        turns an error if the window pointer is null.
161
162
163 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
164        These functions are described in the XSI Curses standard, Issue 4.
165
166        From the outset, ncurses used <B>nl</B>/<B>nonl</B> to control the conversion of new-
167        lines to carriage return/line-feed on output as  well  as  input.   XSI
168        Curses  documents only the use of these functions for input.  This dif-
169        ference arose from converting the  <I>pcurses</I>  source  (which  used  <B>ioctl</B>
170        calls  with  the <B>sgttyb</B> structure) to termios (i.e., the POSIX terminal
171        interface).  In the former, both input and output were controlled via a
172        single  option  <B>CRMOD</B>,  while the latter separates these features.  Be-
173        cause that conversion interferes with output optimization, <B>nl</B>/<B>nonl</B> were
174        amended after ncurses 6.2 to eliminate their effect on output.
175
176        Some  historic  curses implementations had, as an undocumented feature,
177        the ability to do the equivalent of <B>clearok(...,</B> <B>1)</B>  by  saying  <B>touch-</B>
178        <B>win(stdscr)</B> or <B>clear(stdscr)</B>.  This will not work under ncurses.
179
180        Earlier  System  V  curses implementations specified that with <B>scrollok</B>
181        enabled, any window modification triggering  a  scroll  also  forced  a
182        physical refresh.  XSI Curses does not require this, and <B>ncurses</B> avoids
183        doing it to perform better  vertical-motion  optimization  at  <B>wrefresh</B>
184        time.
185
186        The XSI Curses standard does not mention that the cursor should be made
187        invisible as a side-effect of <B>leaveok</B>.  SVr4 curses documentation  does
188        this,  but  the code does not.  Use <B>curs_set</B> to make the cursor invisi-
189        ble.
190
191
192 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
193        Note that <B>clearok</B>, <B>leaveok</B>,  <B>scrollok</B>,  <B>idcok</B>,  and  <B>setscrreg</B>  may  be
194        macros.
195
196        The <B>immedok</B> routine is useful for windows that are used as terminal em-
197        ulators.
198
199
200 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
201        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_addch.3X.html">curs_addch(3X)</A></B>, <B><A HREF="curs_clear.3X.html">curs_clear(3X)</A></B>, <B><A HREF="curs_initscr.3X.html">curs_initscr(3X)</A></B>,
202        <B><A HREF="curs_scroll.3X.html">curs_scroll(3X)</A></B>, <B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>.
203
204
205
206                                                               <B><A HREF="curs_outopts.3X.html">curs_outopts(3X)</A></B>
207 </PRE>
208 <div class="nav">
209 <ul>
210 <li><a href="#h2-NAME">NAME</a></li>
211 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
212 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
213 <ul>
214 <li><a href="#h3-clearok">clearok</a></li>
215 <li><a href="#h3-idlok">idlok</a></li>
216 <li><a href="#h3-idcok">idcok</a></li>
217 <li><a href="#h3-immedok">immedok</a></li>
218 <li><a href="#h3-leaveok">leaveok</a></li>
219 <li><a href="#h3-scrollok">scrollok</a></li>
220 <li><a href="#h3-setscrreg_wsetscrreg">setscrreg/wsetscrreg</a></li>
221 </ul>
222 </li>
223 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
224 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
225 <li><a href="#h2-NOTES">NOTES</a></li>
226 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
227 </ul>
228 </div>
229 </BODY>
230 </HTML>