ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / menu_hook.3x.html
1 <!--
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2007,2010 Free Software Foundation, Inc.                  *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: menu_hook.3x,v 1.15 2020/10/17 23:44:57 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>menu_hook 3X</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">menu_hook 3X</H1>
44 <PRE>
45 <B><A HREF="menu_hook.3X.html">menu_hook(3X)</A></B>                                                    <B><A HREF="menu_hook.3X.html">menu_hook(3X)</A></B>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <B>menu_hook</B> - set hooks for automatic invocation by applications
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <B>#include</B> <B>&lt;menu.h&gt;</B>
56
57        <B>int</B> <B>set_item_init(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>Menu_Hook</B> <I>func);</I>
58        <B>Menu_Hook</B> <B>item_init(const</B> <B>MENU</B> <B>*</B><I>menu);</I>
59
60        <B>int</B> <B>set_item_term(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>Menu_Hook</B> <I>func);</I>
61        <B>Menu_Hook</B> <B>item_term(const</B> <B>MENU</B> <B>*</B><I>menu);</I>
62
63        <B>int</B> <B>set_menu_init(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>Menu_Hook</B> <I>func);</I>
64        <B>Menu_Hook</B> <B>menu_init(const</B> <B>MENU</B> <B>*</B><I>menu);</I>
65
66        <B>int</B> <B>set_menu_term(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>Menu_Hook</B> <I>func);</I>
67        <B>Menu_Hook</B> <B>menu_term(const</B> <B>MENU</B> <B>*</B><I>menu);</I>
68
69
70 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
71        These  functions make it possible to set hook functions to be called at
72        various points in the automatic processing  of  input  event  codes  by
73        <B>menu_driver</B>.
74
75        The  function  <B>set_item_init</B> sets a hook to be called at menu-post time
76        and each time the selected item changes (after the change).   <B>item_init</B>
77        returns  the  current  item init hook, if any (<B>NULL</B> if there is no such
78        hook).
79
80        The function <B>set_item_term</B> sets a hook to be called at menu-unpost time
81        and each time the selected item changes (before the change).  <B>item_term</B>
82        returns the current item term hook, if any (<B>NULL</B> if there  is  no  such
83        hook).
84
85        The  function  <B>set_menu_init</B> sets a hook to be called at menu-post time
86        and just after the top row on the  menu  changes  once  it  is  posted.
87        <B>menu_init</B>  returns the current menu init hook, if any (<B>NULL</B> if there is
88        no such hook).
89
90        The function <B>set_menu_term</B> sets a hook to be called at menu-unpost time
91        and  just  before  the  top  row on the menu changes once it is posted.
92        <B>menu_term</B> returns the current menu term hook, if any (<B>NULL</B> if there  is
93        no such hook).
94
95
96 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
97        Routines  that  return  pointers  return <B>NULL</B> on error.  Other routines
98        return one of the following:
99
100        <B>E_OK</B> The routine succeeded.
101
102        <B>E_SYSTEM_ERROR</B>
103             System error occurred (see <B>errno(3)</B>).
104
105
106 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
107        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
108
109
110 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
111        The  header  file  <B>&lt;menu.h&gt;</B>  automatically  includes  the  header  file
112        <B>&lt;curses.h&gt;</B>.
113
114
115 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
116        These  routines  emulate  the  System  V  menu  library.  They were not
117        supported on Version 7 or BSD versions.
118
119
120 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
121        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
122        Raymond.
123
124
125
126                                                                  <B><A HREF="menu_hook.3X.html">menu_hook(3X)</A></B>
127 </PRE>
128 <div class="nav">
129 <ul>
130 <li><a href="#h2-NAME">NAME</a></li>
131 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
132 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
133 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
134 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
135 <li><a href="#h2-NOTES">NOTES</a></li>
136 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
137 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
138 </ul>
139 </div>
140 </BODY>
141 </HTML>