ncurses 6.0 - patch 20170114
[ncurses.git] / doc / html / man / menu_hook.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 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   * @Id: menu_hook.3x,v 1.11 2010/12/04 18:40:45 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_hook 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">menu_hook 3x</H1>
43 <PRE>
44 <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>                                             <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>menu_hook</STRONG> - set hooks for automatic invocation by applica-
51        tions
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56        int set_item_init(MENU *menu, Menu_Hook func);
57        Menu_Hook item_init(const MENU *menu);
58        int set_item_term(MENU *menu, Menu_Hook func);
59        Menu_Hook item_term(const MENU *menu);
60        int set_menu_init(MENU *menu, Menu_Hook func);
61        Menu_Hook menu_init(const MENU *menu);
62        int set_menu_term(MENU *menu, Menu_Hook func);
63        Menu_Hook menu_term(const MENU *menu);
64
65
66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67        These functions make it possible to set hook functions  to
68        be called at various points in the automatic processing of
69        input event codes by <STRONG>menu_driver</STRONG>.
70
71        The function <STRONG>set_item_init</STRONG> sets a hook  to  be  called  at
72        menu-post  time  and  each  time the selected item changes
73        (after the change).  <STRONG>item_init</STRONG> returns  the  current  item
74        init hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
75
76        The  function  <STRONG>set_item_term</STRONG>  sets  a hook to be called at
77        menu-unpost time and each time the selected  item  changes
78        (before  the  change).  <STRONG>item_term</STRONG> returns the current item
79        term hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
80
81        The function <STRONG>set_menu_init</STRONG> sets a hook  to  be  called  at
82        menu-post  time  and  just  after  the top row on the menu
83        changes once it is posted.  <STRONG>menu_init</STRONG> returns the  current
84        menu init hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
85
86        The  function  <STRONG>set_menu_term</STRONG>  sets  a hook to be called at
87        menu-unpost time and just before the top row on  the  menu
88        changes  once it is posted.  <STRONG>menu_term</STRONG> returns the current
89        menu term hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
90
91
92 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
93        Routines that return pointers return <STRONG>NULL</STRONG> on error.  Other
94        routines return one of the following:
95
96        <STRONG>E_OK</STRONG> The routine succeeded.
97
98        <STRONG>E_SYSTEM_ERROR</STRONG>
99             System error occurred (see <STRONG>errno</STRONG>).
100
101
102 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
103        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
104
105
106 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
107        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
108        file <STRONG>&lt;curses.h&gt;</STRONG>.
109
110
111 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
112        These routines emulate the System V  menu  library.   They
113        were not supported on Version 7 or BSD versions.
114
115
116 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
117        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
118        curses by Eric S. Raymond.
119
120
121
122                                                           <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
123 </PRE>
124 <div class="nav">
125 <ul>
126 <li><a href="#h2-NAME">NAME</a></li>
127 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
128 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
129 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
130 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
131 <li><a href="#h2-NOTES">NOTES</a></li>
132 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
133 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
134 </ul>
135 </div>
136 </BODY>
137 </HTML>