summaryrefslogtreecommitdiff
path: root/lib/libform/form_data.3
diff options
context:
space:
mode:
authorblymn <blymn@NetBSD.org>2001-07-08 12:10:28 +0000
committerblymn <blymn@NetBSD.org>2001-07-08 12:10:28 +0000
commite1a3174b3e59997eb4c8c75f0cd41bbd1ba59c5c (patch)
tree1e3104320cb7087609d9b47bf3c85b4f12c5a9c2 /lib/libform/form_data.3
parentb0b7628145e18d4421eaa259925eae5b408cfd6e (diff)
Add man pages for libform.
Diffstat (limited to 'lib/libform/form_data.3')
-rw-r--r--lib/libform/form_data.367
1 files changed, 67 insertions, 0 deletions
diff --git a/lib/libform/form_data.3 b/lib/libform/form_data.3
new file mode 100644
index 00000000000..9cb2199dd63
--- /dev/null
+++ b/lib/libform/form_data.3
@@ -0,0 +1,67 @@
+.\" $NetBSD: form_data.3,v 1.1 2001/07/08 12:10:28 blymn Exp $
+.\"
+.\" Copyright (c) 2001
+.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
+.\"
+.\" This code is donated to The NetBSD Foundation by the author.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\" 3. The name of the Author may not be used to endorse or promote
+.\" products derived from this software without specific prior written
+.\" permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd January, 2001
+.Dt FORM_DATA 3
+.Os
+.Sh NAME
+.Nm form
+.Nd form library
+.Sh LIBRARY
+.Lb libform
+.Sh SYNOPSIS
+.Fd #include <form.h>
+.Ft int
+.Fn data_ahead "FORM *form"
+.Ft int
+.Fn data_behind "FORM *form"
+.Sh DESCRIPTION
+If there is data offscreen to the right of the current field of the
+given form then
+.Fn data_ahead
+will return TRUE, otherwise FALSE is returned. Similarly, if there is
+data offscreen to the left of the current field of the given form then
+.Fn data_behind
+will return TRUE.
+.Sh RETURN VALUES
+If the condition is met then the functions will return TRUE, if there
+is an error or there is no data offscreen the functions will return
+FALSE.
+.Sh SEE ALSO
+.Xr curses 3 ,
+.Xr forms 3
+.Sh NOTES
+The header
+.Pa <form.h>
+automatically includes both
+.Pa <curses.h>
+and
+.Pa <eti.h> .