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

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