set_form_init(3x)

1form_hook(3X)                                                    form_hook(3X)
2
3
4

NAME

6       form_hook - set hooks for automatic invocation by applications
7

SYNOPSIS

9       #include <form.h>
10
11       int set_field_init(FORM *form, Form_Hook func);
12       Form_Hook field_init(const FORM *form);
13
14       int set_field_term(FORM *form, Form_Hook func);
15       Form_Hook field_term(const FORM *form);
16
17       int set_form_init(FORM *form, Form_Hook func);
18       Form_Hook form_init(const FORM *form);
19
20       int set_form_term(FORM *form, Form_Hook func);
21       Form_Hook form_term(const FORM *form);
22

DESCRIPTION

24       These  functions make it possible to set hook functions to be called at
25       various points in the automatic processing  of  input  event  codes  by
26       form_driver.
27
28       The  function set_field_init sets a hook to be called at form-post time
29       and  each  time  the  selected  field  changes  (after   the   change).
30       field_init  returns  the current field init hook, if any (NULL if there
31       is no such hook).
32
33       The function set_field_term sets a hook to  be  called  at  form-unpost
34       time  and  each  time  the  selected field changes (before the change).
35       field_term returns the current field term hook, if any (NULL  if  there
36       is no such hook).
37
38       The  function  set_form_init sets a hook to be called at form-post time
39       and just after a page change once it is posted.  form_init returns  the
40       current form init hook, if any (NULL if there is no such hook).
41
42       The function set_form_term sets a hook to be called at form-unpost time
43       and just before a page change once it is posted.  form_init returns the
44       current form term hook, if any (NULL if there is no such hook).
45

RETURN VALUE

47       Routines that return pointers return NULL on error.  Other routines re‐
48       turn one of the following:
49
50       E_OK The routine succeeded.
51
52       E_SYSTEM_ERROR
53            System error occurred (see errno(3)).
54

NOTES

59       The  header  file  <form.h>  automatically  includes  the  header  file
60       <curses.h>.
61

PORTABILITY

63       These  routines emulate the System V forms library.  They were not sup‐
64       ported on Version 7 or BSD versions.
65

AUTHORS

67       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
68       Raymond.
69
70
71
72                                                                 form_hook(3X)