xref: /netbsd/lib/libform/form_data.3 (revision 673ddee3)
1.\"	$NetBSD: form_data.3,v 1.10 2017/10/23 15:23:55 abhinav Exp $
2.\"
3.\" Copyright (c) 2001
4.\"	Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
5.\"
6.\" This code is donated to The NetBSD Foundation by the author.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. The name of the Author may not be used to endorse or promote
17.\"    products derived from this software without specific prior written
18.\"    permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd January 1, 2001
33.Dt FORM_DATA 3
34.Os
35.Sh NAME
36.Nm data_ahead ,
37.Nm data_behind
38.Nd form library
39.Sh LIBRARY
40.Lb libform
41.Sh SYNOPSIS
42.In form.h
43.Ft int
44.Fn data_ahead "FORM *form"
45.Ft int
46.Fn data_behind "FORM *form"
47.Sh DESCRIPTION
48If there is data offscreen to the right of the current field of the
49given form then
50.Fn data_ahead
51will return
52.Dv TRUE ,
53otherwise
54.Dv FALSE
55is returned.
56Similarly, if there is
57data offscreen to the left of the current field of the given form then
58.Fn data_behind
59will return
60.Dv TRUE .
61.Sh RETURN VALUES
62If the condition is met then the functions will return
63.Dv TRUE ,
64if there
65is an error or there is no data offscreen the functions will return
66.Dv FALSE .
67.Sh SEE ALSO
68.Xr curses 3 ,
69.Xr forms 3
70.Sh NOTES
71The header
72.In form.h
73automatically includes both
74.In curses.h
75and
76.In eti.h .
77