summaryrefslogtreecommitdiff
path: root/static/openbsd/man3/form_hook.3
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:54:44 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:54:44 -0400
commita9157ce950dfe2fc30795d43b9d79b9d1bffc48b (patch)
tree9df484304b560466d145e662c1c254ff0e9ae0ba /static/openbsd/man3/form_hook.3
parent160aa82b2d39c46ad33723d7d909cb4972efbb03 (diff)
docs: Added All OpenBSD Manuals
Diffstat (limited to 'static/openbsd/man3/form_hook.3')
-rw-r--r--static/openbsd/man3/form_hook.3102
1 files changed, 102 insertions, 0 deletions
diff --git a/static/openbsd/man3/form_hook.3 b/static/openbsd/man3/form_hook.3
new file mode 100644
index 00000000..d4e35752
--- /dev/null
+++ b/static/openbsd/man3/form_hook.3
@@ -0,0 +1,102 @@
+'\" t
+.\" $OpenBSD: form_hook.3,v 1.12 2023/10/17 09:52:10 nicm Exp $
+.\"
+.\"***************************************************************************
+.\" 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 *
+.\" "Software"), to deal in the Software without restriction, including *
+.\" without limitation the rights to use, copy, modify, merge, publish, *
+.\" distribute, distribute with modifications, sublicense, and/or sell *
+.\" copies of the Software, and to permit persons to whom the Software is *
+.\" furnished to do so, subject to the following conditions: *
+.\" *
+.\" The above copyright notice and this permission notice shall be included *
+.\" in all copies or substantial portions of the Software. *
+.\" *
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+.\" *
+.\" Except as contained in this notice, the name(s) of the above copyright *
+.\" holders shall not be used in advertising or otherwise to promote the *
+.\" sale, use or other dealings in this Software without prior written *
+.\" authorization. *
+.\"***************************************************************************
+.\"
+.\" $Id: form_hook.3,v 1.12 2023/10/17 09:52:10 nicm Exp $
+.TH form_hook 3 2023-07-01 "ncurses 6.4" "Library calls"
+.SH NAME
+\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
+.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
+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).
+.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).
+.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
+Routines that return pointers return \fBNULL\fP on error.
+Other routines
+return one of the following:
+.TP 5
+.B E_OK
+The routine succeeded.
+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fP(3)).
+.SH SEE ALSO
+\fBcurses\fP(3), \fBform\fP(3).
+.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
+Version 7 or BSD versions.
+.SH AUTHORS
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.