doc/html/man/menu_hook.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2020,2021 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.17 2021/12/25 21:49:32 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
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">menu_hook 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>                                                    <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>menu_hook</STRONG> - set hooks for automatic invocation by applications
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>set_item_init(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Hook</STRONG> <EM>func);</EM>
  58        <STRONG>Menu_Hook</STRONG> <STRONG>item_init(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu);</EM>
  59
  60        <STRONG>int</STRONG> <STRONG>set_item_term(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Hook</STRONG> <EM>func);</EM>
  61        <STRONG>Menu_Hook</STRONG> <STRONG>item_term(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu);</EM>
  62
  63        <STRONG>int</STRONG> <STRONG>set_menu_init(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Hook</STRONG> <EM>func);</EM>
  64        <STRONG>Menu_Hook</STRONG> <STRONG>menu_init(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu);</EM>
  65
  66        <STRONG>int</STRONG> <STRONG>set_menu_term(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Hook</STRONG> <EM>func);</EM>
  67        <STRONG>Menu_Hook</STRONG> <STRONG>menu_term(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu);</EM>
  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        <STRONG>menu_driver</STRONG>.
  74
  75        The  function  <STRONG>set_item_init</STRONG> sets a hook to be called at menu-post time
  76        and each time the selected item changes (after the change).   <STRONG>item_init</STRONG>
  77        returns  the  current  item init hook, if any (<STRONG>NULL</STRONG> if there is no such
  78        hook).
  79
  80        The function <STRONG>set_item_term</STRONG> sets a hook to be called at menu-unpost time
  81        and each time the selected item changes (before the change).  <STRONG>item_term</STRONG>
  82        returns the current item term hook, if any (<STRONG>NULL</STRONG> if there  is  no  such
  83        hook).
  84
  85        The  function  <STRONG>set_menu_init</STRONG> 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        <STRONG>menu_init</STRONG>  returns the current menu init hook, if any (<STRONG>NULL</STRONG> if there is
  88        no such hook).
  89
  90        The function <STRONG>set_menu_term</STRONG> 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        <STRONG>menu_term</STRONG> returns the current menu term hook, if any (<STRONG>NULL</STRONG> 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 <STRONG>NULL</STRONG> on error.  Other routines
  98        return one of the following:
  99
 100        <STRONG>E_OK</STRONG> The routine succeeded.
 101
 102        <STRONG>E_SYSTEM_ERROR</STRONG>
 103             System error occurred (see <STRONG>errno(3)</STRONG>).
 104
 105
 106 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 107        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
 108
 109
 110 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 111        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
 112        <STRONG>&lt;curses.h&gt;</STRONG>.
 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                                                                  <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
 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>