CURSES_SCROLL(3)

CURSES_SCROLL(3) | Library Functions Manual | CURSES_SCROLL(3)

# NAME

curses_scroll, scrl, wscrl scroll, scrollok, setscrreg, wsetscrreg — curses window scrolling routines

# LIBRARY

Curses Library (libcurses, -lcurses)

# SYNOPSIS

#include <curses.h>
int
scrl(int n);
int
wscrl(WINDOW *win, int n);
int
scroll(WINDOW *win);
int
scrollok(WINDOW *win, boolf flag);
int
setscrreg(int top, int bottom);
int
wsetscrreg(WINDOW *win, int top, int bottom);

# DESCRIPTION

These functions scroll areas on `stdscr` or on the specified window.
The scrl() function scrolls `stdscr` by n lines. If n is positive then then `stdscr` is scrolled up. n lines are lost from the top of `stdscr` and n blank lines are inserted at the bottom. If n is negative then `stdscr` is scrolled down. n blank lines are inserted at the top of `stdscr` and n lines are lost from the bottom.
The wscrl() function is the same as the scrl() function, excepting that it scrolls the window specified by win.
The scroll() function scrolls the window win up by one line.
The scrolling behaviour of a window can be controlled by using the scrollok() function. If the flag argument is `TRUE` then a line wrap at the bottom of the window will cause the window to be scrolled up one line, if flag is `FALSE` then lines that would force a scroll will be truncated.
The setscrreg() function sets up a software scrolling region on `stdscr` which will define a region of the screen that will be scrolled. The scrolling of this region is also controlled by the scrollok() function.
The wsetscrreg() function does the same as the setscrreg() function, except that the scrolling region is set on the window specified by win.
If a scrolling region has been set with the setscrreg() or wsetscrreg() functions and the current cursor position is inside the scrolling region, then only the area inside the scrolling region is scrolled.

# RETURN VALUES

Functions returning pointers will return `NULL` if an error is detected. The functions that return an int will return one of the following values:

`OK`
  The function completed successfully.
`ERR`
  An error occurred in the function.

# SEE ALSO

curses_deleteln(3), curses_insdelln(3), curses_insertln(3)

# STANDARDS

The NetBSD Curses library complies with the X/Open Curses specification, part of the Single Unix Specification.

# HISTORY

The Curses package appeared in 4.0BSD.

August 12, 2002 | NetBSD 8.3