ncurses 5.0
[ncurses.git] / Ada95 / html / man / form_hook.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4        <STRONG>form_hook</STRONG> - set hooks for automatic invocation by applica-
5        tions
6
7
8 </PRE>
9 <H2>SYNOPSIS</H2><PRE>
10        <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
11        int set_field_init(FORM *form, void (*func)(FORM *));
12        void (*)(FORM *) field_init(const FORM *form);
13        int set_field_term(FORM *form, void (*func)(FORM *));
14        void (*)(FORM *) field_term(const FORM *form);
15        int set_form_init(FORM *form, void (*func)(FORM *));
16        void (*)(FORM *) form_init(const FORM *form);
17        int set_form_term(FORM *form, void (*func)(FORM *));
18        void (*)(FORM *) form_term(const FORM *form);
19
20
21 </PRE>
22 <H2>DESCRIPTION</H2><PRE>
23        These functions make it possible to set hook functions  to
24        be called at various points in the automatic processing of
25        input event codes by <STRONG>form_driver</STRONG>.
26
27        The function <STRONG>set_field_init</STRONG> sets a hook to  be  called  at
28        form-post  time  and  each time the selected field changes
29        (after the change).  <STRONG>field_init</STRONG> returns the current  field
30        init hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
31
32        The  function  <STRONG>set_field_term</STRONG>  sets a hook to be called at
33        form-unpost time and each time the selected field  changes
34        (before the change).  <STRONG>field_term</STRONG> returns the current field
35        term hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
36
37        The function <STRONG>set_form_init</STRONG> sets a hook  to  be  called  at
38        form-post  time  and  just  after a page change once it is
39        posted.  <STRONG>form_init</STRONG> returns the current form init hook,  if
40        any (<STRONG>NULL</STRONG> if there is no such hook).
41
42        The  function  <STRONG>set_form_term</STRONG>  sets  a hook to be called at
43        form-unpost time and just before a page change once it  is
44        posted.   <STRONG>form_init</STRONG> returns the current form term hook, if
45        any (<STRONG>NULL</STRONG> if there is no such hook).
46
47
48 </PRE>
49 <H2>RETURN VALUE</H2><PRE>
50        Routines that return pointers return <STRONG>NULL</STRONG> on error.  Other
51        routines return one of the following:
52
53        <STRONG>E_OK</STRONG> The routine succeeded.
54
55        <STRONG>E_SYSTEM_ERROR</STRONG>
56             System error occurred (see <STRONG>errno</STRONG>).
57
58
59 </PRE>
60 <H2>SEE ALSO</H2><PRE>
61        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
62
63
64 </PRE>
65 <H2>NOTES</H2><PRE>
66
67
68 </PRE>
69 <H2>PORTABILITY</H2><PRE>
70        These routines emulate the System V forms  library.   They
71        were not supported on Version 7 or BSD versions.
72
73
74 </PRE>
75 <H2>AUTHORS</H2><PRE>
76        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
77        curses by Eric S. Raymond.
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>