Seth Woolley's Man Viewer

form_hook(3X)                                                    form_hook(3X)



NAME
       form_hook - set(7,n,1 builtins) hooks for automatic invocation by applications

SYNOPSIS
       #include <form.h>
       int set_field_init(FORM *form, void (*func)(FORM *));
       void (*)(FORM *) field_init(const FORM *form);
       int set_field_term(FORM *form, void (*func)(FORM *));
       void (*)(FORM *) field_term(const FORM *form);
       int set_form_init(FORM *form, void (*func)(FORM *));
       void (*)(FORM *) form_init(const FORM *form);
       int set_form_term(FORM *form, void (*func)(FORM *));
       void (*)(FORM *) form_term(const FORM *form);

DESCRIPTION
       These  functions make it possible to set(7,n,1 builtins) hook functions to be called at
       various points in(1,8) 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(1,2,n)
       and  each  time(1,2,n)  the  selected  field  changes  (after   the   change).
       field_init  returns  the current field init hook, if(3,n) any (NULL if(3,n) there
       is no such hook).

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

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

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

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

       E_OK The routine succeeded.

       E_SYSTEM_ERROR
            System error(8,n) occurred (see errno).

SEE ALSO
       curses(3X), form(3X).

NOTES
       The  header  file(1,n)  <form.h>  automatically  includes  the  header  file(1,n)
       <curses.h>.

PORTABILITY
       These  routines emulate the System V forms library.  They were not sup-
       ported on Version 7 or BSD versions.

AUTHORS
       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
       Raymond.



                                                                 form_hook(3X)