lib/libform/form_field_info.3

   1 .\"     $NetBSD: form_field_info.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 FORMS 3
  34 .Os
  35 .Sh NAME
  36 .Nm dynamic_field_info ,
  37 .Nm field_info
  38 .Nd form library
  39 .Sh LIBRARY
  40 .Lb libform
  41 .Sh SYNOPSIS
  42 .In form.h
  43 .Ft int
  44 .Fn dynamic_field_info "FIELD *field" "int *drows" "int *dcols" "int *max"
  45 .Ft int
  46 .Fn field_info "FIELD *field" "int *rows" "int *cols" "int *frow" "int *fcol" \
  47 "int *nrow" "int *nbuf"
  48 .Sh DESCRIPTION
  49 The function
  50 .Fn dynamic_field_info
  51 returns the sizing information for the field given.
  52 The function will return the number of rows, columns and the maximum
  53 growth of the field in the storage pointed to by the drows, dcols and max
  54 parameters respectively.
  55 Dynamic field information cannot be requested for the default field.
  56 If the field given is not dynamic then
  57 .Fn dynamic_field_info
  58 will simply return the size of the actual field.
  59 The
  60 .Fn field_info
  61 will return the number or rows, columns, field starting row, field
  62 starting column, number of off screen rows and number of buffers in
  63 .Fa rows ,
  64 .Fa cols ,
  65 .Fa frow ,
  66 .Fa fcol ,
  67 .Fa nrow
  68 and
  69 .Fa nbuf
  70 respectively.
  71 .Sh RETURN VALUES
  72 The functions will return one of the following error values:
  73 .Pp
  74 .Bl -tag -width E_UNKNOWN_COMMAND -compact
  75 .It Er E_OK
  76 The function was successful.
  77 .It Er E_BAD_ARGUMENT
  78 A bad argument was passed to the function.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr curses 3 ,
  82 .Xr forms 3
  83 .Sh NOTES
  84 The header
  85 .In form.h
  86 automatically includes both
  87 .In curses.h
  88 and
  89 .In eti.h .