ncurses 6.5 - patch 20240615

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

diff --git a/man/form_hook.3x b/man/form_hook.3x
index 010d48e18f97a07db6e253a7b969398e1f2eea3e..d93d8d875cb0620da21d647621ca9412af1bb16c 100644 (file)
--- a/man/form_hook.3x
+++ b/man/form_hook.3x
@@ -1,6 +1,5 @@
-'\" t

 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *

 .\" Copyright 1998-2007,2010 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 1998-2007,2010 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -28,52 +27,52 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_hook.3x,v 1.23 2023/07/01 15:46:10 tom Exp $
-.TH form_hook 3X 2023-07-01 "ncurses 6.4" "Library calls"
+.\" $Id: form_hook.3x,v 1.37 2024/03/16 15:35:01 tom Exp $
+.TH form_hook 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .SH NAME
 .SH NAME

-\fBform_hook\fP \- set hooks for automatic invocation by applications
+\fBform_hook\fP \-
+set hooks for automatic invocation by applications

 .SH SYNOPSIS
 .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
+.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.
 .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
+sets a hook to be called at form-post time

 and each time the selected field changes (after the change).
 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).
 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).
 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).
 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.
 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.
 and just before a page change once it is posted.

-\fBform_init\fP
+.SS form_term

 returns the current form term hook, if any (\fBNULL\fP if there is no such
 hook).
 .SH RETURN VALUE
 returns the current form term hook, if any (\fBNULL\fP if there is no such
 hook).
 .SH RETURN VALUE


@@ -86,11 +85,6 @@ The routine succeeded.
 .TP 5
 .B E_SYSTEM_ERROR
 System error occurred (see \fBerrno\fP(3)).
 .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 PORTABILITY
 These routines emulate the System V forms library.
 They were not supported on
 .SH PORTABILITY
 These routines emulate the System V forms library.
 They were not supported on


@@ -98,3 +92,6 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.
 Manual pages and adaptation for new curses by Eric S. Raymond.
 .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)