-'\" t
.\"***************************************************************************
-.\" Copyright 2018-2021,2022 Thomas E. Dickey *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey *
.\" Copyright 1998-2007,2010 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: form_hook.3x,v 1.19 2022/02/12 20:03:40 tom Exp $
-.TH form_hook 3X ""
+.\" $Id: form_hook.3x,v 1.29 2023/10/07 21:19:07 tom Exp $
+.TH form_hook 3X 2023-10-07 "ncurses 6.4" "Library calls"
.SH NAME
-\fBform_hook\fP \- set hooks for automatic invocation by applications
+\fBform_hook\fP \-
+set hooks for automatic invocation by applications
.SH SYNOPSIS
-\fB#include <form.h>\fP
-.sp
-\fBint set_field_init(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR
-.br
-\fBForm_Hook field_init(const FORM *\fIform\fB);\fR
-.sp
-\fBint set_field_term(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR
-.br
-\fBForm_Hook field_term(const FORM *\fIform\fB);\fR
-.sp
-\fBint set_form_init(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR
-.br
-\fBForm_Hook form_init(const FORM *\fIform\fB);\fR
-.sp
-\fBint set_form_term(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR
-.br
-\fBForm_Hook form_term(const FORM *\fIform\fB);\fR
-.br
+.nf
+\fB#include <form.h>
+.PP
+\fBint set_field_init(FORM *\fIform\fP, Form_Hook \fIfunc\fP);
+\fBForm_Hook field_init(const FORM *\fIform\fP);
+.PP
+\fBint set_field_term(FORM *\fIform\fP, Form_Hook \fIfunc\fP);
+\fBForm_Hook field_term(const FORM *\fIform\fP);
+.PP
+\fBint set_form_init(FORM *\fIform\fP, Form_Hook \fIfunc\fP);
+\fBForm_Hook form_init(const FORM *\fIform\fP);
+.PP
+\fBint set_form_term(FORM *\fIform\fP, Form_Hook \fIfunc\fP);
+\fBForm_Hook form_term(const FORM *\fIform\fP);
+.fi
.SH DESCRIPTION
These functions make it possible to set hook functions to be called at various
points in the automatic processing of input event codes by \fBform_driver\fP.
-.PP
-The function \fBset_field_init\fP sets a hook to be called at form-post time
+.SS set_field_init\fP
+sets a hook to be called at form-post time
and each time the selected field changes (after the change).
-\fBfield_init\fP
+.SS field_init
returns the current field init hook, if any (\fBNULL\fP if there is no such
hook).
-.PP
-The function \fBset_field_term\fP sets a hook to be called at form-unpost time
+.SS set_field_term
+sets a hook to be called at form-unpost time
and each time the selected field changes (before the change).
-\fBfield_term\fP
+.SS field_term
returns the current field term hook, if any (\fBNULL\fP if there is no such
hook).
-.PP
-The function \fBset_form_init\fP sets a hook to be called at form-post time and
+.SS set_form_init
+sets a hook to be called at form-post time and
just after a page change once it is posted.
-\fBform_init\fP returns the
-current form init hook, if any (\fBNULL\fP if there is no such hook).
-.PP
-The function \fBset_form_term\fP sets a hook to be called at form-unpost time
+.SS form_init
+returns the current form init hook,
+if any (\fBNULL\fP if there is no such hook).
+.SS set_form_term
+sets a hook to be called at form-unpost time
and just before a page change once it is posted.
-\fBform_init\fP
+.SS form_init
returns the current form term hook, if any (\fBNULL\fP if there is no such
hook).
.SH RETURN VALUE
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fP(3)).
-.SH SEE ALSO
-\fBcurses\fP(3X), \fBform\fP(3X).
.SH NOTES
The header file \fB<form.h>\fP automatically includes the header file
\fB<curses.h>\fP.
.SH AUTHORS
Juergen Pfeifer.
Manual pages and adaptation for new curses by Eric S. Raymond.
+.SH SEE ALSO
+\fB\%curses\fP(3X),
+\fB\%form\fP(3X)