ncurses 6.4 - patch 20230917

[ncurses.git] / man / form_hook.3x

diff --git a/man/form_hook.3x b/man/form_hook.3x
index 7dfa838e10267cd3fb4d125abad57c189c3396b4..54a0f63286a8dfcd03fe70bc18ef100b1da9136c 100644 (file)
--- a/man/form_hook.3x
+++ b/man/form_hook.3x
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2010,2018 Free Software Foundation, Inc.              *
+.\" 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  *
 .\" copy of this software and associated documentation files (the            *
@@ -27,57 +28,58 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_hook.3x,v 1.12 2018/07/28 21:34:06 tom Exp $
-.TH form_hook 3X ""
+.\" $Id: form_hook.3x,v 1.25 2023/09/16 23:37:03 tom Exp $
+.TH form_hook 3X 2023-09-16 "ncurses 6.4" "Library calls"
 .SH NAME
-\fBform_hook\fR \- set hooks for automatic invocation by applications
+\fBform_hook\fP \-
+set hooks for automatic invocation by applications
 .SH SYNOPSIS
-\fB#include <form.h>\fR
+\fB#include <form.h>\fP
+.sp
+\fBint set_field_init(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR
 .br
-int set_field_init(FORM *form, Form_Hook func);
+\fBForm_Hook field_init(const FORM *\fIform\fB);\fR
+.sp
+\fBint set_field_term(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR
 .br
-Form_Hook field_init(const FORM *form);
+\fBForm_Hook field_term(const FORM *\fIform\fB);\fR
+.sp
+\fBint set_form_init(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR
 .br
-int set_field_term(FORM *form, Form_Hook func);
-.br
-Form_Hook field_term(const FORM *form);
-.br
-int set_form_init(FORM *form, Form_Hook func);
-.br
-Form_Hook form_init(const FORM *form);
-.br
-int set_form_term(FORM *form, Form_Hook func);
-.br
-Form_Hook form_term(const FORM *form);
+\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
 .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\fR.
-.PP
-The function \fBset_field_init\fR sets a hook to be called at form-post time
+points in the automatic processing of input event codes by \fBform_driver\fP.
+.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\fR
-returns the current field init hook, if any (\fBNULL\fR if there is no such
+.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\fR 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\fR
-returns the current field term hook, if any (\fBNULL\fR if there is no such
+.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\fR 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\fR returns the
-current form init hook, if any (\fBNULL\fR if there is no such hook).
-.PP
-The function \fBset_form_term\fR 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\fR
-returns the current form term hook, if any (\fBNULL\fR if there is no such
+.SS form_init
+returns the current form term hook, if any (\fBNULL\fP if there is no such
 hook).
 .SH RETURN VALUE
-Routines that return pointers return \fBNULL\fR on error.
+Routines that return pointers return \fBNULL\fP on error.
 Other routines
 return one of the following:
 .TP 5
@@ -85,12 +87,12 @@ return one of the following:
 The routine succeeded.
 .TP 5
 .B E_SYSTEM_ERROR
-System error occurred (see \fBerrno\fR).
+System error occurred (see \fBerrno\fP(3)).
 .SH SEE ALSO
-\fBcurses\fR(3X), \fBform\fR(3X).
+\fBcurses\fP(3X), \fBform\fP(3X).
 .SH NOTES
-The header file \fB<form.h>\fR automatically includes the header file
-\fB<curses.h>\fR.
+The header file \fB<form.h>\fP automatically includes the header file
+\fB<curses.h>\fP.
 .SH PORTABILITY
 These routines emulate the System V forms library.
 They were not supported on