1 .\"***************************************************************************
2 .\" Copyright 2018-2022,2023 Thomas E. Dickey *
3 .\" Copyright 1998-2010,2015 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: mitem_opts.3x,v 1.29 2023/10/07 21:19:07 tom Exp $
31 .TH mitem_opts 3X 2023-10-07 "ncurses 6.4" "Library calls"
37 set and get menu item options
42 \fBint set_item_opts(ITEM *\fIitem\fP, Item_Options \fIopts\fP);
43 \fBItem_Options item_opts(const ITEM *\fIitem\fP);
45 \fBint item_opts_on(ITEM *\fIitem\fP, Item_Options \fIopts\fP);
46 \fBint item_opts_off(ITEM *\fIitem\fP, Item_Options \fIopts\fP);
49 The function \fBset_item_opts\fP sets all the given item's option bits (menu
50 option bits may be logically-OR'ed together).
52 The function \fBitem_opts_on\fP turns on the given option bits, and leaves
55 The function \fBitem_opts_off\fP turns off the given option bits, and leaves
58 The function \fBitem_opts\fP returns the item's current option bits.
60 There is only one defined option bit mask, \fBO_SELECTABLE\fP. When this is
61 on, the item may be selected during menu processing.
65 Except for \fBitem_opts\fP, each routine returns one of the following:
68 The routine succeeded.
71 System error occurred (see \fBerrno\fP(3)).
73 The header file \fB<menu.h>\fP automatically includes the header file
76 These routines emulate the System V menu library.
77 They were not supported on
78 Version 7 or BSD versions.
81 Manual pages and adaptation for new curses by Eric S. Raymond.