ncurses 6.3 - patch 20220101

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

diff --git a/man/form_hook.3x b/man/form_hook.3x
index 19c1b9fbd7a06d0393ddac555cdef77d9e4abf17..94396eee5f54bbaf7ca6f678a0bb4ea906dbba91 100644 (file)
--- a/man/form_hook.3x
+++ b/man/form_hook.3x
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright 2018-2020,2021 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


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

-.\" $Id: form_hook.3x,v 1.6 1999/03/20 22:37:15 Todd.Miller Exp $
+.\" $Id: form_hook.3x,v 1.18 2021/12/25 21:49:32 tom Exp $

 .TH form_hook 3X ""
 .SH NAME
 .TH form_hook 3X ""
 .SH NAME

-\fBform_hook\fR - 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>\fR
+\fB#include <form.h>\fP
+.sp
+\fBint set_field_init(FORM *\fP\fIform\fP\fB, Form_Hook \fP\fIfunc\fP\fB);\fP

 .br
 .br

-int set_field_init(FORM *form, void (*func)(FORM *));
+\fBForm_Hook field_init(const FORM *\fP\fIform\fP\fB);\fP
+.sp
+\fBint set_field_term(FORM *\fP\fIform\fP\fB, Form_Hook \fP\fIfunc\fP\fB);\fP

 .br
 .br

-void (*)(FORM *) field_init(const FORM *form);
+\fBForm_Hook field_term(const FORM *\fP\fIform\fP\fB);\fP
+.sp
+\fBint set_form_init(FORM *\fP\fIform\fP\fB, Form_Hook \fP\fIfunc\fP\fB);\fP

 .br
 .br

-int set_field_term(FORM *form, void (*func)(FORM *));
+\fBForm_Hook form_init(const FORM *\fP\fIform\fP\fB);\fP
+.sp
+\fBint set_form_term(FORM *\fP\fIform\fP\fB, Form_Hook \fP\fIfunc\fP\fB);\fP

 .br
 .br

-void (*)(FORM *) field_term(const FORM *form);
-.br
-int set_form_init(FORM *form, void (*func)(FORM *));
-.br
-void (*)(FORM *) form_init(const FORM *form);
-.br
-int set_form_term(FORM *form, void (*func)(FORM *));
-.br
-void (*)(FORM *) form_term(const FORM *form);
+\fBForm_Hook form_term(const FORM *\fP\fIform\fP\fB);\fP

 .br
 .SH DESCRIPTION
 These functions make it possible to set hook functions to be called at various
 .br
 .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.
-
-The function \fBset_field_init\fR 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
+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
+and each time the selected field changes (after the change).
+\fBfield_init\fP
+returns the current field init hook, if any (\fBNULL\fP if there is no such

 hook).
 hook).

-
-The function \fBset_field_term\fR 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
+.PP
+The function \fBset_field_term\fP sets a hook to be called at form-unpost time
+and each time the selected field changes (before the change).
+\fBfield_term\fP
+returns the current field term hook, if any (\fBNULL\fP if there is no such

 hook).
 hook).

-
-The function \fBset_form_init\fR 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).
-
-The function \fBset_form_term\fR 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
+.PP
+The function \fBset_form_init\fP 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
+and just before a page change once it is posted.
+\fBform_init\fP
+returns the current form term hook, if any (\fBNULL\fP if there is no such

 hook).
 .SH RETURN VALUE
 hook).
 .SH RETURN VALUE

-Routines that return pointers return \fBNULL\fR on error.  Other routines
+Routines that return pointers return \fBNULL\fP on error.
+Other routines

 return one of the following:
 .TP 5
 return one of the following:
 .TP 5

-\fBE_OK\fR
+.B E_OK

 The routine succeeded.
 .TP 5
 The routine succeeded.
 .TP 5

-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fP(3)).

 .SH SEE ALSO
 .SH SEE ALSO

-\fBcurses\fR(3X), \fBform\fR(3X).
+\fBcurses\fP(3X), \fBform\fP(3X).

 .SH NOTES
 .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
 .SH PORTABILITY

-These routines emulate the System V forms library.  They were not supported on
+These routines emulate the System V forms library.
+They were not supported on

 Version 7 or BSD versions.
 .SH AUTHORS
 Version 7 or BSD versions.
 .SH AUTHORS

-Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
-S. Raymond.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.