4 <!-- Manpage converted by man2html 3.0.1 -->
8 <B>scroll</B>, <B>scrl</B>, <B>wscrl</B> - scroll a <B>curses</B> window
12 <H2>SYNOPSIS</H2><PRE>
13 <B>#include</B> <B><curses.h></B>
15 <B>int</B> <B>scroll(WINDOW</B> <B>*win);</B>
16 <B>int</B> <B>scrl(int</B> <B>n);</B>
17 <B>int</B> <B>wscrl(WINDOW</B> <B>*win,</B> <B>int</B> <B>n);</B>
21 <H2>DESCRIPTION</H2><PRE>
22 The <B>scroll</B> routine scrolls the window up one line. This
23 involves moving the lines in the window data structure.
24 As an optimization, if the scrolling region of the window
25 is the entire screen, the physical screen may be scrolled
28 For positive <I>n</I>, the <B>scrl</B> and <B>wscrl</B> routines scroll the
29 window up <I>n</I> lines (line <I>i</I>+<I>n</I> becomes <I>i</I>); otherwise scroll
30 the window down <I>n</I> lines. This involves moving the lines
31 in the window character image structure. The current cur-
32 sor position is not changed.
34 For these functions to work, scrolling must be enabled via
39 <H2>RETURN VALUE</H2><PRE>
40 These routines return <B>ERR</B> upon failure, and <B>OK</B> (SVr4 only
41 specifies "an integer value other than <B>ERR</B>") upon success-
47 Note that <B>scrl</B> and <B>scroll</B> may be macros.
49 The SVr4 documentation says that the optimization of phys-
50 ically scrolling immediately if the scroll region is the
51 entire screen "is" performed, not "may be" performed.
52 This implementation deliberately does not guarantee that
53 this will occur, in order to leave open the possibility of
54 smarter optimization of multiple scroll actions on the
57 Neither the SVr4 nor the XSI documentation specify whether
58 the current attribute or current color-pair of blanks gen-
59 erated by the scroll function is zeroed. Under this
64 <H2>PORTABILITY</H2><PRE>
65 The XSI Curses standard, Issue 4 describes these func-
70 <H2>SEE ALSO</H2><PRE>
71 <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>
76 Man(1) output converted with
77 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>