t
***************************************************************************
Copyright 2018-2019,2020 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.16 2020/10/18 00:06:29 tom Exp $
form_hook - set hooks for automatic invocation by applications #include <form.h> int set_field_init(FORM *form, Form_Hook func);

Form_Hook field_init(const FORM *form); int set_field_term(FORM *form, Form_Hook func);

Form_Hook field_term(const FORM *form); int set_form_init(FORM *form, Form_Hook func);

Form_Hook form_init(const FORM *form); int set_form_term(FORM *form, Form_Hook func);

Form_Hook form_term(const FORM *form);

These functions make it possible to set hook functions to be called at various points in the automatic processing of input event codes by form_driver.

The function set_field_init sets a hook to be called at form-post time and each time the selected field changes (after the change). field_init returns the current field init hook, if any (NULL if there is no such hook).

The function set_field_term sets a hook to be called at form-unpost time and each time the selected field changes (before the change). field_term returns the current field term hook, if any (NULL if there is no such hook).

The function set_form_init sets a hook to be called at form-post time and just after a page change once it is posted. form_init returns the current form init hook, if any (NULL if there is no such hook).

The function set_form_term sets a hook to be called at form-unpost time and just before a page change once it is posted. form_init returns the current form term hook, if any (NULL if there is no such hook).

Routines that return pointers return NULL on error. Other routines return one of the following:

5 E_OK The routine succeeded.

5 E_SYSTEM_ERROR System error occurred (see errno(3)).

curses(3X), form(3X). The header file <form.h> automatically includes the header file <curses.h>. These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.