:man| Alphabetical   Categories   About us 
 
menu (3X) | C library functions | Unix Manual Pages | :man

NAME

menu - curses extension for programming menus

CONTENTS

Synopsis
Description
Current Default Values for Item Attributes
Routine Name Index
Return Value
See Also
Notes
Portability
Authors

SYNOPSIS

#include <menu.h>

DESCRIPTION

The menu library provides terminal-independent facilities for composing menu systems on character-cell terminals. The library includes: item routines, which create and modify menu items; and menu routines, which group items into menus, display menus on the screen, and handle interaction with the user.

The menu library uses the curses libraries, and a curses initialization routine such as initscr must be called before using any of these functions. To use the menu library, link with the options -lmenu -lcurses.

Current Default Values for Item Attributes

The menu library maintains a default value for item attributes. You can get or set this default by calling the appropriate get_ or set_ routine with a NULL item pointer. Changing this default with a set_ function affects future item creations, but does not change the rendering of items already created.

Routine Name Index

The following table lists each menu routine and the name of the manual page on which it is described.

curses Routine NameManual Page Name
current_itemmitem_current(3X)
free_itemmitem_new(3X)
free_menumenu_new(3X)
item_countmenu_items(3X)
item_descriptionmitem_name(3X)
item_indexmitem_current(3X)
item_initmenu_hook(3X)
item_namemitem_name(3X)
item_optsmitem_opts(3X)
item_opts_offmitem_opts(3X)
item_opts_onmitem_opts(3X)
item_termmenu_hook(3X)
item_userptrmitem_userptr(3X)
item_valuemitem_value(3X)
item_visiblemitem_visible(3X)
menu_backmenu_attributes(3X)
menu_drivermenu_driver(3X)
menu_foremenu_attributes(3X)
menu_formatmenu_format(3X)
menu_greymenu_attributes(3X)
menu_initmenu_hook(3X)
menu_itemsmenu_items(3X)
menu_markmenu_mark(3X)
menu_optsmenu_opts(3X)
menu_opts_offmenu_opts(3X)
menu_opts_onmenu_opts(3X)
menu_padmenu_attributes(3X)
menu_patternmenu_pattern(3X)
menu_request_by_namemenu_requestname(3X)
menu_request_namemenu_requestname(3X)
menu_spacingmenu_spacing(3X)
menu_submenu_win(3X)
menu_termmenu_hook(3X)
menu_userptrmenu_userptr(3X)
menu_winmenu_win(3X)
new_itemmitem_new(3X)
new_menumenu_new(3X)
pos_menu_cursormenu_cursor(3X)
post_menumenu_post(3X)
scale_menumenu_win(3X)
set_current_itemmitem_current(3X)
set_item_initmenu_hook(3X)
set_item_optsmitem_opts(3X)
set_item_termmenu_hook(3X)
set_item_userptrmitem_userptr(3X)
set_item_valuemitem_value(3X)
set_menu_backmenu_attributes(3X)
set_menu_foremenu_attributes(3X)
set_menu_formatmenu_format(3X)
set_menu_greymenu_attributes(3X)
set_menu_initmenu_hook(3X)
set_menu_itemsmenu_items(3X)
set_menu_markmenu_mark(3X)
set_menu_optsmitem_opts(3X)
set_menu_padmenu_attributes(3X)
set_menu_patternmenu_pattern(3X)
set_menu_spacingmenu_spacing(3X)
set_menu_submenu_win(3X)
set_menu_termmenu_hook(3X)
set_menu_userptrmenu_userptr(3X)
set_menu_winmenu_win(3X)
set_top_rowmitem_current(3X)
top_rowmitem_current(3X)
unpost_menumenu_post(3X)

RETURN VALUE

Routines that return pointers return NULL on error. Routines that return an integer return one of the following error codes: -->
E_OK The routine succeeded.
E_SYSTEM_ERROR
System error occurred (see errno).
E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
E_POSTED
The menu is already posted.
E_BAD_STATE
Routine was called from an initialization or termination function.
E_NO_ROOM
Menu is too large for its window.
E_NOT_POSTED
The menu has not been posted.
E_UNKNOWN_COMMAND
The menu driver code saw an unknown request code.
E_NO_MATCH
Character failed to match.
E_NOT_SELECTABLE
The designated item cannot be selected.
E_NOT_CONNECTED
No items are connected to the menu.
E_REQUEST_DENIED
The menu driver could not process the request.

SEE ALSO

curses(3) and related pages whose names begin "menu_" for detaileddescriptions of the entry points.

NOTES

give you a link error using GNU ld(1) and many other linkers).

PORTABILITY

AUTHORS


Share this page

     Follow us

Facebook Twitter Google+ LinkedIn


 
Created by Blin Media, 2008-2013