xref: /illumos-gate/usr/src/man/man3curses/menu_hook.3curses (revision ed22c7109fc5dd9e1b7a5d0333bdc7ad2718e2ab)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
MENU_HOOK 3CURSES "Dec 31, 1996"
NAME
menu_hook, set_item_init, item_init, set_item_term, item_term, set_menu_init, menu_init, set_menu_term, menu_term - assign application-specific routines for automatic invocation by menus
SYNOPSIS

cc [ flag... ] file... -lmenu  -lcurses  [ library... ]
#include <menu.h>

int set_item_init(MENU *menu, void (*func)(MENU *));

int set_item_term(MENU *menu, void (*func)(MENU *));

void item_term(MENU *menu);

int set_menu_init(MENU *menu, void (*func)(MENU *));

void menu_init(MENU *menu);

int set_menu_term(MENU *menu, void (*func)(MENU *));

void menu_term(MENU *menu);
DESCRIPTION

set_item_init() assigns the application-defined function to be called when the menu is posted and just after the current item changes. item_init() returns a pointer to the item initialization routine, if any, called when the menu is posted and just after the current item changes.

set_item_term() assigns an application-defined function to be called when the menu is unposted and just before the current item changes. item_term() returns a pointer to the termination function, if any, called when the menu is unposted and just before the current item changes.

set_menu_init() assigns an application-defined function to be called when the menu is posted and just after the top row changes on a posted menu. menu_init() returns a pointer to the menu initialization routine, if any, called when the menu is posted and just after the top row changes on a posted menu.

set_menu_term() assigns an application-defined function to be called when the menu is unposted and just before the top row changes on a posted menu. menu_term() returns a pointer to the menu termination routine, if any, called when the menu is unposted and just before the top row changes on a posted menu.

RETURN VALUES

Routines that return pointers always return NULL on error. Routines that return an integer return one of the following: E_OK

The routine returned successfully.

E_SYSTEM_ERROR

System error.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

curses(3CURSES), menus(3CURSES), attributes(5)

NOTES

The header <menu.h> automatically includes the headers <eti.h> and <curses.h>.