doc/html/man/mitem_value.3x.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 1998-2006,2010 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.10 2010/12/04 18:40:45 tom Exp @
  31 -->
  32 <HTML>
  33 <HEAD>
  34 <TITLE>mitem_value 3x</TITLE>
  35 <link rev=made href="mailto:bug-ncurses@gnu.org">
  36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  37 </HEAD>
  38 <BODY>
  39 <H1>mitem_value 3x</H1>
  40 <HR>
  41 <PRE>
  42 <!-- Manpage converted by man2html 3.0.1 -->
  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>
  44
  45
  46
  47
  48 </PRE>
  49 <H2>NAME</H2><PRE>
  50        <STRONG>mitem_value</STRONG> - set and get menu item values
  51
  52
  53 </PRE>
  54 <H2>SYNOPSIS</H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  56        int set_item_value(ITEM *item, bool value);
  57        bool item_value(const ITEM *item);
  58
  59
  60 </PRE>
  61 <H2>DESCRIPTION</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.
  66
  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>).
  70
  71
  72 </PRE>
  73 <H2>RETURN VALUE</H2><PRE>
  74        The function <STRONG>set_item_value</STRONG> returns one of the following:
  75
  76        <STRONG>E_OK</STRONG> The routine succeeded.
  77
  78        <STRONG>E_SYSTEM_ERROR</STRONG>
  79             System error occurred (see <STRONG>errno</STRONG>).
  80
  81        <STRONG>E_REQUEST_DENIED</STRONG>
  82             The menu driver could not process the request.
  83
  84
  85 </PRE>
  86 <H2>SEE ALSO</H2><PRE>
  87        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
  88
  89
  90 </PRE>
  91 <H2>NOTES</H2><PRE>
  92        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
  93        file <STRONG>&lt;curses.h&gt;</STRONG>.
  94
  95
  96 </PRE>
  97 <H2>PORTABILITY</H2><PRE>
  98        These  routines  emulate  the System V menu library.  They
  99        were not supported on Version 7 or BSD versions.
 100
 101
 102 </PRE>
 103 <H2>AUTHORS</H2><PRE>
 104        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
 105        curses by Eric S. Raymond.
 106
 107
 108
 109                                                         <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG>
 110 </PRE>
 111 <HR>
 112 <ADDRESS>
 113 Man(1) output converted with
 114 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 115 </ADDRESS>
 116 </BODY>
 117 </HTML>