usr/src/man/man3curses/form_data.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 FORM_DATA 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_data, data_ahead, data_behind \- tell if forms field has off-screen data
  10 ahead or behind
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lform\fR  \fB -lcurses \fR [ \fIlibrary\fR .. ]
  15 #include <form.h>
  16
  17
  18
  19 \fBint\fR \fBdata_ahead\fR(\fBFORM *\fR\fIform\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBdata_behind\fR(\fBFORM *\fR\fIform\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 \fBdata_ahead()\fR returns \fBTRUE\fR (1) if the current field has more
  31 off-screen data ahead; otherwise it returns \fBFALSE\fR (0).
  32 .sp
  33 .LP
  34 \fBdata_behind()\fR returns \fBTRUE\fR (1) if the current field has more
  35 off-screen data behind; otherwise it returns \fBFALSE\fR (0).
  36 .SH ATTRIBUTES
  37 .sp
  38 .LP
  39 See \fBattributes\fR(5) for descriptions of the following attributes:
  40 .sp
  41
  42 .sp
  43 .TS
  44 box;
  45 c | c
  46 l | l .
  47 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  48 _
  49 MT-Level        Unsafe
  50 .TE
  51
  52 .SH SEE ALSO
  53 .sp
  54 .LP
  55 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
  56 .SH NOTES
  57 .sp
  58 .LP
  59 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
  60 \fB<curses.h>\fR\&.