doc/html/man/form_hook.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: form_hook.3x,v 1.13 2019/01/20 20:31:42 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>form_hook 3x</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">form_hook 3x</H1>
  43 <PRE>
  44 <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>                                                    <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>form_hook</STRONG> - set hooks for automatic invocation by applications
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  55        int set_field_init(FORM *form, Form_Hook func);
  56        Form_Hook field_init(const FORM *form);
  57        int set_field_term(FORM *form, Form_Hook func);
  58        Form_Hook field_term(const FORM *form);
  59        int set_form_init(FORM *form, Form_Hook func);
  60        Form_Hook form_init(const FORM *form);
  61        int set_form_term(FORM *form, Form_Hook func);
  62        Form_Hook form_term(const FORM *form);
  63
  64
  65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  66        These  functions make it possible to set hook functions to be called at
  67        various points in the automatic processing  of  input  event  codes  by
  68        <STRONG>form_driver</STRONG>.
  69
  70        The  function <STRONG>set_field_init</STRONG> sets a hook to be called at form-post time
  71        and  each  time  the  selected  field  changes  (after   the   change).
  72        <STRONG>field_init</STRONG>  returns  the current field init hook, if any (<STRONG>NULL</STRONG> if there
  73        is no such hook).
  74
  75        The function <STRONG>set_field_term</STRONG> sets a hook to  be  called  at  form-unpost
  76        time  and  each  time  the  selected field changes (before the change).
  77        <STRONG>field_term</STRONG> returns the current field term hook, if any (<STRONG>NULL</STRONG>  if  there
  78        is no such hook).
  79
  80        The  function  <STRONG>set_form_init</STRONG> sets a hook to be called at form-post time
  81        and just after a page change once it is posted.  <STRONG>form_init</STRONG> returns  the
  82        current form init hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
  83
  84        The function <STRONG>set_form_term</STRONG> sets a hook to be called at form-unpost time
  85        and just before a page change once it is posted.  <STRONG>form_init</STRONG> returns the
  86        current form term hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
  87
  88
  89 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  90        Routines  that  return  pointers  return <STRONG>NULL</STRONG> on error.  Other routines
  91        return one of the following:
  92
  93        <STRONG>E_OK</STRONG> The routine succeeded.
  94
  95        <STRONG>E_SYSTEM_ERROR</STRONG>
  96             System error occurred (see <STRONG>errno(3)</STRONG>).
  97
  98
  99 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 100        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
 101
 102
 103 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 104        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
 105        <STRONG>&lt;curses.h&gt;</STRONG>.
 106
 107
 108 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 109        These  routines emulate the System V forms library.  They were not sup-
 110        ported on Version 7 or BSD versions.
 111
 112
 113 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 114        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 115        Raymond.
 116
 117
 118
 119                                                                  <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 120 </PRE>
 121 <div class="nav">
 122 <ul>
 123 <li><a href="#h2-NAME">NAME</a></li>
 124 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 125 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 126 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 127 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 128 <li><a href="#h2-NOTES">NOTES</a></li>
 129 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 130 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 131 </ul>
 132 </div>
 133 </BODY>
 134 </HTML>