man/form_field.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
   4 .\" Copyright 1998-2010,2012 Free Software Foundation, Inc.                  *
   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 .\"
  31 .\" $Id: form_field.3x,v 1.15 2020/03/28 19:06:28 tom Exp $
  32 .TH form_field 3X ""
  33 .SH NAME
  34 \fBform_field\fR \- make and break connections between fields and forms
  35 .SH SYNOPSIS
  36 \fB#include <form.h>\fR
  37 .br
  38 int set_form_fields(FORM *form, FIELD **fields);
  39 .br
  40 FIELD **form_fields(const FORM *form);
  41 .br
  42 int field_count(const FORM *form);
  43 .br
  44 int move_field(FIELD *field, int frow, int fcol);
  45 .br
  46 .SH DESCRIPTION
  47 The function \fBset_form_fields\fR changes the field pointer array of
  48 the given \fIform\fR.  The array must be terminated by a \fBNULL\fR.
  49 .PP
  50 The function \fBform_fields\fR returns the field array of the given form.
  51 .PP
  52 The function \fBfield_count\fR returns the count of fields in \fIform\fR.
  53 .PP
  54 The function \fBmove_field\fR moves the given field (which must be disconnected)
  55 to a specified location on the screen.
  56 .SH RETURN VALUE
  57 The function \fBform_fields\fR returns a pointer (which may be \fBNULL\fR).
  58 It does not set \fBerrno\fP.
  59 .PP
  60 The function \fBfield_count\fR returns \fBERR\fR if the \fIform\fP parameter
  61 is \fBNULL\fP.
  62 .PP
  63 The functions \fBset_form_fields\fR and \fBmove_field\fR return one of
  64 the following codes on error:
  65 .TP 5
  66 .B E_OK
  67 The routine succeeded.
  68 .TP 5
  69 .B E_BAD_ARGUMENT
  70 Routine detected an incorrect or out-of-range argument.
  71 .TP 5
  72 .B E_CONNECTED
  73 The field is already connected to a form.
  74 .TP 5
  75 .B E_POSTED
  76 The form is already posted.
  77 .TP 5
  78 .B E_SYSTEM_ERROR
  79 System error occurred (see \fBerrno\fR(3)).
  80 .SH SEE ALSO
  81 \fBcurses\fR(3X), \fBform\fR(3X).
  82 .SH NOTES
  83 The header file \fB<form.h>\fR automatically includes the header file
  84 \fB<curses.h>\fR.
  85 .SH PORTABILITY
  86 These routines emulate the System V forms library.
  87 They were not supported on
  88 Version 7 or BSD versions.
  89 .PP
  90 The SVr4 forms library documentation specifies the \fBfield_count\fR error value
  91 as \-1 (which is the value of \fBERR\fR).
  92 .SH AUTHORS
  93 Juergen Pfeifer.
  94 Manual pages and adaptation for new curses by Eric S. Raymond.