1*a0e6850fSThomas Cort.\" $NetBSD: form_field.3,v 1.12 2012/10/08 18:15:09 njoly Exp $ 2*a0e6850fSThomas Cort.\" 3*a0e6850fSThomas Cort.\" Copyright (c) 2001 4*a0e6850fSThomas Cort.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5*a0e6850fSThomas Cort.\" 6*a0e6850fSThomas Cort.\" This code is donated to The NetBSD Foundation by the author. 7*a0e6850fSThomas Cort.\" 8*a0e6850fSThomas Cort.\" Redistribution and use in source and binary forms, with or without 9*a0e6850fSThomas Cort.\" modification, are permitted provided that the following conditions 10*a0e6850fSThomas Cort.\" are met: 11*a0e6850fSThomas Cort.\" 1. Redistributions of source code must retain the above copyright 12*a0e6850fSThomas Cort.\" notice, this list of conditions and the following disclaimer. 13*a0e6850fSThomas Cort.\" 2. Redistributions in binary form must reproduce the above copyright 14*a0e6850fSThomas Cort.\" notice, this list of conditions and the following disclaimer in the 15*a0e6850fSThomas Cort.\" documentation and/or other materials provided with the distribution. 16*a0e6850fSThomas Cort.\" 3. The name of the Author may not be used to endorse or promote 17*a0e6850fSThomas Cort.\" products derived from this software without specific prior written 18*a0e6850fSThomas Cort.\" permission. 19*a0e6850fSThomas Cort.\" 20*a0e6850fSThomas Cort.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21*a0e6850fSThomas Cort.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22*a0e6850fSThomas Cort.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23*a0e6850fSThomas Cort.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24*a0e6850fSThomas Cort.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25*a0e6850fSThomas Cort.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26*a0e6850fSThomas Cort.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27*a0e6850fSThomas Cort.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28*a0e6850fSThomas Cort.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29*a0e6850fSThomas Cort.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30*a0e6850fSThomas Cort.\" SUCH DAMAGE. 31*a0e6850fSThomas Cort.\" 32*a0e6850fSThomas Cort.Dd January 1, 2001 33*a0e6850fSThomas Cort.Dt FORMS 3 34*a0e6850fSThomas Cort.Os 35*a0e6850fSThomas Cort.Sh NAME 36*a0e6850fSThomas Cort.Nm field_count , 37*a0e6850fSThomas Cort.Nm form_fields , 38*a0e6850fSThomas Cort.Nm move_field , 39*a0e6850fSThomas Cort.Nm set_form_fields 40*a0e6850fSThomas Cort.Nd form library 41*a0e6850fSThomas Cort.Sh LIBRARY 42*a0e6850fSThomas Cort.Lb libform 43*a0e6850fSThomas Cort.Sh SYNOPSIS 44*a0e6850fSThomas Cort.In form.h 45*a0e6850fSThomas Cort.Ft int 46*a0e6850fSThomas Cort.Fn field_count "FORM *form" 47*a0e6850fSThomas Cort.Ft FIELD ** 48*a0e6850fSThomas Cort.Fn form_fields "FORM *form" 49*a0e6850fSThomas Cort.Ft int 50*a0e6850fSThomas Cort.Fn move_field "FIELD *field" "int frow" "int fcol" 51*a0e6850fSThomas Cort.Ft int 52*a0e6850fSThomas Cort.Fn set_form_fields "FORM *form" "FIELD **fields" 53*a0e6850fSThomas Cort.Sh DESCRIPTION 54*a0e6850fSThomas CortThe 55*a0e6850fSThomas Cort.Fn field_count 56*a0e6850fSThomas Cortfunction returns the number of fields that are attached to the given 57*a0e6850fSThomas Cortform, if the form argument passed is 58*a0e6850fSThomas Cort.Dv NULL 59*a0e6850fSThomas Cortthen 60*a0e6850fSThomas Cort.Fn field_count 61*a0e6850fSThomas Cortwill return \-1. 62*a0e6850fSThomas CortThe function 63*a0e6850fSThomas Cort.Fn form_fields 64*a0e6850fSThomas Cortwill return a pointer to array of attach fields for the given form, 65*a0e6850fSThomas Cortthis array is not 66*a0e6850fSThomas Cort.Dv NULL 67*a0e6850fSThomas Cortterminated, fields may be attached to the given 68*a0e6850fSThomas Cortform by calling 69*a0e6850fSThomas Cort.Fn set_form_fields . 70*a0e6850fSThomas CortThe 71*a0e6850fSThomas Cort.Fa fields 72*a0e6850fSThomas Cortargument in this function is a pointer to a 73*a0e6850fSThomas Cort.Dv NULL 74*a0e6850fSThomas Cortterminated array of 75*a0e6850fSThomas Cortfields that will be attached to the form. 76*a0e6850fSThomas CortIf there are already fields attached to the form then they will be 77*a0e6850fSThomas Cortdetached before the new fields are attached. 78*a0e6850fSThomas CortThe new fields given must not be attached to any other form. 79*a0e6850fSThomas CortThe 80*a0e6850fSThomas Cort.Fn move_field 81*a0e6850fSThomas Cortfunction will move the given field to the location specified by 82*a0e6850fSThomas Cort.Fa frow 83*a0e6850fSThomas Cortand 84*a0e6850fSThomas Cort.Fa fcol . 85*a0e6850fSThomas Cort.Sh RETURN VALUES 86*a0e6850fSThomas CortFunctions returning pointers will return 87*a0e6850fSThomas Cort.Dv NULL 88*a0e6850fSThomas Cortif an error is detected. 89*a0e6850fSThomas CortThe functions that return an int will return one of the following error 90*a0e6850fSThomas Cortvalues: 91*a0e6850fSThomas Cort.Pp 92*a0e6850fSThomas Cort.Bl -tag -width E_UNKNOWN_COMMAND -compact 93*a0e6850fSThomas Cort.It Er E_OK 94*a0e6850fSThomas CortThe function was successful. 95*a0e6850fSThomas Cort.It Er E_CONNECTED 96*a0e6850fSThomas CortThe field is connected to a form. 97*a0e6850fSThomas Cort.It Er E_POSTED 98*a0e6850fSThomas CortThe form is currently posted to the screen. 99*a0e6850fSThomas Cort.It Er E_BAD_ARGUMENT 100*a0e6850fSThomas CortThe function was passed a bad argument. 101*a0e6850fSThomas Cort.El 102*a0e6850fSThomas Cort.Sh SEE ALSO 103*a0e6850fSThomas Cort.Xr curses 3 , 104*a0e6850fSThomas Cort.Xr forms 3 105*a0e6850fSThomas Cort.Sh NOTES 106*a0e6850fSThomas CortThe header 107*a0e6850fSThomas Cort.In form.h 108*a0e6850fSThomas Cortautomatically includes both 109*a0e6850fSThomas Cort.In curses.h 110*a0e6850fSThomas Cortand 111*a0e6850fSThomas Cort.In eti.h . 112