Debian Codegraph @

upstream/debian-unstable/man3/menu_opts.3menu

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2024,2025 Thomas E. Dickey *
3 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
4 .\" *
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: *
12 .\" *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
15 .\" *
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. *
23 .\" *
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 *
27 .\" authorization. *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: mitem_opts.3x,v 1.36 2025/01/19 00:51:10 tom Exp $
31 .TH menu_opts 3MENU 2025-01-18 "ncurses 6.6" "Library calls"
32 .ie \n(.g \{\
33 .ds `` \(lq
34 .ds '' \(rq
35 .\}
36 .el \{\
37 .ie t .ds `` ``
38 .el .ds `` ""
39 .ie t .ds '' ''
40 .el .ds '' ""
41 .\}
42 .SH NAME
43 \fBset_item_opts\fP,
44 \fBitem_opts_on\fP,
45 \fBitem_opts_off\fP,
46 \fBitem_opts\fP \-
47 set and get menu item options
48 .SH SYNOPSIS
49 .nf
50 \fB#include <menu.h>
51 .PP
52 \fBint set_item_opts(ITEM *\fIitem\fP, Item_Options \fIopts\fP);
53 \fBItem_Options item_opts(const ITEM *\fIitem\fP);
54 .PP
55 \fBint item_opts_on(ITEM *\fIitem\fP, Item_Options \fIopts\fP);
56 \fBint item_opts_off(ITEM *\fIitem\fP, Item_Options \fIopts\fP);
57 .fi
58 .SH DESCRIPTION
59 The function \fBset_item_opts\fP sets all the given item's option bits
60 (menu option bits may be logically \*(``or\*(''-ed together).
61 .PP
62 The function \fBitem_opts_on\fP turns on the given option bits, and leaves
63 others alone.
64 .PP
65 The function \fBitem_opts_off\fP turns off the given option bits, and leaves
66 others alone.
67 .PP
68 The function \fBitem_opts\fP returns the item's current option bits.
69 .PP
70 There is only one defined option bit mask, \fBO_SELECTABLE\fP. When this is
71 on, the item may be selected during menu processing.
72 This option defaults
73 to on.
74 .SH RETURN VALUE
75 Except for \fBitem_opts\fP, each routine returns one of the following:
76 .TP 5
77 .B E_OK
78 The routine succeeded.
79 .TP 5
80 .B E_SYSTEM_ERROR
81 System error occurred (see \fBerrno\fP(3)).
82 .SH PORTABILITY
83 These routines emulate the System V menu library.
84 They were not supported on
85 Version 7 or BSD versions.
86 .SH AUTHORS
87 Juergen Pfeifer.
88 Manual pages and adaptation for new curses by Eric S. Raymond.
89 .SH SEE ALSO
90 \fB\%ncurses\fP(3NCURSES),
91 \fB\%menu\fP(3MENU)