ncurses 6.2 - patch 20201017
[ncurses.git] / man / menu_hook.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2007,2010 Free Software Foundation, Inc.                  *
5 .\"                                                                          *
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:                 *
13 .\"                                                                          *
14 .\" The above copyright notice and this permission notice shall be included  *
15 .\" in all copies or substantial portions of the Software.                   *
16 .\"                                                                          *
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.                               *
24 .\"                                                                          *
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       *
28 .\" authorization.                                                           *
29 .\"***************************************************************************
30 .\"
31 .\" $Id: menu_hook.3x,v 1.15 2020/10/17 23:44:57 tom Exp $
32 .TH menu_hook 3X ""
33 .SH NAME
34 \fBmenu_hook\fR \- set hooks for automatic invocation by applications
35 .SH SYNOPSIS
36 \fB#include <menu.h>\fR
37 .sp
38 \fBint set_item_init(MENU *\fP\fImenu\fP\fB, Menu_Hook \fP\fIfunc);\fP
39 .br
40 \fBMenu_Hook item_init(const MENU *\fP\fImenu);\fP
41 .sp
42 \fBint set_item_term(MENU *\fP\fImenu\fP\fB, Menu_Hook \fP\fIfunc);\fP
43 .br
44 \fBMenu_Hook item_term(const MENU *\fP\fImenu);\fP
45 .sp
46 \fBint set_menu_init(MENU *\fP\fImenu\fP\fB, Menu_Hook \fP\fIfunc);\fP
47 .br
48 \fBMenu_Hook menu_init(const MENU *\fP\fImenu);\fP
49 .sp
50 \fBint set_menu_term(MENU *\fP\fImenu\fP\fB, Menu_Hook \fP\fIfunc);\fP
51 .br
52 \fBMenu_Hook menu_term(const MENU *\fP\fImenu);\fP
53 .br
54 .SH DESCRIPTION
55 These functions make it possible to set hook functions to be called at various
56 points in the automatic processing of input event codes by \fBmenu_driver\fR.
57 .PP
58 The function \fBset_item_init\fR sets a hook to be called at menu-post time and
59 each time the selected item changes (after the change).
60 \fBitem_init\fR
61 returns the current item init hook, if any (\fBNULL\fR if there is no such
62 hook).
63 .PP
64 The function \fBset_item_term\fR sets a hook to be called at menu-unpost time
65 and each time the selected item changes (before the change).
66 \fBitem_term\fR
67 returns the current item term hook, if any (\fBNULL\fR if there is no such
68 hook).
69 .PP
70 The function \fBset_menu_init\fR sets a hook to be called at menu-post time and
71 just after the top row on the menu changes once it is posted.
72 \fBmenu_init\fR
73 returns the current menu init hook, if any (\fBNULL\fR if there is no such
74 hook).
75 .PP
76 The function \fBset_menu_term\fR sets a hook to be called at menu-unpost time
77 and just before the top row on the menu changes once it is posted.
78 \fBmenu_term\fR returns the current menu term hook, if any (\fBNULL\fR if there
79 is no such hook).
80 .SH RETURN VALUE
81 Routines that return pointers return \fBNULL\fR on error.
82 Other routines
83 return one of the following:
84 .TP 5
85 .B E_OK
86 The routine succeeded.
87 .TP 5
88 .B E_SYSTEM_ERROR
89 System error occurred (see \fBerrno\fR(3)).
90 .SH SEE ALSO
91 \fBcurses\fR(3X), \fBmenu\fR(3X).
92 .SH NOTES
93 The header file \fB<menu.h>\fR automatically includes the header file
94 \fB<curses.h>\fR.
95 .SH PORTABILITY
96 These routines emulate the System V menu library.
97 They were not supported on
98 Version 7 or BSD versions.
99 .SH AUTHORS
100 Juergen Pfeifer.
101 Manual pages and adaptation for new curses by Eric
102 S. Raymond.