usr/src/man/man3xcurses/scrl.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SCRL 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 scrl, scroll, wscrl \- scroll a window
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBscrl\fR(\fBint\fR \fIn\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBscroll\fR(\fBWINDOW *\fR\fIwin\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBint\fR \fBwscrl\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIn\fR);
  30 .fi
  31
  32 .SH PARAMETERS
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIn\fR\fR
  37 .ad
  38 .RS 7n
  39 number and direction of lines to scroll
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIwin\fR\fR
  46 .ad
  47 .RS 7n
  48 pointer to the window in which to scroll
  49 .RE
  50
  51 .SH DESCRIPTION
  52 .sp
  53 .LP
  54 The \fBscroll()\fR function scrolls the window \fIwin\fR up one line.  The
  55 current cursor position is not changed.
  56 .sp
  57 .LP
  58 The \fBscrl()\fR and \fBwscrl()\fR functions scroll the window \fBstdscr\fR or
  59 \fIwin\fR up or down \fIn\fR lines, where \fIn\fR is a positive (scroll up) or
  60 negative (scroll down) integer.
  61 .sp
  62 .LP
  63 The \fBscrollok\fR(3XCURSES) function must be enabled for these functions to
  64 work.
  65 .SH RETURN VALUES
  66 .sp
  67 .LP
  68 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  69 .SH ERRORS
  70 .sp
  71 .LP
  72 None.
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for descriptions of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 Interface Stability     Standard
  87 _
  88 MT-Level        Unsafe
  89 .TE
  90
  91 .SH SEE ALSO
  92 .sp
  93 .LP
  94 \fBclearok\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
  95 \fBstandards\fR(5)