Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
curs_scroll(3CURSES)	   Curses Library Functions	  curs_scroll(3CURSES)

NAME
       curs_scroll, scroll, scrl, wscrl	- scroll a curses window

SYNOPSIS
       cc [ flag ... ] file ...	-lcurses [ library ... ]
       #include	<curses.h>

       int scroll(WINDOW *win);

       int scrl(int n);

       int wscrl(WINDOW	*win, int n);

DESCRIPTION
       With the	scroll() routine, the window is	scrolled up one	line. This in-
       volves moving the lines in the window data structure. As	 an  optimiza-
       tion,  if  the scrolling	region of the window is	the entire screen, the
       physical	screen is scrolled at the same time.

       With the	scrl() and wscrl() routines, for positive n 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 VALUES
       All  routines  return the integer ERR upon failure and an integer value
       other than ERR upon successful completion.

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE	TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       curs_outopts(3CURSES), curses(3CURSES), attributes(5)

NOTES
       The header <curses.h> automatically includes the	headers	 <stdio.h> and
       <unctrl.h>.

       Note that scrl()	and scroll() may be macros.

SunOS 5.10			  31 Dec 1996		  curs_scroll(3CURSES)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ATTRIBUTES | SEE ALSO | NOTES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=scroll&sektion=3curses&manpath=SunOS+5.10>

home | help