Index for Section 3

Alphabetical listing for C

Bottom of page

curs_scroll(3)
NAME
  curs_scroll, 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 );

LIBRARY
  Curses Library (libcurses)

STANDARDS
  Interfaces documented on this reference page conform to industry standards
  as follows:

  scrl, wscrl, scroll:	XCURSES4.2

  Refer to the standards(5) reference page for more information about
  industry standards and associated tags.

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 is
  scrolled at the same time.

  The scrl and wscrl routines, for positive n, scroll the current or
  specified window up n lines (line i+n becomes line i); otherwise, these
  routines scroll the window down n lines. This operation involves moving the
  lines in the window character-image structure. The routines do not change
  the current cursor position.

  For the scroll, scrl, and wscrl functions to work, the scrollok option must
  be enabled.

NOTES
  The header file <curses.h> automatically includes the header file
  <stdio.h>.

  Note that scrl may be a macro.

RETURN VALUES
  All routines return the integer ERR upon failure and OK upon successful
  completion.

SEE ALSO
  Functions: curses(3), curs_outopts(3)

  Others: standards(5)

Index for Section 3

Alphabetical listing for C

Top of page