menu
Section: Library calls (3X)
Updated: 202-1-11
Index
Return to Main Contents
NAME
menu -
present menus in
curses windows
SYNOPSIS
#include <menu.h>
DESCRIPTION
The
menu library provides termina-independent facilities for composing
menu systems on characte-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.
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_BAD_ARGUMENT
-
Routine detected an incorrect or ou-o-range argument.
- E_BAD_STATE
-
Routine was called from an initialization or termination function.
- E_NO_MATCH
-
Character failed to match.
- E_NO_ROOM
-
Menu is too large for its window.
- E_NOT_CONNECTED
-
No items are connected to the menu.
- E_NOT_POSTED
-
The menu has not been posted.
- E_NOT_SELECTABLE
-
The designated item cannot be selected.
- E_POSTED
-
The menu is already posted.
- E_REQUEST_DENIED
-
The menu driver could not process the request.
- E_SYSTEM_ERROR
-
System error occurred (see errno(3)).
- E_UNKNOWN_COMMAND
-
The menu driver code saw an unknown request code.
NOTES
The header file
menu.h itself includes the header file
curses.h.
PORTABILITY
These routines emulate the System V menu library.
They were not supported on
Version 7 or BSD versions.
A menu facility was documented in SVr4.2's
Character User Interface Programming document.
It is not part of X/Open Curses.
Aside from ncurses, there are few implementations:
.IP * 4
systems based on SVr4 source code, e.g., Solaris.
.IP * 4
NetBSD curses.
AUTHORS
Juergen Pfeifer.
Manual pages and adaptation for
ncurses by Eric S. Raymond.
SEE ALSO
curses(3X) and related pages whose names begin "menu_"
for detailed descriptions of the entry points.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- Current Default Values for Item Attributes
-
- Routine Name Index
-
- RETURN VALUE
-
- NOTES
-
- PORTABILITY
-
- AUTHORS
-
- SEE ALSO
-
|
|
- Running on 
-
:
