2 .\"***************************************************************************
3 .\" Copyright 2018-2022,2023 Thomas E. Dickey *
4 .\" Copyright 1998-2010,2015 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: mitem_opts.3x,v 1.25 2023/09/16 23:38:39 tom Exp $
32 .TH mitem_opts 3X 2023-09-16 "ncurses 6.4" "Library calls"
38 set and get menu item options
40 \fB#include <menu.h>\fP
42 \fBint set_item_opts(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR
44 \fBItem_Options item_opts(const ITEM *\fIitem\fB);\fR
46 \fBint item_opts_on(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR
48 \fBint item_opts_off(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR
50 The function \fBset_item_opts\fP sets all the given item's option bits (menu
51 option bits may be logically-OR'ed together).
53 The function \fBitem_opts_on\fP turns on the given option bits, and leaves
56 The function \fBitem_opts_off\fP turns off the given option bits, and leaves
59 The function \fBitem_opts\fP returns the item's current option bits.
61 There is only one defined option bit mask, \fBO_SELECTABLE\fP. When this is
62 on, the item may be selected during menu processing.
66 Except for \fBitem_opts\fP, each routine returns one of the following:
69 The routine succeeded.
72 System error occurred (see \fBerrno\fP(3)).
74 \fBcurses\fP(3X), \fBmenu\fP(3X).
76 The header file \fB<menu.h>\fP automatically includes the header file
79 These routines emulate the System V menu library.
80 They were not supported on
81 Version 7 or BSD versions.
84 Manual pages and adaptation for new curses by Eric S. Raymond.