lib/libform/form_data.3

   1 .\"     $NetBSD: form_data.3,v 1.9 2010/03/22 21:58:31 joerg 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 form
  37 .Nd form library
  38 .Sh LIBRARY
  39 .Lb libform
  40 .Sh SYNOPSIS
  41 .In form.h
  42 .Ft int
  43 .Fn data_ahead "FORM *form"
  44 .Ft int
  45 .Fn data_behind "FORM *form"
  46 .Sh DESCRIPTION
  47 If there is data offscreen to the right of the current field of the
  48 given form then
  49 .Fn data_ahead
  50 will return
  51 .Dv TRUE ,
  52 otherwise
  53 .Dv FALSE
  54 is returned.
  55 Similarly, if there is
  56 data offscreen to the left of the current field of the given form then
  57 .Fn data_behind
  58 will return
  59 .Dv TRUE .
  60 .Sh RETURN VALUES
  61 If the condition is met then the functions will return
  62 .Dv TRUE ,
  63 if there
  64 is an error or there is no data offscreen the functions will return
  65 .Dv FALSE .
  66 .Sh SEE ALSO
  67 .Xr curses 3 ,
  68 .Xr forms 3
  69 .Sh NOTES
  70 The header
  71 .In form.h
  72 automatically includes both
  73 .In curses.h
  74 and
  75 .In eti.h .