ncurses 6.1 - patch 20190713
[ncurses.git] / doc / html / man / curs_outopts.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2017,2018 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_outopts.3x,v 1.29 2018/07/28 22:59:02 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_outopts 3x</TITLE>
37 <link rel="author" href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_outopts 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>                                              <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>clearok</STRONG>, <STRONG>idlok</STRONG>, <STRONG>idcok</STRONG>, <STRONG>immedok</STRONG>, <STRONG>leaveok</STRONG>, <STRONG>setscrreg</STRONG>, <STRONG>wsetscrreg</STRONG>,
50        <STRONG>scrollok</STRONG>, <STRONG>nl</STRONG>, <STRONG>nonl</STRONG> - <STRONG>curses</STRONG> output options
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>int</STRONG> <STRONG>clearok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
57        <STRONG>int</STRONG> <STRONG>idlok(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>void</STRONG> <STRONG>immedok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
60        <STRONG>int</STRONG> <STRONG>leaveok(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
61        <STRONG>int</STRONG> <STRONG>setscrreg(int</STRONG> <EM>top</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>bot</EM><STRONG>);</STRONG>
62        <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>
63        <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>nl(void);</STRONG>
65        <STRONG>int</STRONG> <STRONG>nonl(void);</STRONG>
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 <STRONG>curs-</STRONG>
70        <STRONG>es</STRONG>.   All  options are initially <STRONG>FALSE</STRONG>, unless otherwise stated.  It is
71        not necessary to turn these options off before calling <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG>.
72
73
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.
82
83
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 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, <STRONG>curses</STRONG> redraws the changed portions of
93        all lines.
94
95
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 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  <STRONG>idcok</STRONG> with <STRONG>TRUE</STRONG> 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 <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., auto-
107        matically cause a call to <STRONG>wrefresh</STRONG>.  However, it  may  degrade  perfor-
108        mance  considerably, due to repeated calls to <STRONG>wrefresh</STRONG>.  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  <STRONG>leaveok</STRONG> 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-setscrreg">setscrreg</a></H3><PRE>
121        The <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> routines allow the application  programmer
122        to set a software scrolling region in a window.  The <EM>top</EM> and <EM>bot</EM> param-
123        eters are the line  numbers  of  the  top  and  bottom  margin  of  the
124        scrolling region.  (Line 0 is the top line of the window.)  If this op-
125        tion and <STRONG>scrollok</STRONG> are enabled, an attempt to move off the bottom margin
126        line causes all lines in the scrolling region to scroll one line in the
127        direction of the first line.  Only the text of the window is  scrolled.
128        (Note  that this has nothing to do with the use of a physical scrolling
129        region capability in the terminal, like that in the VT100.  If <STRONG>idlok</STRONG> is
130        enabled and the terminal has either a scrolling region or insert/delete
131        line capability, they will probably be used by the output routines.)
132
133
134 </PRE><H3><a name="h3-scrollok">scrollok</a></H3><PRE>
135        The <STRONG>scrollok</STRONG> option controls what happens when the cursor of  a  window
136        is  moved  off  the edge of the window or scrolling region, either as a
137        result of a newline action on the bottom line, or typing the last char-
138        acter of the last line.  If disabled, (<EM>bf</EM> is <STRONG>FALSE</STRONG>), the cursor is left
139        on the bottom line.  If enabled, (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the window  is  scrolled
140        up one line (Note that to get the physical scrolling effect on the ter-
141        minal, it is also necessary to call <STRONG>idlok</STRONG>).
142
143
144 </PRE><H3><a name="h3-nl_-nonl">nl, nonl</a></H3><PRE>
145        The <STRONG>nl</STRONG> and <STRONG>nonl</STRONG> routines control whether the underlying display  device
146        translates  the return key into newline on input, and whether it trans-
147        lates newline into return and line-feed on output (in either case,  the
148        call  <STRONG>addch('\n')</STRONG>  does  the  equivalent of return and line feed on the
149        <EM>virtual</EM> <EM>screen</EM>).  Initially, these translations do occur.  If you  dis-
150        able  them  using  <STRONG>nonl</STRONG>,  <STRONG>curses</STRONG> will be able to make better use of the
151        line-feed capability, resulting in faster cursor motion.  Also,  <STRONG>curses</STRONG>
152        will then be able to detect the return key.
153
154
155 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
156        The  functions  <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> return <STRONG>OK</STRONG> upon success and <STRONG>ERR</STRONG>
157        upon failure.  All other routines that return an integer always  return
158        <STRONG>OK</STRONG>.
159
160        X/Open Curses does not define any error conditions.
161
162        In this implementation, those functions that have a window pointer will
163        return an error if the window pointer is null.
164
165               <STRONG>wclrtoeol</STRONG>
166                    returns an error if the cursor position is about to wrap.
167
168               <STRONG>wsetscrreg</STRONG>
169                    returns an error if the scrolling region limits extend out-
170                    side the window.
171
172        X/Open  does  not define any error conditions.  This implementation re-
173        turns an error if the window pointer is null.
174
175
176 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
177        These functions are described in the XSI Curses standard, Issue 4.
178
179        The XSI Curses standard is ambiguous on the  question  of  whether  <STRONG>raw</STRONG>
180        should  disable  the  CRLF translations controlled by <STRONG>nl</STRONG> and <STRONG>nonl</STRONG>.  BSD
181        curses did turn off these translations; AT&amp;T curses (at least  as  late
182        as  SVr1) did not.  We choose to do so, on the theory that a programmer
183        requesting raw input wants a clean  (ideally  8-bit  clean)  connection
184        that the operating system will not alter.
185
186        Some  historic  curses implementations had, as an undocumented feature,
187        the ability to do the equivalent of <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG>  by  saying  <STRONG>touch-</STRONG>
188        <STRONG>win(stdscr)</STRONG> or <STRONG>clear(stdscr)</STRONG>.  This will not work under ncurses.
189
190        Earlier  System  V  curses implementations specified that with <STRONG>scrollok</STRONG>
191        enabled, any window modification triggering  a  scroll  also  forced  a
192        physical refresh.  XSI Curses does not require this, and <STRONG>ncurses</STRONG> avoids
193        doing it to perform better  vertical-motion  optimization  at  <STRONG>wrefresh</STRONG>
194        time.
195
196        The XSI Curses standard does not mention that the cursor should be made
197        invisible as a side-effect of <STRONG>leaveok</STRONG>.  SVr4 curses documentation  does
198        this,  but  the code does not.  Use <STRONG>curs_set</STRONG> to make the cursor invisi-
199        ble.
200
201
202 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
203        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
204        be macros.
205
206        The <STRONG>immedok</STRONG> routine is useful for windows that are used as terminal em-
207        ulators.
208
209
210 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
211        <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>,
212        <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>.
213
214
215
216                                                               <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
217 </PRE>
218 <div class="nav">
219 <ul>
220 <li><a href="#h2-NAME">NAME</a></li>
221 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
222 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
223 <ul>
224 <li><a href="#h3-clearok">clearok</a></li>
225 <li><a href="#h3-idlok">idlok</a></li>
226 <li><a href="#h3-idcok">idcok</a></li>
227 <li><a href="#h3-immedok">immedok</a></li>
228 <li><a href="#h3-leaveok">leaveok</a></li>
229 <li><a href="#h3-setscrreg">setscrreg</a></li>
230 <li><a href="#h3-scrollok">scrollok</a></li>
231 <li><a href="#h3-nl_-nonl">nl, nonl</a></li>
232 </ul>
233 </li>
234 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
235 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
236 <li><a href="#h2-NOTES">NOTES</a></li>
237 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
238 </ul>
239 </div>
240 </BODY>
241 </HTML>