ncurses 6.0 - patch 20170506
[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 applications
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
55        int set_item_init(MENU *menu, Menu_Hook func);
56        Menu_Hook item_init(const MENU *menu);
57        int set_item_term(MENU *menu, Menu_Hook func);
58        Menu_Hook item_term(const MENU *menu);
59        int set_menu_init(MENU *menu, Menu_Hook func);
60        Menu_Hook menu_init(const MENU *menu);
61        int set_menu_term(MENU *menu, Menu_Hook func);
62        Menu_Hook menu_term(const MENU *menu);
63
64
65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66        These  functions make it possible to set hook functions to be called at
67        various points in the automatic processing  of  input  event  codes  by
68        <STRONG>menu_driver</STRONG>.
69
70        The  function  <STRONG>set_item_init</STRONG> sets a hook to be called at menu-post time
71        and each time the selected item changes (after the change).   <STRONG>item_init</STRONG>
72        returns  the  current  item init hook, if any (<STRONG>NULL</STRONG> if there is no such
73        hook).
74
75        The function <STRONG>set_item_term</STRONG> sets a hook to be called at menu-unpost time
76        and each time the selected item changes (before the change).  <STRONG>item_term</STRONG>
77        returns the current item term hook, if any (<STRONG>NULL</STRONG> if there  is  no  such
78        hook).
79
80        The  function  <STRONG>set_menu_init</STRONG> sets a hook to be called at menu-post time
81        and just after the top row on the  menu  changes  once  it  is  posted.
82        <STRONG>menu_init</STRONG>  returns the current menu init hook, if any (<STRONG>NULL</STRONG> if there is
83        no such hook).
84
85        The function <STRONG>set_menu_term</STRONG> sets a hook to be called at menu-unpost time
86        and  just  before  the  top  row on the menu changes once it is posted.
87        <STRONG>menu_term</STRONG> returns the current menu term hook, if any (<STRONG>NULL</STRONG> if there  is
88        no such hook).
89
90
91 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
92        Routines  that  return  pointers  return <STRONG>NULL</STRONG> on error.  Other routines
93        return one of the following:
94
95        <STRONG>E_OK</STRONG> The routine succeeded.
96
97        <STRONG>E_SYSTEM_ERROR</STRONG>
98             System error occurred (see <STRONG>errno</STRONG>).
99
100
101 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
102        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
103
104
105 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
106        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
107        <STRONG>&lt;curses.h&gt;</STRONG>.
108
109
110 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
111        These  routines  emulate the System V menu library.  They were not sup-
112        ported on Version 7 or BSD versions.
113
114
115 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
116        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
117        Raymond.
118
119
120
121                                                                  <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
122 </PRE>
123 <div class="nav">
124 <ul>
125 <li><a href="#h2-NAME">NAME</a></li>
126 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
127 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
128 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
129 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
130 <li><a href="#h2-NOTES">NOTES</a></li>
131 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
132 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
133 </ul>
134 </div>
135 </BODY>
136 </HTML>