1form_field_opts(3X)                                        form_field_opts(3X)
2
3
4

NAME

6       form_field_opts - set and get field options
7

SYNOPSIS

9       #include <form.h>
10       int set_field_opts(FIELD *field, Field_Options opts);
11       int field_opts_on(FIELD *field, Field_Options opts);
12       int field_opts_off(FIELD *field, Field_Options opts);
13       Field_Options field_opts(const FIELD *field);
14

DESCRIPTION

16       The  function  set_field_opts  sets  all  the given field's option bits
17       (field option bits may be logically-OR'ed together).
18
19       The function field_opts_on turns on the given option bits,  and  leaves
20       others alone.
21
22       The function field_opts_off turns off the given option bits, and leaves
23       others alone.
24
25       The function field_opts returns the field's current option bits.
26
27       The following options are defined (all are on by default):
28
29       O_VISIBLE
30            The field is displayed.  If this option is  off,  display  of  the
31            field is suppressed.
32
33       O_ACTIVE
34            The  field  is  visited during processing.  If this option is off,
35            the field will not be reachable by navigation keys. Please  notice
36            that an invisible field appears to be inactive also.
37
38       O_PUBLIC
39            The field contents are displayed as data is entered.
40
41       O_EDIT
42            The field can be edited.
43
44       O_WRAP
45            Words  that  do  not  fit  on a line are wrapped to the next line.
46            Words are blank-separated.
47
48       O_BLANK
49            The field is cleared whenever a character is entered at the  first
50            position.
51
52       O_AUTOSKIP
53            Skip to the next field when this one fills.
54
55       O_NULLOK
56            Allow a blank field.
57
58       O_STATIC
59            Field  buffers  are  fixed  to  field's  original size.  Turn this
60            option off to create a dynamic field.
61
62       O_PASSOK
63            Validate field only if modified by user.
64

RETURN VALUE

66       Except for field_opts, each routine returns one of the following:
67
68       E_OK The routine succeeded.
69
70       E_BAD_ARGUMENT
71            Routine detected an incorrect or out-of-range argument.
72
73       E_CURRENT
74            The field is the current field.
75
76       E_SYSTEM_ERROR
77            System error occurred (see errno).
78

SEE ALSO

80       curses(3X), form(3X).
81
82
83       NOTES  The header file <form.h> automatically includes the header  file
84              <curses.h>.
85

PORTABILITY

87       These  routines emulate the System V forms library.  They were not sup‐
88       ported on Version 7 or BSD versions.
89

AUTHORS

91       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
92       Raymond.
93
94
95
96                                                           form_field_opts(3X)
Impressum