usr/src/man/man3curses/curs_scroll.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH CURS_SCROLL 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_scroll, scroll, scrl, wscrl \- scroll a curses window
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  14 #include <curses.h>
  15
  16 \fBint\fR \fBscroll\fR(\fBWINDOW *\fR\fIwin\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBscrl\fR(\fBint\fR \fIn\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBint\fR \fBwscrl\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIn\fR);
  27 .fi
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 With the \fBscroll()\fR routine, the window is scrolled up one line. This
  33 involves moving the lines in the window data structure. As an optimization, if
  34 the scrolling region of the window is the entire screen, the physical screen is
  35 scrolled at the same time.
  36 .sp
  37 .LP
  38 With the \fBscrl()\fR and \fBwscrl()\fR routines, for positive \fIn\fR scroll
  39 the window up \fIn\fR lines (line \fIi+n\fR becomes \fIi\fR); otherwise scroll
  40 the window down \fIn\fR lines. This involves moving the lines in the window
  41 character image structure. The current cursor position is not changed.
  42 .sp
  43 .LP
  44 For these functions to work, scrolling must be enabled via \fBscrollok()\fR.
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 All routines return the integer \fBERR\fR upon failure and an integer value
  49 other than \fBERR\fR upon successful completion.
  50 .SH ATTRIBUTES
  51 .sp
  52 .LP
  53 See \fBattributes\fR(5) for descriptions of the following attributes:
  54 .sp
  55
  56 .sp
  57 .TS
  58 box;
  59 c | c
  60 l | l .
  61 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  62 _
  63 MT-Level        Unsafe
  64 .TE
  65
  66 .SH SEE ALSO
  67 .sp
  68 .LP
  69 \fBcurs_outopts\fR(3CURSES), \fBcurses\fR(3CURSES), \fBattributes\fR(5)
  70 .SH NOTES
  71 .sp
  72 .LP
  73 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
  74 and <\fBunctrl.h\fR>.
  75 .sp
  76 .LP
  77 Note that \fBscrl()\fR and \fBscroll()\fR may be macros.