Debian Codegraph @

doc/html/man/mitem_opts.3x.html

raw
1 <!--
2 ****************************************************************************
3 * Copyright 2018-2024,2025 Thomas E. Dickey *
4 * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
5 * *
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: *
13 * *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
16 * *
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. *
24 * *
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 *
28 * authorization. *
29 ****************************************************************************
30 * @Id: mitem_opts.3x,v 1.36 2025/01/19 00:51:10 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>mitem_opts 3x 2025-01-18 ncurses 6.6 Library calls</TITLE>
38 <link rel="author" href="mailto:[email protected]">
39
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">mitem_opts 3x 2025-01-18 ncurses 6.6 Library calls</H1>
43 <PRE>
44 <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG> Library calls <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
45
46
47 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
48 <STRONG>set_item_opts</STRONG>, <STRONG>item_opts_on</STRONG>, <STRONG>item_opts_off</STRONG>, <STRONG>item_opts</STRONG> - set and get
49 menu item options
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53 <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
54
55 <STRONG>int</STRONG> <STRONG>set_item_opts(ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>,</STRONG> <STRONG>Item_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
56 <STRONG>Item_Options</STRONG> <STRONG>item_opts(const</STRONG> <STRONG>ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>);</STRONG>
57
58 <STRONG>int</STRONG> <STRONG>item_opts_on(ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>,</STRONG> <STRONG>Item_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>item_opts_off(ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>,</STRONG> <STRONG>Item_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63 The function <STRONG>set_item_opts</STRONG> sets all the given item's option bits (menu
64 option bits may be logically "or"-ed together).
65
66 The function <STRONG>item_opts_on</STRONG> turns on the given option bits, and leaves
67 others alone.
68
69 The function <STRONG>item_opts_off</STRONG> turns off the given option bits, and leaves
70 others alone.
71
72 The function <STRONG>item_opts</STRONG> returns the item's current option bits.
73
74 There is only one defined option bit mask, <STRONG>O_SELECTABLE</STRONG>. When this is
75 on, the item may be selected during menu processing. This option
76 defaults to on.
77
78
79 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
80 Except for <STRONG>item_opts</STRONG>, each routine returns one of the following:
81
82 <STRONG>E_OK</STRONG> The routine succeeded.
83
84 <STRONG>E_SYSTEM_ERROR</STRONG>
85 System error occurred (see <STRONG>errno(3)</STRONG>).
86
87
88 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
89 These routines emulate the System V menu library. They were not
90 supported on Version 7 or BSD versions.
91
92
93 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
94 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
95 Raymond.
96
97
98 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
99 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
100
101 ncurses 6.6 2025-01-18 <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
102 </PRE>
103 <div class="nav">
104 <ul>
105 <li><a href="#h2-NAME">NAME</a></li>
106 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
107 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
108 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
109 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
110 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
111 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
112 </ul>
113 </div>
114 </BODY>
115 </HTML>