X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_hook.3x;h=b4f17ed19c819acd7824b27ee0e64e83950abcf7;hb=16fbf3f4f7d96b6ee6bf9159b22f26e05962aa3d;hp=7dfa838e10267cd3fb4d125abad57c189c3396b4;hpb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;p=ncurses.git diff --git a/man/form_hook.3x b/man/form_hook.3x index 7dfa838e..b4f17ed1 100644 --- a/man/form_hook.3x +++ b/man/form_hook.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2018 Free Software Foundation, Inc. * +.\" 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 * @@ -27,57 +28,57 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_hook.3x,v 1.12 2018/07/28 21:34:06 tom Exp $ +.\" $Id: form_hook.3x,v 1.19 2022/02/12 20:03:40 tom Exp $ .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 -\fB#include \fR +\fB#include \fP +.sp +\fBint set_field_init(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR .br -int set_field_init(FORM *form, Form_Hook func); +\fBForm_Hook field_init(const FORM *\fIform\fB);\fR +.sp +\fBint set_field_term(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR .br -Form_Hook field_init(const FORM *form); +\fBForm_Hook field_term(const FORM *\fIform\fB);\fR +.sp +\fBint set_form_init(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR .br -int set_field_term(FORM *form, Form_Hook func); +\fBForm_Hook form_init(const FORM *\fIform\fB);\fR +.sp +\fBint set_form_term(FORM *\fIform\fB, Form_Hook \fIfunc\fB);\fR .br -Form_Hook field_term(const FORM *form); -.br -int set_form_init(FORM *form, Form_Hook func); -.br -Form_Hook form_init(const FORM *form); -.br -int set_form_term(FORM *form, Form_Hook func); -.br -Form_Hook form_term(const FORM *form); +\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\fR. +points in the automatic processing of input event codes by \fBform_driver\fP. .PP -The function \fBset_field_init\fR sets a hook to be called at form-post time +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\fR -returns the current field init hook, if any (\fBNULL\fR if there is no such +\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\fR sets a hook to be called at form-unpost time +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\fR -returns the current field term hook, if any (\fBNULL\fR if there is no such +\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\fR sets a hook to be called at form-post time and +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\fR returns the -current form init hook, if any (\fBNULL\fR if there is no such hook). +\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\fR sets a hook to be called at form-unpost time +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\fR -returns the current form term hook, if any (\fBNULL\fR if there is no such +\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\fR on error. +Routines that return pointers return \fBNULL\fP on error. Other routines return one of the following: .TP 5 @@ -85,12 +86,12 @@ return one of the following: The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fP(3)). .SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). +\fBcurses\fP(3X), \fBform\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +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