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.14 2020/02/02 23:34:34 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 <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        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 be called at
  68        various points in the automatic processing  of  input  event  codes  by
  69        <STRONG>menu_driver</STRONG>.
  70
  71        The  function  <STRONG>set_item_init</STRONG> sets a hook to be called at menu-post time
  72        and each time the selected item changes (after the change).   <STRONG>item_init</STRONG>
  73        returns  the  current  item init hook, if any (<STRONG>NULL</STRONG> if there is no such
  74        hook).
  75
  76        The function <STRONG>set_item_term</STRONG> sets a hook to be called at menu-unpost time
  77        and each time the selected item changes (before the change).  <STRONG>item_term</STRONG>
  78        returns the current item term hook, if any (<STRONG>NULL</STRONG> if there  is  no  such
  79        hook).
  80
  81        The  function  <STRONG>set_menu_init</STRONG> sets a hook to be called at menu-post time
  82        and just after the top row on the  menu  changes  once  it  is  posted.
  83        <STRONG>menu_init</STRONG>  returns the current menu init hook, if any (<STRONG>NULL</STRONG> if there is
  84        no such hook).
  85
  86        The function <STRONG>set_menu_term</STRONG> sets a hook to be called at menu-unpost time
  87        and  just  before  the  top  row on the menu changes once it is posted.
  88        <STRONG>menu_term</STRONG> returns the current menu term hook, if any (<STRONG>NULL</STRONG> if there  is
  89        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 routines
  94        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(3)</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  file
 108        <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 were not sup-
 113        ported 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 curses by Eric S.
 118        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>