X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_hook.3x;h=661e20dcfd4cd6f0eed4e4a846ab9716bf07ce38;hp=41d1c74aefa474914b2709a59a01993096cfcc05;hb=HEAD;hpb=eccca377f55c70b12e3e92621d94d1e1c1fcfb7d diff --git a/man/menu_hook.3x b/man/menu_hook.3x index 41d1c74a..839e199b 100644 --- a/man/menu_hook.3x +++ b/man/menu_hook.3x @@ -1,6 +1,6 @@ -'\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2018,2019 Free Software Foundation, Inc. * +.\" Copyright 2018-2023,2024 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,57 +27,55 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_hook.3x,v 1.13 2019/01/20 20:32:23 tom Exp $ -.TH menu_hook 3X "" +.\" $Id: menu_hook.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH menu_hook 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .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 -.br -int set_item_init(MENU *menu, Menu_Hook func); -.br -Menu_Hook item_init(const MENU *menu); -.br -int set_item_term(MENU *menu, Menu_Hook func); -.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); -.br +.nf +\fB#include +.PP +\fBint set_item_init(MENU *\fImenu\fP, Menu_Hook \fIfunc\fP); +\fBMenu_Hook item_init(const MENU *\fImenu\fP); +.PP +\fBint set_item_term(MENU *\fImenu\fP, Menu_Hook \fIfunc\fP); +\fBMenu_Hook item_term(const MENU *\fImenu\fP); +.PP +\fBint set_menu_init(MENU *\fImenu\fP, Menu_Hook \fIfunc\fP); +\fBMenu_Hook menu_init(const MENU *\fImenu\fP); +.PP +\fBint set_menu_term(MENU *\fImenu\fP, Menu_Hook \fIfunc\fP); +\fBMenu_Hook menu_term(const MENU *\fImenu\fP); +.fi .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 @@ -85,12 +83,7 @@ return one of the following: The routine succeeded. .TP 5 .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. +System error occurred (see \fBerrno\fP(3)). .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -99,3 +92,6 @@ Version 7 or BSD versions. Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X)