ncurses 6.2 - patch 20210109
[ncurses.git] / man / form_data.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018,2020 Thomas E. Dickey                                     *
4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
5 .\"                                                                          *
6 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
7 .\" copy of this software and associated documentation files (the            *
8 .\" "Software"), to deal in the Software without restriction, including      *
9 .\" without limitation the rights to use, copy, modify, merge, publish,      *
10 .\" distribute, distribute with modifications, sublicense, and/or sell       *
11 .\" copies of the Software, and to permit persons to whom the Software is    *
12 .\" furnished to do so, subject to the following conditions:                 *
13 .\"                                                                          *
14 .\" The above copyright notice and this permission notice shall be included  *
15 .\" in all copies or substantial portions of the Software.                   *
16 .\"                                                                          *
17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24 .\"                                                                          *
25 .\" Except as contained in this notice, the name(s) of the above copyright   *
26 .\" holders shall not be used in advertising or otherwise to promote the     *
27 .\" sale, use or other dealings in this Software without prior written       *
28 .\" authorization.                                                           *
29 .\"***************************************************************************
30 .\"
31 .\" $Id: form_data.3x,v 1.15 2020/10/18 00:15:00 tom Exp $
32 .TH form_data 3X ""
33 .SH NAME
34 \fBdata_ahead\fP,
35 \fBdata_behind\fR \- test for off-screen data in given forms
36 .SH SYNOPSIS
37 \fB#include <form.h>\fR
38 .sp
39 \fBbool data_ahead(const FORM *\fP\fIform\fP\fB);\fP
40 .br
41 \fBbool data_behind(const FORM *\fP\fIform\fP\fB);\fP
42 .br
43 .SH DESCRIPTION
44 The function \fBdata_ahead\fR tests whether there is off-screen data
45 ahead in the given form.
46 It returns TRUE (1) or FALSE (0).
47 .PP
48 The function \fBdata_behind\fR tests whether there is off-screen data
49 behind in the given form.
50 It returns TRUE (1) or FALSE (0).
51 .SH SEE ALSO
52 \fBcurses\fR(3X), \fBform\fR(3X).
53 .SH NOTES
54 The header file \fB<form.h>\fR automatically includes the header file
55 \fB<curses.h>\fR.
56 .SH PORTABILITY
57 These routines emulate the System V forms library.
58 They were not supported on
59 Version 7 or BSD versions.
60 .SH AUTHORS
61 Juergen Pfeifer.
62 Manual pages and adaptation for new curses by Eric S. Raymond.