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

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2022,2023 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.25 2023/09/16 23:37:03 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 2023-09-16 ncurses 6.4 Library calls</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">form_hook 3x 2023-09-16 ncurses 6.4 Library calls</H1>
  44 <PRE>
  45 <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>                    Library calls                   <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>form_hook</STRONG> - set hooks for automatic invocation by applications
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>set_field_init(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>Form_Hook</STRONG> <EM>func</EM><STRONG>);</STRONG>
  58        <STRONG>Form_Hook</STRONG> <STRONG>field_init(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
  59
  60        <STRONG>int</STRONG> <STRONG>set_field_term(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>Form_Hook</STRONG> <EM>func</EM><STRONG>);</STRONG>
  61        <STRONG>Form_Hook</STRONG> <STRONG>field_term(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
  62
  63        <STRONG>int</STRONG> <STRONG>set_form_init(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>Form_Hook</STRONG> <EM>func</EM><STRONG>);</STRONG>
  64        <STRONG>Form_Hook</STRONG> <STRONG>form_init(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
  65
  66        <STRONG>int</STRONG> <STRONG>set_form_term(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>Form_Hook</STRONG> <EM>func</EM><STRONG>);</STRONG>
  67        <STRONG>Form_Hook</STRONG> <STRONG>form_term(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
  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        <STRONG>form_driver</STRONG>.
  74
  75
  76 </PRE><H3><a name="h3-set_field_init">set_field_init</a></H3><PRE>
  77        sets  a  hook to be called at form-post time and each time the selected
  78        field changes (after the change).
  79
  80
  81 </PRE><H3><a name="h3-field_init">field_init</a></H3><PRE>
  82        returns the current field init hook, if any (<STRONG>NULL</STRONG> if there is  no  such
  83        hook).
  84
  85
  86 </PRE><H3><a name="h3-set_field_term">set_field_term</a></H3><PRE>
  87        sets a hook to be called at form-unpost time and each time the selected
  88        field changes (before the change).
  89
  90
  91 </PRE><H3><a name="h3-field_term">field_term</a></H3><PRE>
  92        returns the current field term hook, if any (<STRONG>NULL</STRONG> if there is  no  such
  93        hook).
  94
  95
  96 </PRE><H3><a name="h3-set_form_init">set_form_init</a></H3><PRE>
  97        sets a hook to be called at form-post time and just after a page change
  98        once it is posted.
  99
 100
 101 </PRE><H3><a name="h3-form_init">form_init</a></H3><PRE>
 102        returns the current form init hook, if any (<STRONG>NULL</STRONG> if there  is  no  such
 103        hook).
 104
 105
 106 </PRE><H3><a name="h3-set_form_term">set_form_term</a></H3><PRE>
 107        sets  a  hook  to  be called at form-unpost time and just before a page
 108        change once it is posted.
 109
 110
 111 </PRE><H3><a name="h3-form_init">form_init</a></H3><PRE>
 112        returns the current form term hook, if any (<STRONG>NULL</STRONG> if there  is  no  such
 113        hook).
 114
 115
 116 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 117        Routines  that  return  pointers  return <STRONG>NULL</STRONG> on error.  Other routines
 118        return one of the following:
 119
 120        <STRONG>E_OK</STRONG> The routine succeeded.
 121
 122        <STRONG>E_SYSTEM_ERROR</STRONG>
 123             System error occurred (see <STRONG>errno(3)</STRONG>).
 124
 125
 126 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 127        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
 128
 129
 130 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 131        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
 132        <STRONG>&lt;curses.h&gt;</STRONG>.
 133
 134
 135 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 136        These  routines  emulate  the  System  V  forms library.  They were not
 137        supported on Version 7 or BSD versions.
 138
 139
 140 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 141        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 142        Raymond.
 143
 144
 145
 146 ncurses 6.4                       2023-09-16                     <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 147 </PRE>
 148 <div class="nav">
 149 <ul>
 150 <li><a href="#h2-NAME">NAME</a></li>
 151 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 152 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 153 <ul>
 154 <li><a href="#h3-set_field_init">set_field_init</a></li>
 155 <li><a href="#h3-field_init">field_init</a></li>
 156 <li><a href="#h3-set_field_term">set_field_term</a></li>
 157 <li><a href="#h3-field_term">field_term</a></li>
 158 <li><a href="#h3-set_form_init">set_form_init</a></li>
 159 <li><a href="#h3-form_init">form_init</a></li>
 160 <li><a href="#h3-set_form_term">set_form_term</a></li>
 161 <li><a href="#h3-form_init">form_init</a></li>
 162 </ul>
 163 </li>
 164 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 165 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 166 <li><a href="#h2-NOTES">NOTES</a></li>
 167 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 168 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 169 </ul>
 170 </div>
 171 </BODY>
 172 </HTML>