1 .\"***************************************************************************
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. *
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: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
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. *
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 *
28 .\"***************************************************************************
30 .\" $Id: curs_scroll.3x,v 1.43 2024/04/20 18:54:36 tom Exp $
31 .TH curs_scroll 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
51 scroll a \fIcurses\fR window
54 \fB#include <curses.h>
56 \fBint scroll(WINDOW *\fIwin\fP);
58 \fBint scrl(int \fIn\fP);
59 \fBint wscrl(WINDOW *\fIwin\fP, int \fIn\fP);
62 \fBscroll\fP scrolls the given window up one line.
64 every visible line we might number
68 The text of the top line in the window disappears and the bottom line
69 is populated with blank characters;
70 see \fB\%bkgd\fP(3X) or \fB\%bkgrnd\fP(3X).
72 if the scrolling region of the window is the entire screen,
73 the physical screen may be scrolled at the same time;
74 see \fB\%curscr\fP(3X).
76 \fB\%scrl\fP and \fB\%wscrl\fP scroll
78 or the specified window up or down depending on the sign of
83 line \fIi\fP+\fIn\fP becomes \fIi\fP (scrolling up);
87 line \fIi\fP-\fIn\fP becomes \fIi\fP (scrolling down).
89 The cursor does not move.
90 These functions perform no operation unless scrolling is enabled for the
91 window via \fB\%scrollok\fP(3X).
93 These functions return
100 returns \fBERR\fP if scrolling is not enabled in the window,
101 for example with \fB\%scrollok\fP(3X),
107 there is no \fB\%wscroll\fP function;
108 \fBscroll\fP behaves as one would expect \fB\%wscroll\fP to,
109 accepting a \fI\%WINDOW\fP pointer argument.
111 \fB\%scrl\fP and \fB\%scroll\fP may be implemented as macros.
114 Issue 4 describes these functions.
115 It defines no error conditions.
118 \*(``an integer value other than \fBERR\fP\*('' as a successful return
121 SVr4 indicates that the optimization of physically scrolling immediately
122 if the scroll region is the entire screen \*(``is\*('' performed,
123 not \*(``may be\*('' performed.
125 deliberately does not guarantee that this will occur,
126 to leave open the possibility of smarter optimization of multiple scroll
127 actions on the next update.
131 nor X/Open Curses specify whether the current attribute or current color
132 pair of blanks generated by the scroll function are zeroed.
137 \fB\%curs_outopts\fP(3X)