+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<!--
+ * t
+ ****************************************************************************
+ * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: form_hook.3x,v 1.11 2010/12/04 18:40:45 tom Exp @
+-->
<HTML>
+<HEAD>
+<TITLE>form_hook 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1>form_hook 3x</H1>
+<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG> <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
+
+
+
</PRE>
<H2>NAME</H2><PRE>
- <B>form_hook</B> - set hooks for automatic invocation by applica-
+ <STRONG>form_hook</STRONG> - set hooks for automatic invocation by applica-
tions
</PRE>
<H2>SYNOPSIS</H2><PRE>
- <B>#include</B> <B><form.h></B>
- int set_field_init(FORM *form, void (*func)(FORM *));
- void (*)(FORM *) field_init(const FORM *form);
- int set_field_term(FORM *form, void (*func)(FORM *));
- void (*)(FORM *) field_term(const FORM *form);
- int set_form_init(FORM *form, void (*func)(FORM *));
- void (*)(FORM *) form_init(const FORM *form);
- int set_form_term(FORM *form, void (*func)(FORM *));
- void (*)(FORM *) form_term(const FORM *form);
+ <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
+ int set_field_init(FORM *form, Form_Hook func);
+ Form_Hook field_init(const FORM *form);
+ int set_field_term(FORM *form, Form_Hook func);
+ Form_Hook field_term(const FORM *form);
+ int set_form_init(FORM *form, Form_Hook func);
+ Form_Hook form_init(const FORM *form);
+ int set_form_term(FORM *form, Form_Hook func);
+ Form_Hook form_term(const FORM *form);
</PRE>
<H2>DESCRIPTION</H2><PRE>
These functions make it possible to set hook functions to
be called at various points in the automatic processing of
- input event codes by <B>form_driver</B>.
+ input event codes by <STRONG>form_driver</STRONG>.
- The function <B>set_field_init</B> sets a hook to be called at
+ The function <STRONG>set_field_init</STRONG> sets a hook to be called at
form-post time and each time the selected field changes
- (after the change). <B>field_init</B> returns the current field
- init hook, if any (<B>NULL</B> if there is no such hook).
+ (after the change). <STRONG>field_init</STRONG> returns the current field
+ init hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
- The function <B>set_field_term</B> sets a hook to be called at
+ The function <STRONG>set_field_term</STRONG> sets a hook to be called at
form-unpost time and each time the selected field changes
- (before the change). <B>field_term</B> returns the current field
- term hook, if any (<B>NULL</B> if there is no such hook).
+ (before the change). <STRONG>field_term</STRONG> returns the current field
+ term hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
- The function <B>set_form_init</B> sets a hook to be called at
+ The function <STRONG>set_form_init</STRONG> sets a hook to be called at
form-post time and just after a page change once it is
- posted. <B>form_init</B> returns the current form init hook, if
- any (<B>NULL</B> if there is no such hook).
+ posted. <STRONG>form_init</STRONG> returns the current form init hook, if
+ any (<STRONG>NULL</STRONG> if there is no such hook).
- The function <B>set_form_term</B> sets a hook to be called at
+ The function <STRONG>set_form_term</STRONG> sets a hook to be called at
form-unpost time and just before a page change once it is
- posted. <B>form_init</B> returns the current form term hook, if
- any (<B>NULL</B> if there is no such hook).
+ posted. <STRONG>form_init</STRONG> returns the current form term hook, if
+ any (<STRONG>NULL</STRONG> if there is no such hook).
</PRE>
<H2>RETURN VALUE</H2><PRE>
- Routines that return pointers return <B>NULL</B> on error. Other
+ Routines that return pointers return <STRONG>NULL</STRONG> on error. Other
routines return one of the following:
- <B>E_OK</B> The routine succeeded.
+ <STRONG>E_OK</STRONG> The routine succeeded.
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno</B>).
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno</STRONG>).
</PRE>
<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
</PRE>
<H2>NOTES</H2><PRE>
- The header file <B><form.h></B> automatically includes the header
- file <B><curses.h></B>.
+ The header file <STRONG><form.h></STRONG> automatically includes the header
+ file <STRONG><curses.h></STRONG>.
</PRE>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
</PRE>
<HR>
<ADDRESS>
projects / ncurses.git / blobdiff