ncurses 5.7 - patch 20090419
[ncurses.git] / man / form_hook.3x
index 19c1b9fbd7a06d0393ddac555cdef77d9e4abf17..cd47a24a59c811e9727ba5506e8fe174162411a7 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2006,2007 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_hook.3x,v 1.6 1999/03/20 22:37:15 Todd.Miller Exp $
+.\" $Id: form_hook.3x,v 1.9 2007/02/24 17:34:18 tom Exp $
 .TH form_hook 3X ""
 .SH NAME
 \fBform_hook\fR - set hooks for automatic invocation by applications
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
-int set_field_init(FORM *form, void (*func)(FORM *));
+int set_field_init(FORM *form, Form_Hook func);
 .br
-void (*)(FORM *) field_init(const FORM *form);
+Form_Hook field_init(const FORM *form);
 .br
-int set_field_term(FORM *form, void (*func)(FORM *));
+int set_field_term(FORM *form, Form_Hook func);
 .br
-void (*)(FORM *) field_term(const FORM *form);
+Form_Hook field_term(const FORM *form);
 .br
-int set_form_init(FORM *form, void (*func)(FORM *));
+int set_form_init(FORM *form, Form_Hook func);
 .br
-void (*)(FORM *) form_init(const FORM *form);
+Form_Hook form_init(const FORM *form);
 .br
-int set_form_term(FORM *form, void (*func)(FORM *));
+int set_form_term(FORM *form, Form_Hook func);
 .br
-void (*)(FORM *) form_term(const FORM *form);
+Form_Hook form_term(const FORM *form);
 .br
 .SH DESCRIPTION
 These functions make it possible to set hook functions to be called at various
 points in the automatic processing of input event codes by \fBform_driver\fR.
-
+.PP
 The function \fBset_field_init\fR sets a hook to be called at form-post time
 and each time the selected field changes (after the change).  \fBfield_init\fR
 returns the current field init hook, if any (\fBNULL\fR if there is no such
 hook).
-
+.PP
 The function \fBset_field_term\fR sets a hook to be called at form-unpost time
 and each time the selected field changes (before the change).  \fBfield_term\fR
 returns the current field term hook, if any (\fBNULL\fR if there is no such
 hook).
-
+.PP
 The function \fBset_form_init\fR sets a hook to be called at form-post time and
 just after a page change once it is posted.  \fBform_init\fR returns the
 current form init hook, if any (\fBNULL\fR if there is no such hook).
-
+.PP
 The function \fBset_form_term\fR sets a hook to be called at form-unpost time
 and just before a page change once it is posted.  \fBform_init\fR
 returns the current form term hook, if any (\fBNULL\fR if there is no such
@@ -76,10 +76,10 @@ hook).
 Routines that return pointers return \fBNULL\fR on error.  Other routines
 return one of the following:
 .TP 5
-\fBE_OK\fR
+.B E_OK
 The routine succeeded.
 .TP 5
-\fBE_SYSTEM_ERROR\fR
+.B E_SYSTEM_ERROR
 System error occurred (see \fBerrno\fR).
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).