'\" t .\" Id: menu.3x,v 1.9 1997/01/05 01:23:39 tom Exp $ .TH menus 3X "" .SH NAME \fBmenus\fR - curses extension for programming menus .SH SYNOPSIS \fB#include \fR .br .SH DESCRIPTION The \fBmenus\fR 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 \fBmenus\fR library uses the \fBcurses\fR libraries, and a curses initialization routine such as \fBinitscr\fR must be called before using any of these functions. To use the \fBmenus\fR library, link with the options \fB-lmenu -lcurses\fR. .SS Current Default Values for Item Attributes The \fBmenus\fR library maintains a default value for item attributes. You can get or set this default by calling the appropriate \fBget_\fR or \fBset_\fR routine with a \fBNULL\fR item pointer. Changing this default with a \fBset_\fR function affects future item creations, but does not change the rendering of items already created. .SS Routine Name Index The following table lists each \fBmenu\fR routine and the name of the manual page on which it is described. .TS l l . \fBcurses\fR Routine Name Manual Page Name = \fBcurrent_item\fR mitem_current(3X) \fBfree_item\fR mitem_new(3X) \fBfree_menu\fR menu_new(3X) \fBitem_count\fR menu_items(3X) \fBitem_description\fR mitem_name(3X) \fBitem_index\fR mitem_current(3X) \fBitem_init\fR menu_hook(3X) \fBitem_name\fR mitem_name(3X) \fBitem_opts\fR mitem_opts(3X) \fBitem_opts_off\fR mitem_opts(3X) \fBitem_opts_on\fR mitem_opts(3X) \fBitem_term\fR menu_hook(3X) \fBitem_userptr\fR mitem_userptr(3X) \fBitem_value\fR mitem_value(3X) \fBitem_visible\fR mitem_visible(3X) \fBmenu_back\fR menu_attribs(3X) \fBmenu_driver\fR menu_driver(3X) \fBmenu_fore\fR menu_attribs(3X) \fBmenu_format\fR menu_format(3X) \fBmenu_grey\fR menu_attribs(3X) \fBmenu_init\fR menu_hook(3X) \fBmenu_items\fR menu_items(3X) \fBmenu_mark\fR menu_mark(3X) \fBmenu_opts\fR menu_opts(3X) \fBmenu_opts_off\fR menu_opts(3X) \fBmenu_opts_on\fR menu_opts(3X) \fBmenu_pad\fR menu_attribs(3X) \fBmenu_pattern\fR menu_pattern(3X) \fBmenu_request_by_name\fR menu_requestname(3X) \fBmenu_request_name\fR menu_requestname(3X) \fBmenu_spacing\fR menu_spacing(3X) \fBmenu_sub\fR menu_win(3X) \fBmenu_term\fR menu_hook(3X) \fBmenu_userptr\fR menu_userptr(3X) \fBmenu_win\fR menu_win(3X) \fBnew_item\fR mitem_new(3X) \fBnew_menu\fR menu_new(3X) \fBpos_menu_cursor\fR menu_cursor(3X) \fBpost_menu\fR menu_post(3X) \fBscale_menu\fR menu_win(3X) \fBset_current_item\fR menu_current_item(3X) \fBset_item_init\fR menu_hook(3X) \fBset_item_opts\fR mitem_opts(3X) \fBset_item_term\fR menu_hook(3X) \fBset_item_userptr\fR mitem_userptr(3X) \fBset_item_value\fR mitem_value(3X) \fBset_menu_back\fR menu_attribs(3X) \fBset_menu_fore\fR menu_attribs(3X) \fBset_menu_format\fR menu_format(3X) \fBset_menu_grey\fR menu_attribs(3X) \fBset_menu_init\fR menu_hook(3X) \fBset_menu_items\fR menu_items(3X) \fBset_menu_mark\fR menu_mark(3X) \fBset_menu_opts\fR mitem_opts(3X) \fBset_menu_pad\fR menu_attribs(3X) \fBset_menu_pattern\fR menu_pattern(3X) \fBset_menu_spacing\fR menu_spacing(3X) \fBset_menu_sub\fR menu_win(3X) \fBset_menu_term\fR menu_hook(3X) \fBset_menu_userptr\fR menu_userptr(3X) \fBset_menu_win\fR menu_win(3X) \fBset_top_row\fR mitem_current(3X) \fBtop_row\fR mitem_current(3X) \fBunpost_menu\fR menu_post(3X) .TE .SH RETURN VALUE Routines that return pointers return \fBNULL\fR on error. Routines that return an integer return one of the following error codes: .TP 5 \fBE_OK\fR The routine succeeded. .TP 5 \fBE_SYSTEM_ERROR\fR System error occurred (see \fBerrno\fR). .TP 5 \fBE_BAD_ARGUMENT\fR Routine detected an incorrect or out-of-range argument. .TP 5 \fBE_POSTED\fR The menu is already posted. .TP 5 \fBE_BAD_STATE\fR Routine was called from an initialization or termination function. .TP 5 \fBE_NO_ROOM\fR Menu is too large for its window. .TP 5 \fBE_NOT_POSTED\fR The menu has not been posted. .TP 5 \fBE_UNKNOWN_COMMAND\fR The menu driver code saw an unknown request code. .TP 5 \fBE_NO_MATCH\fR Character failed to match. .TP 5 \fBE_NOT_SELECTABLE\fR The designated item cannot be selected. .TP 5 \fBE_NOT_CONNECTED\fR No items are connected to the menu. .TP 5 \fBE_REQUEST_DENIED\fR The menu driver could not process the request. .SH SEE ALSO \fBcurses\fR(3X) and 3X pages whose names begin "menu_" for detailed descriptions of the entry points. .SH NOTES The header file \fB\fR automatically includes the header files \fB\fR and \fB\fR. In your library list, libmenu.a should be before libcurses.a; that is, you want to say `-lmenu -lcurses', not the other way around (which would give you a link error using GNU \fBld\fR(1) and many other linkers). .SH PORTABILITY These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for ncurses by Eric S. Raymond. .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: .\"# mode:nroff .\"# fill-column:79 .\"# End: