ncurses 6.2 - patch 20200425
[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.30 2020/02/02 23:34:34 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 <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>                                              <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
45
46
47
48
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>, <STRONG>nl</STRONG>, <STRONG>nonl</STRONG> - <STRONG>curses</STRONG> output options
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
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>setscrreg(int</STRONG> <EM>top</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>bot</EM><STRONG>);</STRONG>
63        <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>
64        <STRONG>int</STRONG> <STRONG>scrollok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
65        <STRONG>int</STRONG> <STRONG>nl(void);</STRONG>
66        <STRONG>int</STRONG> <STRONG>nonl(void);</STRONG>
67
68
69 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
70        These routines set options that change the style of output within <STRONG>curs-</STRONG>
71        <STRONG>es</STRONG>.   All  options are initially <STRONG>FALSE</STRONG>, unless otherwise stated.  It is
72        not necessary to turn these options off before calling <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG>.
73
74
75 </PRE><H3><a name="h3-clearok">clearok</a></H3><PRE>
76        If <STRONG>clearok</STRONG> is called with <STRONG>TRUE</STRONG> as argument, the next call  to  <STRONG>wrefresh</STRONG>
77        with this window will clear the screen completely and redraw the entire
78        screen from scratch.  This is useful when the contents  of  the  screen
79        are  uncertain, or in some cases for a more pleasing visual effect.  If
80        the <EM>win</EM> argument to <STRONG>clearok</STRONG> is the global  variable  <STRONG>curscr</STRONG>,  the  next
81        call  to  <STRONG>wrefresh</STRONG>  with any window causes the screen to be cleared and
82        repainted from scratch.
83
84
85 </PRE><H3><a name="h3-idlok">idlok</a></H3><PRE>
86        If <STRONG>idlok</STRONG> is called with <STRONG>TRUE</STRONG> as second argument, <STRONG>curses</STRONG> considers using
87        the  hardware  insert/delete  line  feature  of  terminals so equipped.
88        Calling <STRONG>idlok</STRONG> with <STRONG>FALSE</STRONG> as second argument disables use of line inser-
89        tion  and deletion.  This option should be enabled only if the applica-
90        tion needs insert/delete line, for example, for a screen editor.  It is
91        disabled by default because insert/delete line tends to be visually an-
92        noying when used in applications where it is not really needed.  If in-
93        sert/delete line cannot be used, <STRONG>curses</STRONG> redraws the changed portions of
94        all lines.
95
96
97 </PRE><H3><a name="h3-idcok">idcok</a></H3><PRE>
98        If <STRONG>idcok</STRONG> is called with <STRONG>FALSE</STRONG> as second argument, <STRONG>curses</STRONG> no longer con-
99        siders  using the hardware insert/delete character feature of terminals
100        so equipped.  Use of character insert/delete  is  enabled  by  default.
101        Calling  <STRONG>idcok</STRONG> with <STRONG>TRUE</STRONG> as second argument re-enables use of character
102        insertion and deletion.
103
104
105 </PRE><H3><a name="h3-immedok">immedok</a></H3><PRE>
106        If <STRONG>immedok</STRONG> is called with <STRONG>TRUE</STRONG> <STRONG>as</STRONG> <STRONG>argument</STRONG>, any change  in  the  window
107        image, such as the ones caused by <STRONG>waddch,</STRONG> <STRONG>wclrtobot,</STRONG> <STRONG>wscrl</STRONG>, etc., auto-
108        matically cause a call to <STRONG>wrefresh</STRONG>.  However, it  may  degrade  perfor-
109        mance  considerably, due to repeated calls to <STRONG>wrefresh</STRONG>.  It is disabled
110        by default.
111
112
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  appli-
117        cations  where  the  cursor  is not used, since it reduces the need for
118        cursor motions.
119
120
121 </PRE><H3><a name="h3-setscrreg">setscrreg</a></H3><PRE>
122        The <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> routines allow the application  programmer
123        to set a software scrolling region in a window.  The <EM>top</EM> and <EM>bot</EM> param-
124        eters are the line  numbers  of  the  top  and  bottom  margin  of  the
125        scrolling region.  (Line 0 is the top line of the window.)  If this op-
126        tion and <STRONG>scrollok</STRONG> are enabled, an attempt to move off the bottom margin
127        line causes all lines in the scrolling region to scroll one line in the
128        direction of the first line.  Only the text of the window is  scrolled.
129        (Note  that this has nothing to do with the use of a physical scrolling
130        region capability in the terminal, like that in the VT100.  If <STRONG>idlok</STRONG> is
131        enabled and the terminal has either a scrolling region or insert/delete
132        line capability, they will probably be used by the output routines.)
133
134
135 </PRE><H3><a name="h3-scrollok">scrollok</a></H3><PRE>
136        The <STRONG>scrollok</STRONG> option controls what happens when the cursor of  a  window
137        is  moved  off  the edge of the window or scrolling region, either as a
138        result of a newline action on the bottom line, or typing the last char-
139        acter of the last line.  If disabled, (<EM>bf</EM> is <STRONG>FALSE</STRONG>), the cursor is left
140        on the bottom line.  If enabled, (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the window  is  scrolled
141        up one line (Note that to get the physical scrolling effect on the ter-
142        minal, it is also necessary to call <STRONG>idlok</STRONG>).
143
144
145 </PRE><H3><a name="h3-nl_-nonl">nl, nonl</a></H3><PRE>
146        The <STRONG>nl</STRONG> and <STRONG>nonl</STRONG> routines control whether the underlying display  device
147        translates  the return key into newline on input, and whether it trans-
148        lates newline into return and line-feed on output (in either case,  the
149        call  <STRONG>addch('\n')</STRONG>  does  the  equivalent of return and line feed on the
150        <EM>virtual</EM> <EM>screen</EM>).  Initially, these translations do occur.  If you  dis-
151        able  them  using  <STRONG>nonl</STRONG>,  <STRONG>curses</STRONG> will be able to make better use of the
152        line-feed capability, resulting in faster cursor motion.  Also,  <STRONG>curses</STRONG>
153        will then be able to detect the return key.
154
155
156 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
157        The  functions  <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> return <STRONG>OK</STRONG> upon success and <STRONG>ERR</STRONG>
158        upon failure.  All other routines that return an integer always  return
159        <STRONG>OK</STRONG>.
160
161        X/Open Curses does not define any error conditions.
162
163        In this implementation, those functions that have a window pointer will
164        return an error if the window pointer is null.
165
166               <STRONG>wclrtoeol</STRONG>
167                    returns an error if the cursor position is about to wrap.
168
169               <STRONG>wsetscrreg</STRONG>
170                    returns an error if the scrolling region limits extend out-
171                    side the window.
172
173        X/Open  does  not define any error conditions.  This implementation re-
174        turns an error if the window pointer is null.
175
176
177 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
178        These functions are described in the XSI Curses standard, Issue 4.
179
180        The XSI Curses standard is ambiguous on the  question  of  whether  <STRONG>raw</STRONG>
181        should  disable  the  CRLF translations controlled by <STRONG>nl</STRONG> and <STRONG>nonl</STRONG>.  BSD
182        curses did turn off these translations; AT&amp;T curses (at least  as  late
183        as  SVr1) did not.  We choose to do so, on the theory that a programmer
184        requesting raw input wants a clean  (ideally  8-bit  clean)  connection
185        that the operating system will not alter.
186
187        Some  historic  curses implementations had, as an undocumented feature,
188        the ability to do the equivalent of <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG>  by  saying  <STRONG>touch-</STRONG>
189        <STRONG>win(stdscr)</STRONG> or <STRONG>clear(stdscr)</STRONG>.  This will not work under ncurses.
190
191        Earlier  System  V  curses implementations specified that with <STRONG>scrollok</STRONG>
192        enabled, any window modification triggering  a  scroll  also  forced  a
193        physical refresh.  XSI Curses does not require this, and <STRONG>ncurses</STRONG> avoids
194        doing it to perform better  vertical-motion  optimization  at  <STRONG>wrefresh</STRONG>
195        time.
196
197        The XSI Curses standard does not mention that the cursor should be made
198        invisible as a side-effect of <STRONG>leaveok</STRONG>.  SVr4 curses documentation  does
199        this,  but  the code does not.  Use <STRONG>curs_set</STRONG> to make the cursor invisi-
200        ble.
201
202
203 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
204        Note that <STRONG>clearok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>scrollok</STRONG>, <STRONG>idcok</STRONG>, <STRONG>nl</STRONG>, <STRONG>nonl</STRONG> and <STRONG>setscrreg</STRONG> may
205        be macros.
206
207        The <STRONG>immedok</STRONG> routine is useful for windows that are used as terminal em-
208        ulators.
209
210
211 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
212        <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>,
213        <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>.
214
215
216
217                                                               <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
218 </PRE>
219 <div class="nav">
220 <ul>
221 <li><a href="#h2-NAME">NAME</a></li>
222 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
223 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
224 <ul>
225 <li><a href="#h3-clearok">clearok</a></li>
226 <li><a href="#h3-idlok">idlok</a></li>
227 <li><a href="#h3-idcok">idcok</a></li>
228 <li><a href="#h3-immedok">immedok</a></li>
229 <li><a href="#h3-leaveok">leaveok</a></li>
230 <li><a href="#h3-setscrreg">setscrreg</a></li>
231 <li><a href="#h3-scrollok">scrollok</a></li>
232 <li><a href="#h3-nl_-nonl">nl, nonl</a></li>
233 </ul>
234 </li>
235 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
236 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
237 <li><a href="#h2-NOTES">NOTES</a></li>
238 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
239 </ul>
240 </div>
241 </BODY>
242 </HTML>