opts(3form)

opts3form

Set and get form options

Usage

#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);

Overview

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

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

Portability

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

Releases

18 releases since Debian 1.1 (Buzz); the text changed 13 times.

  1. 1.1–1.3
  2. 2.0
  3. 2.1
  4. 2.2
  5. 3.0
  6. 3.1
  7. 4.0
  8. 5.0–6.0
  9. 7–8
  10. 9
  11. 10
  12. 11
  13. 12
  14. 13

Authors

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

From ncurses-doc 6.5+20250216-2 in Debian 13 (Trixie). Parsed by carta from the page's man source.