2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey *
4 .\" Copyright 1998-2015,2016 Free Software Foundation, Inc. *
6 .\" Permission is hereby granted, free of charge, to any person obtaining a *
7 .\" copy of this software and associated documentation files (the *
8 .\" "Software"), to deal in the Software without restriction, including *
9 .\" without limitation the rights to use, copy, modify, merge, publish, *
10 .\" distribute, distribute with modifications, sublicense, and/or sell *
11 .\" copies of the Software, and to permit persons to whom the Software is *
12 .\" furnished to do so, subject to the following conditions: *
14 .\" The above copyright notice and this permission notice shall be included *
15 .\" in all copies or substantial portions of the Software. *
17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 .\" Except as contained in this notice, the name(s) of the above copyright *
26 .\" holders shall not be used in advertising or otherwise to promote the *
27 .\" sale, use or other dealings in this Software without prior written *
29 .\"***************************************************************************
31 .\" $Id: menu_opts.3x,v 1.17 2020/02/02 23:34:34 tom Exp $
37 \fBmenu_opts\fR \- set and get menu options
39 \fB#include <menu.h>\fR
41 int set_menu_opts(MENU *menu, Menu_Options opts);
43 int menu_opts_on(MENU *menu, Menu_Options opts);
45 int menu_opts_off(MENU *menu, Menu_Options opts);
47 Menu_Options menu_opts(const MENU *menu);
50 The function \fBset_menu_opts\fR sets all the given menu's option bits (menu
51 option bits may be logically-OR'ed together).
53 The function \fBmenu_opts_on\fR turns on the given option bits, and leaves
56 The function \fBmenu_opts_off\fR turns off the given option bits, and leaves
59 The function \fBmenu_opts\fR returns the menu's current option bits.
61 The following options are defined (all are on by default):
64 Only one item can be selected for this menu.
67 Display the item descriptions when the menu is posted.
70 Display the menu in row-major order.
73 Ignore the case when pattern-matching.
76 Move the cursor to within the item name while pattern-matching.
79 Don't wrap around next-item and previous-item,
80 requests to the other end of the menu.
83 If user clicks with the mouse
84 and it does not fall on the currently active menu,
85 push \fBKEY_MOUSE\fP and the \fBMEVENT\fP data
86 back on the queue to allow processing in another part of the calling program.
88 Except for \fBmenu_opts\fR, each routine returns one of the following:
91 The routine succeeded.
94 System error occurred (see \fBerrno\fR(3)).
97 The menu is already posted.
99 \fBcurses\fR(3X), \fBmenu\fR(3X).
101 The header file \fB<menu.h>\fR automatically includes the header file
104 These routines emulate the System V menu library.
105 They were not supported on
106 Version 7 or BSD versions.
109 Manual pages and adaptation for new curses by Eric S. Raymond.