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_attribs.3 | |
parent | 65af288d2747dc891a03f23bb5259b26adf16e7b (diff) |
SYSV-style menu library; from ncurses
Diffstat (limited to 'lib/libmenu/menu_attribs.3')
-rw-r--r-- | lib/libmenu/menu_attribs.3 | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/lib/libmenu/menu_attribs.3 b/lib/libmenu/menu_attribs.3 new file mode 100644 index 00000000000..ebd5563d219 --- /dev/null +++ b/lib/libmenu/menu_attribs.3 @@ -0,0 +1,71 @@ +'\" t +.TH menu_attributes 3X "" +.SH NAME +\fBmenu_attributes\fR - color and attribute control for menus +.SH SYNOPSIS +\fB#include <menu.h>\fR +.br +int set_menu_fore(MENU *menu, chtype attr); +.br +chtype menu_fore(MENU *menu); +.br +int set_menu_back(MENU *menu, chtype attr); +.br +chtype menu_back(MENU *menu); +.br +int set_menu_grey(MENU *menu, chtype attr); +.br +chtype menu_grey(MENU *menu); +.br +int set_menu_pad(MENU *menu, int pad); +.br +chtype menu_pad(MENU *menu); +.br +.SH DESCRIPTION +The function \fBset_menu_fore\fR sets the foreground attribute of +\fImenu\fR. This is the highlight used for selected menu items. +\fBmenu_fore\fR returns the foreground attribute. The default +is \fBA_STANDOUT\fR. + +The function \fBset_menu_back\fR sets the background attribute of +\fImenu\fR. This is the highlight used for selectable (but not currently +selected) menu items. The function \fBmenu_back\fR returns the background +attribute. The default is \fBA_NORMAL\fR. + +The function \fBset_menu_grey\fR sets the grey attribute of \fImenu\fR. This is +the highlight used for un-selectable menu items in menus that permit more than +one selection. The function \fBmenu_grey\fR returns the grey attribute. +The default is \fBA_UNDERLINE\fR. + +The function \fBset_menu_pad\fR sets the character used to fill the space +between the name and description parts of a menu item. \fBmenu_pad\fR returns +the given menu's pad character. The default is a blank. +.SH RETURN VALUE +These routines return one of the following: +.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. +.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<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. +.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: |