X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_hook.3x;h=a37ba1a2a31102b595a0a9013f96b55acd51cb6e;hb=bf2c36c4930ac5bb04cd2b1ba209cd09b6f510ab;hp=94396eee5f54bbaf7ca6f678a0bb4ea906dbba91;hpb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;p=ncurses.git diff --git a/man/form_hook.3x b/man/form_hook.3x index 94396eee..a37ba1a2 100644 --- a/man/form_hook.3x +++ b/man/form_hook.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2020,2021 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 * @@ -28,53 +27,52 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_hook.3x,v 1.18 2021/12/25 21:49:32 tom Exp $ -.TH form_hook 3X "" +.\" $Id: form_hook.3x,v 1.34 2024/01/05 21:46:58 tom Exp $ +.TH form_hook 3X 2024-01-05 "ncurses 6.4" "Library calls" .SH NAME -\fBform_hook\fP \- set hooks for automatic invocation by applications +\fBform_hook\fP \- +set hooks for automatic invocation by applications .SH SYNOPSIS -\fB#include \fP -.sp -\fBint set_field_init(FORM *\fP\fIform\fP\fB, Form_Hook \fP\fIfunc\fP\fB);\fP -.br -\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 -\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 -\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 -\fBForm_Hook form_term(const FORM *\fP\fIform\fP\fB);\fP -.br +.nf +\fB#include +.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. -.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). -\fBfield_init\fP +.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\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). -\fBfield_term\fP +.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\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. -\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. -\fBform_init\fP +.SS form_init returns the current form term hook, if any (\fBNULL\fP if there is no such hook). .SH RETURN VALUE @@ -87,11 +85,6 @@ The routine succeeded. .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\fP automatically includes the header file -\fB\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -99,3 +92,6 @@ Version 7 or BSD versions. .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)