ncursesw-morphos/doc/html/man/menu_hook.3x.html

146 lines
6.5 KiB
HTML
Raw Normal View History

2002-10-13 11:35:53 +08:00
<!--
* t
****************************************************************************
* Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. *
2002-10-13 11:35:53 +08:00
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* "Software"), to deal in the Software without restriction, including *
* without limitation the rights to use, copy, modify, merge, publish, *
* distribute, distribute with modifications, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included *
* in all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
* *
* Except as contained in this notice, the name(s) of the above copyright *
* holders shall not be used in advertising or otherwise to promote the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
* @Id: menu_hook.3x,v 1.11 2010/12/04 18:40:45 tom Exp @
2002-10-13 11:35:53 +08:00
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2000-07-09 10:46:08 +08:00
<HTML>
2002-10-13 11:35:53 +08:00
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
2002-10-13 11:35:53 +08:00
<TITLE>menu_hook 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
2000-07-09 10:46:08 +08:00
<BODY>
<H1 class="no-header">menu_hook 3x</H1>
2000-07-09 10:46:08 +08:00
<PRE>
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG> <STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
2004-02-09 10:15:26 +08:00
2000-07-09 10:46:08 +08:00
</PRE>
<H2><a name="h2-NAME">NAME</a></H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG>menu_hook</STRONG> - set hooks for automatic invocation by applica-
2000-07-09 10:46:08 +08:00
tions
</PRE>
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
int set_item_init(MENU *menu, Menu_Hook func);
Menu_Hook item_init(const MENU *menu);
int set_item_term(MENU *menu, Menu_Hook func);
Menu_Hook item_term(const MENU *menu);
int set_menu_init(MENU *menu, Menu_Hook func);
Menu_Hook menu_init(const MENU *menu);
int set_menu_term(MENU *menu, Menu_Hook func);
Menu_Hook menu_term(const MENU *menu);
2000-07-09 10:46:08 +08:00
</PRE>
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
2000-07-09 10:46:08 +08:00
These functions make it possible to set hook functions to
be called at various points in the automatic processing of
2002-10-13 11:35:53 +08:00
input event codes by <STRONG>menu_driver</STRONG>.
2000-07-09 10:46:08 +08:00
2002-10-13 11:35:53 +08:00
The function <STRONG>set_item_init</STRONG> sets a hook to be called at
2000-07-09 10:46:08 +08:00
menu-post time and each time the selected item changes
2002-10-13 11:35:53 +08:00
(after the change). <STRONG>item_init</STRONG> returns the current item
init hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
2000-07-09 10:46:08 +08:00
2002-10-13 11:35:53 +08:00
The function <STRONG>set_item_term</STRONG> sets a hook to be called at
2000-07-09 10:46:08 +08:00
menu-unpost time and each time the selected item changes
2002-10-13 11:35:53 +08:00
(before the change). <STRONG>item_term</STRONG> returns the current item
term hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
2000-07-09 10:46:08 +08:00
2002-10-13 11:35:53 +08:00
The function <STRONG>set_menu_init</STRONG> sets a hook to be called at
2000-07-09 10:46:08 +08:00
menu-post time and just after the top row on the menu
2002-10-13 11:35:53 +08:00
changes once it is posted. <STRONG>menu_init</STRONG> returns the current
menu init hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
2000-07-09 10:46:08 +08:00
2002-10-13 11:35:53 +08:00
The function <STRONG>set_menu_term</STRONG> sets a hook to be called at
2000-07-09 10:46:08 +08:00
menu-unpost time and just before the top row on the menu
2002-10-13 11:35:53 +08:00
changes once it is posted. <STRONG>menu_term</STRONG> returns the current
menu term hook, if any (<STRONG>NULL</STRONG> if there is no such hook).
2000-07-09 10:46:08 +08:00
</PRE>
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
2002-10-13 11:35:53 +08:00
Routines that return pointers return <STRONG>NULL</STRONG> on error. Other
2000-07-09 10:46:08 +08:00
routines return one of the following:
2002-10-13 11:35:53 +08:00
<STRONG>E_OK</STRONG> The routine succeeded.
2000-07-09 10:46:08 +08:00
2002-10-13 11:35:53 +08:00
<STRONG>E_SYSTEM_ERROR</STRONG>
System error occurred (see <STRONG>errno</STRONG>).
2000-07-09 10:46:08 +08:00
</PRE>
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
2000-07-09 10:46:08 +08:00
</PRE>
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
2002-10-13 11:35:53 +08:00
The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
file <STRONG>&lt;curses.h&gt;</STRONG>.
2000-07-09 10:46:08 +08:00
</PRE>
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
2000-07-09 10:46:08 +08:00
These routines emulate the System V menu library. They
were not supported on Version 7 or BSD versions.
</PRE>
<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
2000-07-09 10:46:08 +08:00
Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="menu_hook.3x.html">menu_hook(3x)</A></STRONG>
2000-07-09 10:46:08 +08:00
</PRE>
<div class="nav">
<ul>
<li><a href="#h2-NAME">NAME</a></li>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
<li><a href="#h2-NOTES">NOTES</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
<li><a href="#h2-AUTHORS">AUTHORS</a></li>
</ul>
</div>
2000-07-09 10:46:08 +08:00
</BODY>
</HTML>