1.\" $NetBSD: form_field_opts.3,v 1.4 2002/02/20 11:30:58 wiz 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 field_opts , 37.Nm field_opts_off , 38.Nm field_opts_on , 39.Nm set_field_opts 40.Nd form library 41.Sh LIBRARY 42.Lb libform 43.Sh SYNOPSIS 44.Fd #include \*[Lt]form.h\*[Gt] 45.Ft Form_Options 46.Fn field_opts "FIELD *field" 47.Ft int 48.Fn field_opts_off "FIELD *field, Form_Options options" 49.Ft int 50.Fn field_opts_on "FIELD *field, Form_Options options" 51.Ft int 52.Fn set_field_opts "FIELD *field, Form_Options options" 53.Sh DESCRIPTION 54The function 55.Fn field_opts 56returns the current options settings for the given field. The 57.Fn field_opts_off 58will turn the options given in 59.Fa options 60off for the given field, options not specified in 61.Fa options 62will remain unchanged. Conversely, the function 63.Fn field_opts_on 64will turn on the options given in 65.Fa options 66for the specified field, again, any options not specified will remain 67unchanged. The options for a field may be set to a specific set of 68options by calling the 69.Fn set_field_opts 70function. Options may only be changed if the field given is not the 71currently active one. 72.Sh PARAMETERS 73The following options are available for a field: 74.Pp 75.Bl -tag -width O_AUTOSKIP -compact 76.It O_VISIBLE 77The field is visible, hence is displayed when the form is posted. 78.It O_ACTIVE 79The field is active in the form, meaning that it can be visited during 80form processing. 81.It O_PUBLIC 82The contents of the field are echoed to the screen. 83.It O_EDIT 84The contents of the field can be modified 85.It O_WRAP 86The contents of the field are wrapped on a word boundary, if this 87option is off then the field will be wrapped on a character boundary. 88.It O_BLANK 89Blank the field on new data being entered if and only if the field 90cursor is at the left hand side of the field. 91.It O_AUTOSKIP 92Skip to the next field when the current field reaches it's maximum 93size. 94.It O_NULLOK 95The field is allowed to contain no data 96.It O_STATIC 97The field is not dynamic, it has a fixed size. 98.It O_PASSOK 99An unmodified field is allowed. 100.El 101.Pp 102The following options are on by default for a field: O_VISIBLE, 103O_ACTIVE, O_PUBLIC, O_EDIT, O_WRAP, O_BLANK, O_AUTOSKIP, O_NULLOK, 104O_PASSOK and O_STATIC. 105.Sh RETURN VALUES 106Functions returning pointers will return NULL if an error is detected. 107The functions that return an int will return one of the following error 108values: 109.Pp 110.Bl -tag -width E_UNKNOWN_COMMAND -compact 111.It Er E_OK 112The function was successful. 113.It Er E_CURRENT 114The field specified is the currently active one in the form. 115.El 116.Sh SEE ALSO 117.Xr curses 3 , 118.Xr forms 3 119.Sh NOTES 120The header 121.Pa \*[Lt]form.h\*[Gt] 122automatically includes both 123.Pa \*[Lt]curses.h\*[Gt] 124and 125.Pa \*[Lt]eti.h\*[Gt] . 126