2 ****************************************************************************
3 * Copyright (c) 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 ****************************************************************************
29 * @Id: mitem_value.3x,v 1.11 2015/12/05 23:01:16 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>mitem_value 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1 class="no-header">mitem_value 3x</H1>
43 <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG> <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>set_item_value</STRONG>, <STRONG>item_value</STRONG> - set and get menu item values
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
54 int set_item_value(ITEM *item, bool value);
55 bool item_value(const ITEM *item);
58 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
59 If you turn off the menu option <STRONG>O_ONEVALUE</STRONG> (e.g., with <STRONG>set_menu_opts</STRONG> or
60 <STRONG>menu_opts_off</STRONG>; see <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>), the menu becomes multi-valued; that
61 is, more than one item may simultaneously be selected.
63 In a multi_valued menu, you can used <STRONG>set_item_value</STRONG> to select the given
64 menu item (second argument <STRONG>TRUE</STRONG>) or deselect it (second argument
65 <STRONG>FALSE</STRONG>).
68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
69 The function <STRONG>set_item_value</STRONG> returns one of the following:
71 <STRONG>E_OK</STRONG> The routine succeeded.
73 <STRONG>E_SYSTEM_ERROR</STRONG>
74 System error occurred (see <STRONG>errno</STRONG>).
76 <STRONG>E_REQUEST_DENIED</STRONG>
77 The menu driver could not process the request.
80 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
81 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
84 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
85 The header file <STRONG><menu.h></STRONG> automatically includes the header file
86 <STRONG><curses.h></STRONG>.
89 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
90 These routines emulate the System V menu library. They were not sup-
91 ported on Version 7 or BSD versions.
94 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
95 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
100 <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG>
104 <li><a href="#h2-NAME">NAME</a></li>
105 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
106 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
107 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
108 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
109 <li><a href="#h2-NOTES">NOTES</a></li>
110 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
111 <li><a href="#h2-AUTHORS">AUTHORS</a></li>