ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / mitem_value.3x.html
1 <!--
2   ****************************************************************************
3   * Copyright 2018-2019,2020 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_value.3x,v 1.15 2020/10/17 23:53:24 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_value 3X</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">mitem_value 3X</H1>
43 <PRE>
44 <B><A HREF="mitem_value.3X.html">mitem_value(3X)</A></B>                                                <B><A HREF="mitem_value.3X.html">mitem_value(3X)</A></B>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <B>set_item_value</B>, <B>item_value</B> - set and get menu item values
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <B>#include</B> <B>&lt;menu.h&gt;</B>
55
56        <B>int</B> <B>set_item_value(ITEM</B> <B>*</B><I>item</I><B>,</B> <B>bool</B> <I>value</I><B>);</B>
57        <B>bool</B> <B>item_value(const</B> <B>ITEM</B> <B>*</B><I>item</I><B>);</B>
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        If you turn off the menu option <B>O_ONEVALUE</B> (e.g., with <B>set_menu_opts</B> or
62        <B>menu_opts_off</B>; see <B><A HREF="menu_opts.3X.html">menu_opts(3X)</A></B>), the menu becomes multi-valued;  that
63        is, more than one item may simultaneously be selected.
64
65        In a multi_valued menu, you can used <B>set_item_value</B> to select the given
66        menu item (second  argument  <B>TRUE</B>)  or  deselect  it  (second  argument
67        <B>FALSE</B>).
68
69
70 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
71        The function <B>set_item_value</B> returns one of the following:
72
73        <B>E_OK</B> The routine succeeded.
74
75        <B>E_SYSTEM_ERROR</B>
76             System error occurred (see <B>errno(3)</B>).
77
78        <B>E_REQUEST_DENIED</B>
79             The menu driver could not process the request.
80
81
82 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
83        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
84
85
86 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
87        The  header  file  <B>&lt;menu.h&gt;</B>  automatically  includes  the  header  file
88        <B>&lt;curses.h&gt;</B>.
89
90
91 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
92        These routines emulate the  System  V  menu  library.   They  were  not
93        supported on Version 7 or BSD versions.
94
95
96 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
97        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
98        Raymond.
99
100
101
102                                                                <B><A HREF="mitem_value.3X.html">mitem_value(3X)</A></B>
103 </PRE>
104 <div class="nav">
105 <ul>
106 <li><a href="#h2-NAME">NAME</a></li>
107 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
108 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
109 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
110 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
111 <li><a href="#h2-NOTES">NOTES</a></li>
112 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
113 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
114 </ul>
115 </div>
116 </BODY>
117 </HTML>