f5b67b19d90a1575caee2c61fa36be603fd5f71d
[ncurses.git] / man / menu_opts.3x
1 '\" t
2 .TH menu_opts 3X ""
3 .SH NAME
4 \fBmenu_opts\fR - set and get menu options
5 .SH SYNOPSIS
6 \fB#include <menu.h>\fR
7 .br
8 int set_menu_opts(MENU *menu, OPTIONS opts);
9 .br
10 int menu_opts_on(MENU *menu, OPTIONS opts);
11 .br
12 int menu_opts_off(MENU *menu, OPTIONS opts);
13 .br
14 OPTIONS menu_opts(const MENU *menu);
15 .br
16 .SH DESCRIPTION
17 The function \fBset_menu_opts\fR sets all the given menu's option bits (menu
18 option bits may be logically-OR'ed together).
19
20 The function \fBmenu_opts_on\fR turns on the given option bits, and leaves
21 others alone.
22
23 The function \fBmenu_opts_off\fR turns off the given option bits, and leaves
24 others alone.
25
26 The function \fBmenu_opts\fR returns the menu's current option bits.  
27
28 The following options are defined (all are on by default):
29 .TP 5
30 O_ONEVALUE
31 Only one item can be selected for this menu.
32 .TP 5
33 O_SHOWDESC
34 Display the item descriptions when the menu is posted.
35 .TP 5
36 O_ROWMAJOR
37 Display the menu in row-major order.
38 .TP 5
39 O_IGNORECASE
40 Ignore the case when pattern-matching.
41 .TP 5
42 O_SHOWMATCH
43 Move the cursor to within the item name while pattern-matching.
44 .TP 5
45 O_NONCYCLIC 
46 Don't wrap around next-item and previous-item,
47 requests to the other end of the menu.
48 .SH RETURN VALUE
49 Except for \fBmenu_opts\fR, each routine returns one of the following:
50 .TP 5
51 \fBE_OK\fR
52 The routine succeeded.
53 .TP 5
54 \fBE_SYSTEM_ERROR\fR
55 System error occurred (see \fBerrno\fR).
56 .TP 5
57 \fBE_POSTED\fR
58 The menu is already posted.
59 .SH SEE ALSO
60 \fBcurses\fR(3X), \fBmenu\fR(3X).
61 .SH NOTES
62 The header file \fB<menu.h>\fR automatically includes the header file
63 \fB<curses.h>\fR.
64 .SH PORTABILITY
65 These routines emulate the System V menu library.  They were not supported on
66 Version 7 or BSD versions.
67 .SH AUTHORS
68 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
69 S. Raymond.
70 .\"#
71 .\"# The following sets edit modes for GNU EMACS
72 .\"# Local Variables:
73 .\"# mode:nroff
74 .\"# fill-column:79
75 .\"# End: