ncurses 5.3
[ncurses.git] / doc / html / man / curs_scroll.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998,2000,2001 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.9 2001/10/14 00:51:56 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_scroll 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_scroll 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43
44 </PRE>
45 <H2>NAME</H2><PRE>
46        <STRONG>scroll</STRONG>, <STRONG>scrl</STRONG>, <STRONG>wscrl</STRONG> - scroll a <STRONG>curses</STRONG> window
47
48
49 </PRE>
50 <H2>SYNOPSIS</H2><PRE>
51        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
52
53        <STRONG>int</STRONG> <STRONG>scroll(WINDOW</STRONG> <STRONG>*win);</STRONG>
54        <STRONG>int</STRONG> <STRONG>scrl(int</STRONG> <STRONG>n);</STRONG>
55        <STRONG>int</STRONG> <STRONG>wscrl(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
56
57
58 </PRE>
59 <H2>DESCRIPTION</H2><PRE>
60        The  <STRONG>scroll</STRONG>  routine scrolls the window up one line.  This
61        involves moving the lines in the  window  data  structure.
62        As  an optimization, if the scrolling region of the window
63        is the entire screen, the physical screen may be  scrolled
64        at the same time.
65
66        For  positive  <EM>n</EM>,  the  <STRONG>scrl</STRONG> and <STRONG>wscrl</STRONG> routines scroll the
67        window up <EM>n</EM> lines (line <EM>i</EM>+<EM>n</EM> becomes <EM>i</EM>);  otherwise  scroll
68        the  window  down <EM>n</EM> lines.  This involves moving the lines
69        in the window character image structure.  The current cur-
70        sor position is not changed.
71
72        For these functions to work, scrolling must be enabled via
73        <STRONG>scrollok</STRONG>.
74
75
76 </PRE>
77 <H2>RETURN VALUE</H2><PRE>
78        These routines return <STRONG>ERR</STRONG> upon failure, and <STRONG>OK</STRONG> (SVr4  only
79        specifies "an integer value other than <STRONG>ERR</STRONG>") upon success-
80        ful completion.
81
82
83 </PRE>
84 <H2>NOTES</H2><PRE>
85        Note that <STRONG>scrl</STRONG> and <STRONG>scroll</STRONG> may be macros.
86
87        The SVr4 documentation says that the optimization of phys-
88        ically  scrolling  immediately if the scroll region is the
89        entire screen "is"  performed,  not  "may  be"  performed.
90        This  implementation  deliberately does not guarantee that
91        this will occur, to leave open the possibility of  smarter
92        optimization  of  multiple  scroll  actions  on  the  next
93        update.
94
95        Neither the SVr4 nor the XSI documentation specify whether
96        the current attribute or current color-pair of blanks gen-
97        erated by the  scroll  function  is  zeroed.   Under  this
98        implementation it is.
99
100
101 </PRE>
102 <H2>PORTABILITY</H2><PRE>
103        The  XSI  Curses  standard,  Issue 4 describes these func-
104        tions.
105
106
107 </PRE>
108 <H2>SEE ALSO</H2><PRE>
109        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
110
111 </PRE>
112 <HR>
113 <ADDRESS>
114 Man(1) output converted with
115 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
116 </ADDRESS>
117 </BODY>
118 </HTML>