Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

scrollok(3) [netbsd man page]

CURSES_SCROLL(3)					   BSD Library Functions Manual 					  CURSES_SCROLL(3)

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 trun- cated. 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. BSD
August 12, 2002 BSD

Check Out this Related Man Page

curs_scroll(3X) 														   curs_scroll(3X)

scroll, scrl, wscrl - scroll a curses window SYNOPSIS
#include <curses.h> int scroll(WINDOW *win); int scrl(int n); int wscrl(WINDOW *win, int n); DESCRIPTION
The scroll routine scrolls the window up one line. This involves moving the lines in the window data structure. As an optimization, if the scrolling region of the window is the entire screen, the physical screen may be scrolled at the same time. For positive n, the scrl and wscrl routines scroll the window up n lines (line i+n becomes i); otherwise scroll the window down n lines. This involves moving the lines in the window character image structure. The current cursor position is not changed. For these functions to work, scrolling must be enabled via scrollok. RETURN VALUE
These routines return ERR upon failure, and OK (SVr4 only specifies "an integer value other than ERR") upon successful completion. X/Open defines no error conditions. This implementation returns an error if the window pointer is null, or if scrolling is not enabled in the window, e.g., with scrollok. NOTES
Note that scrl and scroll may be macros. The SVr4 documentation says that the optimization of physically scrolling immediately if the scroll region is the entire screen "is" per- formed, not "may be" performed. This implementation deliberately does not guarantee that this will occur, to leave open the possibility of smarter optimization of multiple scroll actions on the next update. Neither the SVr4 nor the XSI documentation specify whether the current attribute or current color-pair of blanks generated by the scroll function is zeroed. Under this implementation it is. PORTABILITY
The XSI Curses standard, Issue 4 describes these functions. SEE ALSO
curses(3X), curs_outopts(3X) curs_scroll(3X)
Man Page