X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_hook.3x;h=d93d8d875cb0620da21d647621ca9412af1bb16c;hb=HEAD;hp=54a0f63286a8dfcd03fe70bc18ef100b1da9136c;hpb=31c4bcf3307145fc5368b4aaf15e41bdd66a984b;p=ncurses.git diff --git a/man/form_hook.3x b/man/form_hook.3x index 54a0f632..d93d8d87 100644 --- 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 * @@ -28,33 +27,31 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_hook.3x,v 1.25 2023/09/16 23:37:03 tom Exp $ -.TH form_hook 3X 2023-09-16 "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 \fBform_hook\fP \- set hooks for automatic invocation by applications .SH SYNOPSIS -\fB#include \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 +.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. -.SS set_field_init\fP +.SS set_field_init sets a hook to be called at form-post time and each time the selected field changes (after the change). .SS field_init @@ -75,7 +72,7 @@ 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. -.SS form_init +.SS form_term returns the current form term hook, if any (\fBNULL\fP if there is no such hook). .SH RETURN VALUE @@ -88,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 @@ -100,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)