ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / curs_scroll.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
4   * Copyright 1998-2006,2010 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_scroll.3x,v 1.18 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_scroll 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_scroll 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>                                                <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>scroll</STRONG>, <STRONG>scrl</STRONG>, <STRONG>wscrl</STRONG> - scroll a <STRONG>curses</STRONG> window
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>scroll(WINDOW</STRONG> <STRONG>*win);</STRONG>
57        <STRONG>int</STRONG> <STRONG>scrl(int</STRONG> <STRONG>n);</STRONG>
58        <STRONG>int</STRONG> <STRONG>wscrl(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        The  <STRONG>scroll</STRONG> routine scrolls the window up one line.  This involves mov-
63        ing the lines in the window data structure.  As an optimization, if the
64        scrolling  region  of  the  window  is  the entire screen, the <EM>physical</EM>
65        <EM>screen</EM> may be scrolled at the same time.
66
67        For positive <EM>n</EM>, the <STRONG>scrl</STRONG> and <STRONG>wscrl</STRONG> routines  scroll  the  window  up  <EM>n</EM>
68        lines  (line  <EM>i</EM>+<EM>n</EM> becomes <EM>i</EM>); otherwise scroll the window down <EM>n</EM> lines.
69        This involves moving the lines in the window character image structure.
70        The current cursor position is not changed.
71
72        For these functions to work, scrolling must be enabled via <STRONG>scrollok</STRONG>.
73
74
75 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
76        These routines return <STRONG>ERR</STRONG> upon failure, and <STRONG>OK</STRONG> (SVr4 only specifies "an
77        integer value other than <STRONG>ERR</STRONG>") upon successful completion.
78
79        X/Open defines no error conditions.
80
81        This implementation returns an error if the window pointer is null,  or
82        if scrolling is not enabled in the window, e.g., with <STRONG>scrollok</STRONG>.
83
84
85 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
86        Note that <STRONG>scrl</STRONG> and <STRONG>scroll</STRONG> may be macros.
87
88        The  SVr4  documentation  says  that  the  optimization  of  physically
89        scrolling immediately if the scroll region is the  entire  screen  "is"
90        performed,  not  "may  be" performed.  This implementation deliberately
91        does not guarantee that this will occur, to leave open the  possibility
92        of smarter optimization of multiple scroll actions on the next update.
93
94        Neither  the SVr4 nor the XSI documentation specify whether the current
95        attribute or current color-pair of blanks generated by the scroll func-
96        tion is zeroed.  Under this implementation it is.
97
98
99 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
100        The XSI Curses standard, Issue 4 describes these functions.
101
102
103 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
104        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
105
106
107
108                                                                <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>
109 </PRE>
110 <div class="nav">
111 <ul>
112 <li><a href="#h2-NAME">NAME</a></li>
113 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
114 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
115 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
116 <li><a href="#h2-NOTES">NOTES</a></li>
117 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
118 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
119 </ul>
120 </div>
121 </BODY>
122 </HTML>