2 ****************************************************************************
3 * Copyright (c) 1998-2006,2010 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.10 2010/12/04 18:40:45 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 http://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>
49 <H2><a name=
"h2-NAME">NAME
</a></H2><PRE>
50 <STRONG>mitem_value
</STRONG> - set and get menu item values
54 <H2><a name=
"h2-SYNOPSIS">SYNOPSIS
</a></H2><PRE>
55 <STRONG>#include
</STRONG> <STRONG><menu.h
></STRONG>
56 int set_item_value(ITEM *item, bool value);
57 bool item_value(const ITEM *item);
61 <H2><a name=
"h2-DESCRIPTION">DESCRIPTION
</a></H2><PRE>
62 If you turn off the menu option
<STRONG>O_ONEVALUE
</STRONG> (e.g., with
63 <STRONG>set_menu_opts
</STRONG> or
<STRONG>menu_opts_off
</STRONG>; see
<STRONG><A HREF=
"menu_opts.3x.html">menu_opts(
3x)
</A></STRONG>), the
64 menu becomes multi-valued; that is, more than one item may
65 simultaneously be selected.
67 In a multi_valued menu, you can used
<STRONG>set_item_value
</STRONG> to
68 select the given menu item (second argument
<STRONG>TRUE
</STRONG>) or dese-
69 lect it (second argument
<STRONG>FALSE
</STRONG>).
73 <H2><a name=
"h2-RETURN-VALUE">RETURN VALUE
</a></H2><PRE>
74 The function
<STRONG>set_item_value
</STRONG> returns one of the following:
76 <STRONG>E_OK
</STRONG> The routine succeeded.
78 <STRONG>E_SYSTEM_ERROR
</STRONG>
79 System error occurred (see
<STRONG>errno
</STRONG>).
81 <STRONG>E_REQUEST_DENIED
</STRONG>
82 The menu driver could not process the request.
86 <H2><a name=
"h2-SEE-ALSO">SEE ALSO
</a></H2><PRE>
87 <STRONG><A HREF=
"ncurses.3x.html">curses(
3x)
</A></STRONG>,
<STRONG><A HREF=
"menu.3x.html">menu(
3x)
</A></STRONG>.
91 <H2><a name=
"h2-NOTES">NOTES
</a></H2><PRE>
92 The header file
<STRONG><menu.h
></STRONG> automatically includes the header
93 file
<STRONG><curses.h
></STRONG>.
97 <H2><a name=
"h2-PORTABILITY">PORTABILITY
</a></H2><PRE>
98 These routines emulate the System V menu library. They
99 were not supported on Version
7 or BSD versions.
103 <H2><a name=
"h2-AUTHORS">AUTHORS
</a></H2><PRE>
104 Juergen Pfeifer. Manual pages and adaptation for new
105 curses by Eric S. Raymond.
109 <STRONG><A HREF=
"mitem_value.3x.html">mitem_value(
3x)
</A></STRONG>
113 <li><a href=
"#h2-NAME">NAME
</a></li>
114 <li><a href=
"#h2-SYNOPSIS">SYNOPSIS
</a></li>
115 <li><a href=
"#h2-DESCRIPTION">DESCRIPTION
</a></li>
116 <li><a href=
"#h2-RETURN-VALUE">RETURN VALUE
</a></li>
117 <li><a href=
"#h2-SEE-ALSO">SEE ALSO
</a></li>
118 <li><a href=
"#h2-NOTES">NOTES
</a></li>
119 <li><a href=
"#h2-PORTABILITY">PORTABILITY
</a></li>
120 <li><a href=
"#h2-AUTHORS">AUTHORS
</a></li>