1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 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 * @Id: menu_hook.3x,v 1.32 2024/03/16 15:35:01 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 https://invisible-island.net/scripts/readme.html#others_scripts"> 37<TITLE>menu_hook 3x 2024-03-16 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">menu_hook 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> Library calls <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><menu.h></STRONG> 55 56 <STRONG>int</STRONG> <STRONG>set_item_init(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Hook</STRONG> <EM>func</EM><STRONG>);</STRONG> 57 <STRONG>Menu_Hook</STRONG> <STRONG>item_init(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG> 58 59 <STRONG>int</STRONG> <STRONG>set_item_term(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Hook</STRONG> <EM>func</EM><STRONG>);</STRONG> 60 <STRONG>Menu_Hook</STRONG> <STRONG>item_term(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG> 61 62 <STRONG>int</STRONG> <STRONG>set_menu_init(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Hook</STRONG> <EM>func</EM><STRONG>);</STRONG> 63 <STRONG>Menu_Hook</STRONG> <STRONG>menu_init(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG> 64 65 <STRONG>int</STRONG> <STRONG>set_menu_term(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Hook</STRONG> <EM>func</EM><STRONG>);</STRONG> 66 <STRONG>Menu_Hook</STRONG> <STRONG>menu_term(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG> 67 68 69</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 70 These functions make it possible to set hook functions to be called at 71 various points in the automatic processing of input event codes by 72 <STRONG>menu_driver</STRONG>. 73 74 The function <STRONG>set_item_init</STRONG> sets a hook to be called at menu-post time 75 and each time the selected item changes (after the change). <STRONG>item_init</STRONG> 76 returns the current item init hook, if any (<STRONG>NULL</STRONG> if there is no such 77 hook). 78 79 The function <STRONG>set_item_term</STRONG> sets a hook to be called at menu-unpost time 80 and each time the selected item changes (before the change). <STRONG>item_term</STRONG> 81 returns the current item term hook, if any (<STRONG>NULL</STRONG> if there is no such 82 hook). 83 84 The function <STRONG>set_menu_init</STRONG> sets a hook to be called at menu-post time 85 and just after the top row on the menu changes once it is posted. 86 <STRONG>menu_init</STRONG> returns the current menu init hook, if any (<STRONG>NULL</STRONG> if there is 87 no such hook). 88 89 The function <STRONG>set_menu_term</STRONG> sets a hook to be called at menu-unpost time 90 and just before the top row on the menu changes once it is posted. 91 <STRONG>menu_term</STRONG> returns the current menu term hook, if any (<STRONG>NULL</STRONG> if there is 92 no such hook). 93 94 95</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 96 Routines that return pointers return <STRONG>NULL</STRONG> on error. Other routines 97 return one of the following: 98 99 <STRONG>E_OK</STRONG> The routine succeeded. 100 101 <STRONG>E_SYSTEM_ERROR</STRONG> 102 System error occurred (see <STRONG>errno(3)</STRONG>). 103 104 105</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 106 These routines emulate the System V menu library. They were not 107 supported on Version 7 or BSD versions. 108 109 110</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 111 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 112 Raymond. 113 114 115</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 116 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> 117 118 119 120ncurses 6.5 2024-03-16 <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> 121</PRE> 122<div class="nav"> 123<ul> 124<li><a href="#h2-NAME">NAME</a></li> 125<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 126<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 127<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 128<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 129<li><a href="#h2-AUTHORS">AUTHORS</a></li> 130<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 131</ul> 132</div> 133</BODY> 134</HTML> 135