2 ****************************************************************************
3 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2007,2010 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: form_hook.3x,v 1.37 2024/03/16 15:35:01 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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 2024-03-16 ncurses 6.5 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">form_hook 3x 2024-03-16 ncurses 6.5 Library calls</H1>
44 <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>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>form_hook</STRONG> - set hooks for automatic invocation by applications
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
56 <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>
57 <STRONG>Form_Hook</STRONG> <STRONG>field_init(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
59 <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>
60 <STRONG>Form_Hook</STRONG> <STRONG>field_term(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
62 <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>
63 <STRONG>Form_Hook</STRONG> <STRONG>form_init(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
65 <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>
66 <STRONG>Form_Hook</STRONG> <STRONG>form_term(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
69 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
70 These functions make it possible to set hook functions to be called at
71 various points in the automatic processing of input event codes by
72 <STRONG>form_driver</STRONG>.
75 </PRE><H3><a name="h3-set_field_init">set_field_init</a></H3><PRE>
76 sets a hook to be called at form-post time and each time the selected
77 field changes (after the change).
80 </PRE><H3><a name="h3-field_init">field_init</a></H3><PRE>
81 returns the current field init hook, if any (<STRONG>NULL</STRONG> if there is no such
85 </PRE><H3><a name="h3-set_field_term">set_field_term</a></H3><PRE>
86 sets a hook to be called at form-unpost time and each time the selected
87 field changes (before the change).
90 </PRE><H3><a name="h3-field_term">field_term</a></H3><PRE>
91 returns the current field term hook, if any (<STRONG>NULL</STRONG> if there is no such
95 </PRE><H3><a name="h3-set_form_init">set_form_init</a></H3><PRE>
96 sets a hook to be called at form-post time and just after a page change
100 </PRE><H3><a name="h3-form_init">form_init</a></H3><PRE>
101 returns the current form init hook, if any (<STRONG>NULL</STRONG> if there is no such
105 </PRE><H3><a name="h3-set_form_term">set_form_term</a></H3><PRE>
106 sets a hook to be called at form-unpost time and just before a page
107 change once it is posted.
110 </PRE><H3><a name="h3-form_term">form_term</a></H3><PRE>
111 returns the current form term hook, if any (<STRONG>NULL</STRONG> if there is no such
115 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
116 Routines that return pointers return <STRONG>NULL</STRONG> on error. Other routines
117 return one of the following:
119 <STRONG>E_OK</STRONG> The routine succeeded.
121 <STRONG>E_SYSTEM_ERROR</STRONG>
122 System error occurred (see <STRONG>errno(3)</STRONG>).
125 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
126 These routines emulate the System V forms library. They were not
127 supported on Version 7 or BSD versions.
130 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
131 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
135 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
136 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>
140 ncurses 6.5 2024-03-16 <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
144 <li><a href="#h2-NAME">NAME</a></li>
145 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
146 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
148 <li><a href="#h3-set_field_init">set_field_init</a></li>
149 <li><a href="#h3-field_init">field_init</a></li>
150 <li><a href="#h3-set_field_term">set_field_term</a></li>
151 <li><a href="#h3-field_term">field_term</a></li>
152 <li><a href="#h3-set_form_init">set_form_init</a></li>
153 <li><a href="#h3-form_init">form_init</a></li>
154 <li><a href="#h3-set_form_term">set_form_term</a></li>
155 <li><a href="#h3-form_term">form_term</a></li>
158 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
159 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
160 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
161 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>