man/form_field.3x

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