Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / refs/heads/android-16 / . / man / form_data.3x
blob: ded82eba19a28ebb60790195317d2e0e01a95fdf [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1'\" t
2.\"***************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]3.\" Copyright 2018-2023,2024 Thomas E. Dickey *
4.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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.\"
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]31.\" $Id: form_data.3x,v 1.32 2024/03/16 15:35:01 tom Exp $
32.TH form_data 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]33.SH NAME
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]34\fBdata_ahead\fP,
35\fBdata_behind\fP \-
36test for off-screen data in given forms
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]37.SH SYNOPSIS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]38.nf
39\fB#include <form.h>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]40.PP
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]41\fBbool data_ahead(const FORM *\fIform\fP);
42\fBbool data_behind(const FORM *\fIform\fP);
43.fi
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).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52.SH PORTABILITY
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]53These routines emulate the System V forms library.
54They were not supported on
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]55Version 7 or BSD versions.
56.SH AUTHORS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]57Juergen Pfeifer.
58Manual pages and adaptation for new curses by Eric S. Raymond.
59.SH SEE ALSO
60\fB\%curses\fP(3X),
61\fB\%form\fP(3X)