ncurses 5.7 - patch 20110108
[ncurses.git] / doc / html / man / form_hook.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 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.11 2010/12/04 18:40:45 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_hook 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_hook 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
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>
50 <H2>NAME</H2><PRE>
51        <STRONG>form_hook</STRONG> - set hooks for automatic invocation by applica-
52        tions
53
54
55 </PRE>
56 <H2>SYNOPSIS</H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
58        int set_field_init(FORM *form, Form_Hook func);
59        Form_Hook field_init(const FORM *form);
60        int set_field_term(FORM *form, Form_Hook func);
61        Form_Hook field_term(const FORM *form);
62        int set_form_init(FORM *form, Form_Hook func);
63        Form_Hook form_init(const FORM *form);
64        int set_form_term(FORM *form, Form_Hook func);
65        Form_Hook form_term(const FORM *form);
66
67
68 </PRE>
69 <H2>DESCRIPTION</H2><PRE>
70        These functions make it possible to set hook functions  to
71        be called at various points in the automatic processing of
72        input event codes by <STRONG>form_driver</STRONG>.
73
74        The function <STRONG>set_field_init</STRONG> sets a hook to  be  called  at
75        form-post  time  and  each time the selected field changes
76        (after the change).  <STRONG>field_init</STRONG> returns the current  field
77        init hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
78
79        The  function  <STRONG>set_field_term</STRONG>  sets a hook to be called at
80        form-unpost time and each time the selected field  changes
81        (before the change).  <STRONG>field_term</STRONG> returns the current field
82        term hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
83
84        The function <STRONG>set_form_init</STRONG> sets a hook  to  be  called  at
85        form-post  time  and  just  after a page change once it is
86        posted.  <STRONG>form_init</STRONG> returns the current form init hook,  if
87        any (<STRONG>NULL</STRONG> if there is no such hook).
88
89        The  function  <STRONG>set_form_term</STRONG>  sets  a hook to be called at
90        form-unpost time and just before a page change once it  is
91        posted.   <STRONG>form_init</STRONG> returns the current form term hook, if
92        any (<STRONG>NULL</STRONG> if there is no such hook).
93
94
95 </PRE>
96 <H2>RETURN VALUE</H2><PRE>
97        Routines that return pointers return <STRONG>NULL</STRONG> on error.  Other
98        routines return one of the following:
99
100        <STRONG>E_OK</STRONG> The routine succeeded.
101
102        <STRONG>E_SYSTEM_ERROR</STRONG>
103             System error occurred (see <STRONG>errno</STRONG>).
104
105
106 </PRE>
107 <H2>SEE ALSO</H2><PRE>
108        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
109
110
111 </PRE>
112 <H2>NOTES</H2><PRE>
113        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
114        file <STRONG>&lt;curses.h&gt;</STRONG>.
115
116
117 </PRE>
118 <H2>PORTABILITY</H2><PRE>
119        These routines emulate the System V forms  library.   They
120        were not supported on Version 7 or BSD versions.
121
122
123 </PRE>
124 <H2>AUTHORS</H2><PRE>
125        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
126        curses by Eric S. Raymond.
127
128
129
130                                                           <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
131 </PRE>
132 <HR>
133 <ADDRESS>
134 Man(1) output converted with
135 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
136 </ADDRESS>
137 </BODY>
138 </HTML>