t
***************************************************************************
Copyright 2018-2019,2020 Thomas E. Dickey *
Copyright 1998-2010,2015 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_opts.3x,v 1.15 2020/02/02 23:34:34 tom Exp $
set_form_opts, form_opts_on, form_opts_off, form_opts - set and get form options #include <form.h>

int set_form_opts(FORM *form, Field_Options opts);

int form_opts_on(FORM *form, Field_Options opts);

int form_opts_off(FORM *form, Field_Options opts);

Field_Options form_opts(const FORM *form);

The function set_form_opts sets all the given form's option bits (form option bits may be logically-OR'ed together).

The function form_opts_on turns on the given option bits, and leaves others alone.

The function form_opts_off turns off the given option bits, and leaves others alone.

The function form_opts returns the form's current option bits.

The following options are defined (all are on by default):

5 O_NL_OVERLOAD Overload the REQ_NEW_LINE forms driver request so that calling it at the end of a field goes to the next field.

5 O_BS_OVERLOAD Overload the REQ_DEL_PREV forms driver request so that calling it at the beginning of a field goes to the previous field.

Except for form_opts, each routine returns one of the following:

5 E_OK The routine succeeded.

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. Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.