ncurses 4.2
[ncurses.git] / Ada95 / html / man / form_opts.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4        <STRONG>form_opts</STRONG> - set and get form options
5
6
7 </PRE>
8 <H2>SYNOPSIS</H2><PRE>
9        <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
10        int set_form_opts(FORM *form, OPTIONS opts);
11        int form_opts_on(FORM *form, OPTIONS opts);
12        int form_opts_off(FORM *form, OPTIONS opts);
13        OPTIONS form_opts(const FORM *form);
14
15
16 </PRE>
17 <H2>DESCRIPTION</H2><PRE>
18        The  function  <STRONG>set_form_opts</STRONG>  sets  all  the  given form's
19        option bits  (form  option  bits  may  be  logically-OR'ed
20        together).
21
22        The  function <STRONG>form_opts_on</STRONG> turns on the given option bits,
23        and leaves others alone.
24
25        The function <STRONG>form_opts_off</STRONG>  turns  off  the  given  option
26        bits, and leaves others alone.
27
28        The  function  <STRONG>form_opts</STRONG> returns the form's current option
29        bits.
30
31        The following options are defined (all are on by default):
32
33        O_NL_OVERLOAD
34             Overload  the  <STRONG>REQ_NEW_LINE</STRONG>  forms  driver request so
35             that calling it at the end of a  field  goes  to  the
36             next field.
37
38        O_BS_OVERLOAD
39             Overload  the  <STRONG>REQ_DEL_PREV</STRONG>  forms  driver request so
40             that calling it at the beginning of a field  goes  to
41             the previous field.
42
43
44 </PRE>
45 <H2>RETURN VALUE</H2><PRE>
46        Except for <STRONG>form_opts</STRONG>, each routine returns one of the fol-
47        lowing:
48
49        <STRONG>E_OK</STRONG> The routine succeeded.
50
51        <STRONG>E_SYSTEM_ERROR</STRONG>
52             System error occurred (see <STRONG>errno</STRONG>).
53
54
55 </PRE>
56 <H2>SEE ALSO</H2><PRE>
57        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
58
59
60 </PRE>
61 <H2>NOTES</H2><PRE>
62        The header file <STRONG><form.h></STRONG> automatically includes the header
63        file <STRONG><curses.h></STRONG>.
64
65
66 </PRE>
67 <H2>PORTABILITY</H2><PRE>
68
69
70 </PRE>
71 <H2>AUTHORS</H2><PRE>
72        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
73        curses by Eric S. Raymond.
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122 </PRE>
123 </BODY>
124 </HTML>