scrl(3xcurses) [opensolaris man page]

scrl(3XCURSES)						  X/Open Curses Library Functions					    scrl(3XCURSES)

NAME

       scrl, scroll, wscrl - scroll a window

SYNOPSIS

       cc [ flag... ] file... -I /usr/xpg4/include  -L	/usr/xpg4/lib 
	-R  /usr/xpg4/lib  -lcurses  [ library... ]

       c89 [ flag... ] file... -lcurses [ library... ]

       #include <curses.h>

       int scrl(int n);

       int scroll(WINDOW *win);

       int wscrl(WINDOW *win, int n);

PARAMETERS

       n      number and direction of lines to scroll

       win    pointer to the window in which to scroll

DESCRIPTION

       The scroll() function scrolls the window win up one line.  The current cursor position is not changed.

       The  scrl() and wscrl() functions scroll the window stdscr or win up or down n lines, where n is a positive (scroll up) or negative (scroll
       down) integer.

       The scrollok(3XCURSES) function must be enabled for these functions to work.

RETURN VALUES

       On success, these functions return OK. Otherwise, they return ERR.

ERRORS

       None.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       clearok(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)

SunOS 5.11							    5 Jun 2002							    scrl(3XCURSES)

scroll(3NCURSES)														  scroll(3NCURSES)

NAME

       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

       ncurses(3NCURSES), outopts(3NCURSES)

																  scroll(3NCURSES)