← Back to branch summary

~ubuntu-branches/ubuntu/natty/ncurses/natty

« back to all changes in this revision

Viewing changes to man/form_hook.3x

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-05-17 09:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517090042-86fgxrr6j5jzagot
Tags: 5.6-0ubuntu1
* New upstream version.
  - Remove patches applied upstream: ncurses.upstream, signed-chars.
  - Update patches: debian-backspace.
* Build-depend on g++-multilib instead of lib{32,64}c*-dev-*.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/form_hook.3x
1
1
'\" t
2
2
.\"***************************************************************************
3
 
.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
 
3
.\" Copyright (c) 1998,2006 Free Software Foundation, Inc.                   *
4
4
.\"                                                                          *
5
5
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
6
6
.\" copy of this software and associated documentation files (the            *
27
27
.\" authorization.                                                           *
28
28
.\"***************************************************************************
29
29
.\"
30
 
.\" $Id: form_hook.3x,v 1.6 1999/03/20 22:37:15 Todd.Miller Exp $
 
30
.\" $Id: form_hook.3x,v 1.8 2006/11/04 17:12:00 tom Exp $
31
31
.TH form_hook 3X ""
32
32
.SH NAME
33
33
\fBform_hook\fR - set hooks for automatic invocation by applications
53
53
.SH DESCRIPTION
54
54
These functions make it possible to set hook functions to be called at various
55
55
points in the automatic processing of input event codes by \fBform_driver\fR.
56
 
 
 
56
.PP
57
57
The function \fBset_field_init\fR sets a hook to be called at form-post time
58
58
and each time the selected field changes (after the change).  \fBfield_init\fR
59
59
returns the current field init hook, if any (\fBNULL\fR if there is no such
60
60
hook).
61
 
 
 
61
.PP
62
62
The function \fBset_field_term\fR sets a hook to be called at form-unpost time
63
63
and each time the selected field changes (before the change).  \fBfield_term\fR
64
64
returns the current field term hook, if any (\fBNULL\fR if there is no such
65
65
hook).
66
 
 
 
66
.PP
67
67
The function \fBset_form_init\fR sets a hook to be called at form-post time and
68
68
just after a page change once it is posted.  \fBform_init\fR returns the
69
69
current form init hook, if any (\fBNULL\fR if there is no such hook).
70
 
 
 
70
.PP
71
71
The function \fBset_form_term\fR sets a hook to be called at form-unpost time
72
72
and just before a page change once it is posted.  \fBform_init\fR
73
73
returns the current form term hook, if any (\fBNULL\fR if there is no such
76
76
Routines that return pointers return \fBNULL\fR on error.  Other routines
77
77
return one of the following:
78
78
.TP 5
79
 
\fBE_OK\fR
 
79
.B E_OK
80
80
The routine succeeded.
81
81
.TP 5
82
 
\fBE_SYSTEM_ERROR\fR
 
82
.B E_SYSTEM_ERROR
83
83
System error occurred (see \fBerrno\fR).
84
84
.SH SEE ALSO
85
85
\fBcurses\fR(3X), \fBform\fR(3X).