diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/debian-bookworm/man3/hook.3form | |
parent | Initial commit. (diff) | |
download | manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip |
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-bookworm/man3/hook.3form')
-rw-r--r-- | upstream/debian-bookworm/man3/hook.3form | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/upstream/debian-bookworm/man3/hook.3form b/upstream/debian-bookworm/man3/hook.3form new file mode 100644 index 00000000..ca4eaadb --- /dev/null +++ b/upstream/debian-bookworm/man3/hook.3form @@ -0,0 +1,101 @@ +'\" t +.\"*************************************************************************** +.\" Copyright 2018-2021,2022 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.3x,v 1.19 2022/02/12 20:03:40 tom Exp $ +.TH hook 3FORM "" +.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 +.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\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 +\fBncurses\fP(3NCURSES), \fBform\fP(3FORM). +.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. |