ncurses 5.9 - patch 20120303
[ncurses.git] / man / menu_hook.3x
index 531528a607834418caac20a4f6d9dfb621c73197..1fd74de77935cebe5dab49840cca74d788c9741c 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: menu_hook.3x,v 1.6 1998/11/29 01:09:47 Rick.Ohnemus Exp $
+.\" $Id: menu_hook.3x,v 1.11 2010/12/04 18:40:45 tom Exp $
 .TH menu_hook 3X ""
 .SH NAME
 .TH menu_hook 3X ""
 .SH NAME
-\fBmenu_hook\fR - set hooks for automatic invocation by applications
+\fBmenu_hook\fR \- set hooks for automatic invocation by applications
 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br
-int set_item_init(MENU *menu, void (*func)(MENU *));
+int set_item_init(MENU *menu, Menu_Hook func);
 .br
 .br
-void (*)(MENU *) item_init(const MENU *menu);
+Menu_Hook item_init(const MENU *menu);
 .br
 .br
-int set_item_term(MENU *menu, void (*func)(MENU *));
+int set_item_term(MENU *menu, Menu_Hook func);
 .br
 .br
-void (*)(MENU *) item_term(const MENU *menu);
+Menu_Hook item_term(const MENU *menu);
 .br
 .br
-int set_menu_init(MENU *menu, void (*func)(MENU *));
+int set_menu_init(MENU *menu, Menu_Hook func);
 .br
 .br
-void (*)(MENU *) menu_init(const MENU *menu);
+Menu_Hook menu_init(const MENU *menu);
 .br
 .br
-int set_menu_term(MENU *menu, void (*func)(MENU *));
+int set_menu_term(MENU *menu, Menu_Hook func);
 .br
 .br
-void (*)(MENU *) menu_term(const MENU *menu);
+Menu_Hook menu_term(const MENU *menu);
 .br
 .SH DESCRIPTION
 These functions make it possible to set hook functions to be called at various
 points in the automatic processing of input event codes by \fBmenu_driver\fR.
 .br
 .SH DESCRIPTION
 These functions make it possible to set hook functions to be called at various
 points in the automatic processing of input event codes by \fBmenu_driver\fR.
-
+.PP
 The function \fBset_item_init\fR sets a hook to be called at menu-post time and
 each time the selected item changes (after the change).  \fBitem_init\fR
 returns the current item init hook, if any (\fBNULL\fR if there is no such
 hook).
 The function \fBset_item_init\fR sets a hook to be called at menu-post time and
 each time the selected item changes (after the change).  \fBitem_init\fR
 returns the current item init hook, if any (\fBNULL\fR if there is no such
 hook).
-
+.PP
 The function \fBset_item_term\fR sets a hook to be called at menu-unpost time
 and each time the selected item changes (before the change).  \fBitem_term\fR
 returns the current item term hook, if any (\fBNULL\fR if there is no such
 hook).
 The function \fBset_item_term\fR sets a hook to be called at menu-unpost time
 and each time the selected item changes (before the change).  \fBitem_term\fR
 returns the current item term hook, if any (\fBNULL\fR if there is no such
 hook).
-
+.PP
 The function \fBset_menu_init\fR sets a hook to be called at menu-post time and
 just after the top row on the menu changes once it is posted.  \fBmenu_init\fR
 returns the current menu init hook, if any (\fBNULL\fR if there is no such
 hook).
 The function \fBset_menu_init\fR sets a hook to be called at menu-post time and
 just after the top row on the menu changes once it is posted.  \fBmenu_init\fR
 returns the current menu init hook, if any (\fBNULL\fR if there is no such
 hook).
-
+.PP
 The function \fBset_menu_term\fR sets a hook to be called at menu-unpost time
 and just before the top row on the menu changes once it is posted.
 \fBmenu_term\fR returns the current menu term hook, if any (\fBNULL\fR if there
 The function \fBset_menu_term\fR sets a hook to be called at menu-unpost time
 and just before the top row on the menu changes once it is posted.
 \fBmenu_term\fR returns the current menu term hook, if any (\fBNULL\fR if there
@@ -77,10 +77,10 @@ is no such hook).
 Routines that return pointers return \fBNULL\fR on error.  Other routines
 return one of the following:
 .TP 5
 Routines that return pointers return \fBNULL\fR on error.  Other routines
 return one of the following:
 .TP 5
-\fBE_OK\fR
+.B E_OK
 The routine succeeded.
 .TP 5
 The routine succeeded.
 .TP 5
-\fBE_SYSTEM_ERROR\fR
+.B E_SYSTEM_ERROR
 System error occurred (see \fBerrno\fR).
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
 System error occurred (see \fBerrno\fR).
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).
@@ -93,9 +93,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: