2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
28 .\"***************************************************************************
30 .\" $Id: menu_opts.3x,v 1.10 2007/02/24 17:33:59 tom Exp $
33 \fBmenu_opts\fR - set and get menu options
35 \fB#include <menu.h>\fR
37 int set_menu_opts(MENU *menu, Menu_Options opts);
39 int menu_opts_on(MENU *menu, Menu_Options opts);
41 int menu_opts_off(MENU *menu, Menu_Options opts);
43 Menu_Options menu_opts(const MENU *menu);
46 The function \fBset_menu_opts\fR sets all the given menu's option bits (menu
47 option bits may be logically-OR'ed together).
49 The function \fBmenu_opts_on\fR turns on the given option bits, and leaves
52 The function \fBmenu_opts_off\fR turns off the given option bits, and leaves
55 The function \fBmenu_opts\fR returns the menu's current option bits.
57 The following options are defined (all are on by default):
60 Only one item can be selected for this menu.
63 Display the item descriptions when the menu is posted.
66 Display the menu in row-major order.
69 Ignore the case when pattern-matching.
72 Move the cursor to within the item name while pattern-matching.
75 Don't wrap around next-item and previous-item,
76 requests to the other end of the menu.
78 Except for \fBmenu_opts\fR, each routine returns one of the following:
81 The routine succeeded.
84 System error occurred (see \fBerrno\fR).
87 The menu is already posted.
89 \fBcurses\fR(3X), \fBmenu\fR(3X).
91 The header file \fB<menu.h>\fR automatically includes the header file
94 These routines emulate the System V menu library. They were not supported on
95 Version 7 or BSD versions.
97 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
100 .\"# The following sets edit modes for GNU EMACS
101 .\"# Local Variables: