t
***************************************************************************
Copyright 2018-2019,2020 Thomas E. Dickey *
Copyright 1998-2010,2012 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: form_field.3x,v 1.14 2020/02/02 23:34:34 tom Exp $
form_field - make and break connections between fields and forms #include <form.h>

int set_form_fields(FORM *form, FIELD **fields);

FIELD **form_fields(const FORM *form);

int field_count(const FORM *form);

int move_field(FIELD *field, int frow, int fcol);

The function set_form_fields changes the field pointer array of the given form. The array must be terminated by a NULL.

The function form_fields returns the field array of the given form.

The function field_count returns the count of fields in form.

The function move_field moves the given field (which must be disconnected) to a specified location on the screen.

The function form_fields returns a pointer (which may be NULL). It does not set errno.

The function field_count returns ERR if the form parameter is NULL.

The functions set_form_fields and move_field return one of the following codes on error:

5 E_OK The routine succeeded.

5 E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument.

5 E_CONNECTED The field is already connected to a form.

5 E_POSTED The form is already posted.

5 E_SYSTEM_ERROR System error occurred (see errno(3)).

curses(3X), form(3X). The header file <form.h> automatically includes the header file <curses.h>. These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.

The SVr4 forms library documentation specifies the field_count error value as -1 (which is the value of ERR).

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.