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