ncurses 6.2 - patch 20210213
[ncurses.git] / man / form_hook.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2007,2010 Free Software Foundation, Inc.                  *
5 .\"                                                                          *
6 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
7 .\" copy of this software and associated documentation files (the            *
8 .\" "Software"), to deal in the Software without restriction, including      *
9 .\" without limitation the rights to use, copy, modify, merge, publish,      *
10 .\" distribute, distribute with modifications, sublicense, and/or sell       *
11 .\" copies of the Software, and to permit persons to whom the Software is    *
12 .\" furnished to do so, subject to the following conditions:                 *
13 .\"                                                                          *
14 .\" The above copyright notice and this permission notice shall be included  *
15 .\" in all copies or substantial portions of the Software.                   *
16 .\"                                                                          *
17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24 .\"                                                                          *
25 .\" Except as contained in this notice, the name(s) of the above copyright   *
26 .\" holders shall not be used in advertising or otherwise to promote the     *
27 .\" sale, use or other dealings in this Software without prior written       *
28 .\" authorization.                                                           *
29 .\"***************************************************************************
30 .\"
31 .\" $Id: form_hook.3x,v 1.16 2020/10/18 00:06:29 tom Exp $
32 .TH form_hook 3X ""
33 .SH NAME
34 \fBform_hook\fR \- set hooks for automatic invocation by applications
35 .SH SYNOPSIS
36 \fB#include <form.h>\fR
37 .sp
38 \fBint set_field_init(FORM *\fP\fIform\fP\fB, Form_Hook \fP\fIfunc\fP\fB);\fP
39 .br
40 \fBForm_Hook field_init(const FORM *\fP\fIform\fP\fB);\fP
41 .sp
42 \fBint set_field_term(FORM *\fP\fIform\fP\fB, Form_Hook \fP\fIfunc\fP\fB);\fP
43 .br
44 \fBForm_Hook field_term(const FORM *\fP\fIform\fP\fB);\fP
45 .sp
46 \fBint set_form_init(FORM *\fP\fIform\fP\fB, Form_Hook \fP\fIfunc\fP\fB);\fP
47 .br
48 \fBForm_Hook form_init(const FORM *\fP\fIform\fP\fB);\fP
49 .sp
50 \fBint set_form_term(FORM *\fP\fIform\fP\fB, Form_Hook \fP\fIfunc\fP\fB);\fP
51 .br
52 \fBForm_Hook form_term(const FORM *\fP\fIform\fP\fB);\fP
53 .br
54 .SH DESCRIPTION
55 These functions make it possible to set hook functions to be called at various
56 points in the automatic processing of input event codes by \fBform_driver\fR.
57 .PP
58 The function \fBset_field_init\fR sets a hook to be called at form-post time
59 and each time the selected field changes (after the change).
60 \fBfield_init\fR
61 returns the current field init hook, if any (\fBNULL\fR if there is no such
62 hook).
63 .PP
64 The function \fBset_field_term\fR sets a hook to be called at form-unpost time
65 and each time the selected field changes (before the change).
66 \fBfield_term\fR
67 returns the current field term hook, if any (\fBNULL\fR if there is no such
68 hook).
69 .PP
70 The function \fBset_form_init\fR sets a hook to be called at form-post time and
71 just after a page change once it is posted.
72 \fBform_init\fR returns the
73 current form init hook, if any (\fBNULL\fR if there is no such hook).
74 .PP
75 The function \fBset_form_term\fR sets a hook to be called at form-unpost time
76 and just before a page change once it is posted.
77 \fBform_init\fR
78 returns the current form term hook, if any (\fBNULL\fR if there is no such
79 hook).
80 .SH RETURN VALUE
81 Routines that return pointers return \fBNULL\fR on error.
82 Other routines
83 return one of the following:
84 .TP 5
85 .B E_OK
86 The routine succeeded.
87 .TP 5
88 .B E_SYSTEM_ERROR
89 System error occurred (see \fBerrno\fR(3)).
90 .SH SEE ALSO
91 \fBcurses\fR(3X), \fBform\fR(3X).
92 .SH NOTES
93 The header file \fB<form.h>\fR automatically includes the header file
94 \fB<curses.h>\fR.
95 .SH PORTABILITY
96 These routines emulate the System V forms library.
97 They were not supported on
98 Version 7 or BSD versions.
99 .SH AUTHORS
100 Juergen Pfeifer.
101 Manual pages and adaptation for new curses by Eric S. Raymond.