diff options
| author | Thorsten Lockert <tholo@cvs.openbsd.org> | 1996-06-02 21:34:43 +0000 |
|---|---|---|
| committer | Thorsten Lockert <tholo@cvs.openbsd.org> | 1996-06-02 21:34:43 +0000 |
| commit | b8d379a3b8bd8bdd763abd7ea8cdc4e53351f610 (patch) | |
| tree | a7f7e1c184744929e43893e3e0a2cb573c3425ae /lib/libmenu/menu_items.3 | |
| parent | 65af288d2747dc891a03f23bb5259b26adf16e7b (diff) | |
SYSV-style menu library; from ncurses
Diffstat (limited to 'lib/libmenu/menu_items.3')
| -rw-r--r-- | lib/libmenu/menu_items.3 | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/lib/libmenu/menu_items.3 b/lib/libmenu/menu_items.3 new file mode 100644 index 00000000000..4545ccce538 --- /dev/null +++ b/lib/libmenu/menu_items.3 @@ -0,0 +1,62 @@ +'\" t +.TH menu_items 3X "" +.SH NAME +\fBmenu_items\fR - make and break connections between items and menus +.SH SYNOPSIS +\fB#include <menu.h>\fR +.br +int set_menu_items(MENU *menu, ITEM **items); +.br +ITEM **menu_items(MENU *menu); +.br +int item_count(MENU *menu); +.br +.SH DESCRIPTION +The function \fBset_menu_items\fR changes the item pointer array of the given +\fImenu\fR. The array must be terminated by a \fBNULL\fR. + +The function \fBmenu_items\fR returns the item array of the given menu. + +The function \fBitem_count\fR returns the count of items in \fImenu\fR. +.SH RETURN VALUES +The function \fBmenu_items\fR returns \fBNULL\fR on error. + +The function \fBitem_count\fR returns \fBERR\fR (the general \fBcurses\fR error +return value) on error. + +The function \fBset_menu_items\fR returns one of the following codes on error: +.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_NOT_CONNECTED\fR +No items are connected to the menu. +.SH SEE ALSO +\fBcurses\fR(3X), \fBmenu\fR(3X). +.SH NOTES +The header file \fB<menu.h>\fR automatically includes the header file +\fB<curses.h>\fR. +.SH PORTABILITY +These routines emulate the System V menu library. They were not supported on +Version 7 or BSD versions. + +The SVr4 menu library documentation specifies the \fBitem_count\fR error value +as -1 (which is the value of \fBERR\fR). +.SH AUTHORS +Juergen Pfeifer. Manual pages and adaptation for new curses by Eric +S. Raymond. +.\"# +.\"# The following sets edit modes for GNU EMACS +.\"# Local Variables: +.\"# mode:nroff +.\"# fill-column:79 +.\"# End: |