1curs_scroll(3CURSES)       Curses Library Functions       curs_scroll(3CURSES)
2
3
4

NAME

6       curs_scroll, scroll, scrl, wscrl - scroll a curses window
7

SYNOPSIS

9       cc [ flag ... ] file ... -lcurses [ library ... ]
10       #include <curses.h>
11
12       int scroll(WINDOW *win);
13
14
15       int scrl(int n);
16
17
18       int wscrl(WINDOW *win, int n);
19
20

DESCRIPTION

22       With  the  scroll()  routine,  the window is scrolled up one line. This
23       involves moving the lines in the window data structure. As an optimiza‐
24       tion,  if  the scrolling region of the window is the entire screen, the
25       physical screen is scrolled at the same time.
26
27
28       With the scrl() and wscrl() routines, for positive n scroll the  window
29       up  n  lines  (line  i+n becomes i); otherwise scroll the window down n
30       lines. This involves moving the lines in  the  window  character  image
31       structure. The current cursor position is not changed.
32
33
34       For these functions to work, scrolling must be enabled via scrollok().
35

RETURN VALUES

37       All  routines  return the integer ERR upon failure and an integer value
38       other than ERR upon successful completion.
39

ATTRIBUTES

41       See attributes(5) for descriptions of the following attributes:
42
43
44
45
46       ┌─────────────────────────────┬─────────────────────────────┐
47       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
48       ├─────────────────────────────┼─────────────────────────────┤
49       │MT-Level                     │Unsafe                       │
50       └─────────────────────────────┴─────────────────────────────┘
51

SEE ALSO

53       curs_outopts(3CURSES), curses(3CURSES), attributes(5)
54

NOTES

56       The header <curses.h> automatically includes the headers  <stdio.h> and
57       <unctrl.h>.
58
59
60       Note that scrl() and scroll() may be macros.
61
62
63
64SunOS 5.11                        31 Dec 1996             curs_scroll(3CURSES)