X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmenu_hook.3x;h=661e20dcfd4cd6f0eed4e4a846ab9716bf07ce38;hb=16fbf3f4f7d96b6ee6bf9159b22f26e05962aa3d;hp=adf0cb41932621c5e3bbe376992ac81da34022a4;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/menu_hook.3x b/man/menu_hook.3x index adf0cb41..661e20dc 100644 --- a/man/menu_hook.3x +++ b/man/menu_hook.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * .\" Copyright 1998-2007,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,57 +28,57 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_hook.3x,v 1.14 2020/02/02 23:34:34 tom Exp $ +.\" $Id: menu_hook.3x,v 1.18 2022/02/12 20:05:11 tom Exp $ .TH menu_hook 3X "" .SH NAME -\fBmenu_hook\fR \- set hooks for automatic invocation by applications +\fBmenu_hook\fP \- set hooks for automatic invocation by applications .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_item_init(MENU *\fImenu\fB, Menu_Hook \fIfunc);\fR .br -int set_item_init(MENU *menu, Menu_Hook func); +\fBMenu_Hook item_init(const MENU *\fImenu);\fR +.sp +\fBint set_item_term(MENU *\fImenu\fB, Menu_Hook \fIfunc);\fR .br -Menu_Hook item_init(const MENU *menu); +\fBMenu_Hook item_term(const MENU *\fImenu);\fR +.sp +\fBint set_menu_init(MENU *\fImenu\fB, Menu_Hook \fIfunc);\fR .br -int set_item_term(MENU *menu, Menu_Hook func); +\fBMenu_Hook menu_init(const MENU *\fImenu);\fR +.sp +\fBint set_menu_term(MENU *\fImenu\fB, Menu_Hook \fIfunc);\fR .br -Menu_Hook item_term(const MENU *menu); -.br -int set_menu_init(MENU *menu, Menu_Hook func); -.br -Menu_Hook menu_init(const MENU *menu); -.br -int set_menu_term(MENU *menu, Menu_Hook func); -.br -Menu_Hook menu_term(const MENU *menu); +\fBMenu_Hook menu_term(const MENU *\fImenu);\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. +points in the automatic processing of input event codes by \fBmenu_driver\fP. .PP -The function \fBset_item_init\fR sets a hook to be called at menu-post time and +The function \fBset_item_init\fP 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 +\fBitem_init\fP +returns the current item init hook, if any (\fBNULL\fP if there is no such hook). .PP -The function \fBset_item_term\fR sets a hook to be called at menu-unpost time +The function \fBset_item_term\fP 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 +\fBitem_term\fP +returns the current item term hook, if any (\fBNULL\fP if there is no such hook). .PP -The function \fBset_menu_init\fR sets a hook to be called at menu-post time and +The function \fBset_menu_init\fP 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 +\fBmenu_init\fP +returns the current menu init hook, if any (\fBNULL\fP if there is no such hook). .PP -The function \fBset_menu_term\fR sets a hook to be called at menu-unpost time +The function \fBset_menu_term\fP 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 +\fBmenu_term\fP returns the current menu term hook, if any (\fBNULL\fP if there is no such hook). .SH RETURN VALUE -Routines that return pointers return \fBNULL\fR on error. +Routines that return pointers return \fBNULL\fP on error. Other routines return one of the following: .TP 5 @@ -86,12 +86,12 @@ return one of the following: The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR(3)). +System error occurred (see \fBerrno\fP(3)). .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fP(3X), \fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on