xref: /netbsd/lib/libmenu/menu_hook.3 (revision bf9ec67e)
1.\"	$NetBSD: menu_hook.3,v 1.6 2002/02/20 11:47:56 wiz Exp $
2.\"
3.\" Copyright (c) 1999
4.\"	Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
5.\"
6.\" This code is donated to The NetBSD Foundation by the author.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. The name of the Author may not be used to endorse or promote
17.\"    products derived from this software without specific prior written
18.\"    permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd September 10, 1999
33.Dt MENU_HOOK 3
34.Os
35.Sh NAME
36.Nm item_init ,
37.Nm item_term ,
38.Nm menu_init ,
39.Nm menu_term ,
40.Nm set_item_init ,
41.Nm set_item_term ,
42.Nm set_menu_init ,
43.Nm set_menu_term
44.Nd get or set handler functions for menu post/unpost or item change
45.Sh LIBRARY
46.Lb libmenu
47.Sh SYNOPSIS
48.Fd #include \*[Lt]menu.h\*[Gt]
49.Ft void (*hook)()
50.Fn item_init "MENU *menu"
51.Ft void (*hook)()
52.Fn item_term "MENU *menu"
53.Ft void (*hook)()
54.Fn menu_init "MENU *menu"
55.Ft void (*hook)()
56.Fn menu_term "MENU *menu"
57.Ft int
58.Fn set_item_init "MENU *menu" "void (*hook)())"
59.Ft int
60.Fn set_item_term "MENU *menu" "void (*hook)())"
61.Ft int
62.Fn set_menu_init "MENU *menu" "void (*hook)())"
63.Ft int
64.Fn set_menu_term "MENU *menu" "void (*hook)())"
65.Sh DESCRIPTION
66The
67.Fn item_init
68function returns a pointer to the function that will be called
69whenever the menu is posted and also just after the current item
70changes.  This is set by the
71.Fn set_item_init
72call.  The
73.Fn item_term
74function returns a pointer to the function that will be called before
75the menu is unposted and just before the current item changes, this
76pointer is set by the
77.Fn set_item_term
78call.
79The
80.Fn menu_init
81functions returns a pointer to the function that will be called just
82before the menu is posted to the screen.  This pointer is set by the
83.Fn set_menu_init
84function call.
85The
86.Fn menu_term
87function returns a pointer to the function that will be called just
88after the menu has been unposted, this pointer is set by the
89.Fn set_menu_term
90function.
91.Sh SEE ALSO
92.Xr curses 3 ,
93.Xr menus 3
94.Sh NOTES
95The header
96.Pa \*[Lt]menu.h\*[Gt]
97automatically includes both
98.Pa \*[Lt]curses.h\*[Gt]
99and
100.Pa \*[Lt]eti.h\*[Gt] .
101