X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fmenu_hook.3x;h=adf0cb41932621c5e3bbe376992ac81da34022a4;hb=47d2fb4537d9ad5bb14f4810561a327930ca4280;hp=531528a607834418caac20a4f6d9dfb621c73197;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;p=ncurses.git diff --git a/man/menu_hook.3x b/man/menu_hook.3x index 531528a6..adf0cb41 100644 --- a/man/menu_hook.3x +++ b/man/menu_hook.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 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 * @@ -27,75 +28,75 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_hook.3x,v 1.6 1998/11/29 01:09:47 Rick.Ohnemus Exp $ +.\" $Id: menu_hook.3x,v 1.14 2020/02/02 23:34:34 tom Exp $ .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 \fR .br -int set_item_init(MENU *menu, void (*func)(MENU *)); +int set_item_init(MENU *menu, Menu_Hook func); .br -void (*)(MENU *) item_init(const MENU *menu); +Menu_Hook item_init(const MENU *menu); .br -int set_item_term(MENU *menu, void (*func)(MENU *)); +int set_item_term(MENU *menu, Menu_Hook func); .br -void (*)(MENU *) item_term(const MENU *menu); +Menu_Hook item_term(const MENU *menu); .br -int set_menu_init(MENU *menu, void (*func)(MENU *)); +int set_menu_init(MENU *menu, Menu_Hook func); .br -void (*)(MENU *) menu_init(const MENU *menu); +Menu_Hook menu_init(const MENU *menu); .br -int set_menu_term(MENU *menu, void (*func)(MENU *)); +int set_menu_term(MENU *menu, Menu_Hook func); .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. - +.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 +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 +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 +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 is no such hook). .SH RETURN VALUE -Routines that return pointers return \fBNULL\fR on error. Other routines +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 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +These routines emulate the System V menu library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric +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: