form_opts(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | NOTES | PORTABILITY | AUTHORS | COLOPHON

form_opts(3X)                                              form_opts(3X)

NAME         top

       set_form_opts, form_opts_on, form_opts_off, form_opts - set and
       get form options

SYNOPSIS         top

       #include <form.h>

       int set_form_opts(FORM *form, Field_Options opts);
       Field_Options form_opts(const FORM *form);

       int form_opts_on(FORM *form, Field_Options opts);
       int form_opts_off(FORM *form, Field_Options opts);

DESCRIPTION         top

       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):

       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.

       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.

RETURN VALUE         top

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

       E_OK The routine succeeded.

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

SEE ALSO         top

       curses(3X), form(3X).

NOTES         top

       The header file <form.h> automatically includes the header file
       <curses.h>.

PORTABILITY         top

       These routines emulate the System V forms library.  They were not
       supported on Version 7 or BSD versions.

AUTHORS         top

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

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have
       a bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2021-04-01.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2021-03-28.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                                           form_opts(3X)