mitem_value.3x.html 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  2. <!--
  3. ****************************************************************************
  4. * Copyright (c) 1998-2002,2006 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.8 2006/11/04 17:12:00 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. </PRE>
  45. <H2>NAME</H2><PRE>
  46. <STRONG>mitem_value</STRONG> - set and get menu item values
  47. </PRE>
  48. <H2>SYNOPSIS</H2><PRE>
  49. <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  50. int set_item_value(ITEM *item, bool value);
  51. bool item_value(const ITEM *item);
  52. </PRE>
  53. <H2>DESCRIPTION</H2><PRE>
  54. If you turn off the menu option <STRONG>O_ONEVALUE</STRONG> (e.g., with
  55. <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
  56. menu becomes multi-valued; that is, more than one item may
  57. simultaneously be selected.
  58. In a multi_valued menu, you can used <STRONG>set_item_value</STRONG> to
  59. select the given menu item (second argument <STRONG>TRUE</STRONG>) or dese-
  60. lect it (second argument <STRONG>FALSE</STRONG>).
  61. </PRE>
  62. <H2>RETURN VALUE</H2><PRE>
  63. The function <STRONG>set_item_value</STRONG> returns one of the following:
  64. <STRONG>E_OK</STRONG> The routine succeeded.
  65. <STRONG>E_SYSTEM_ERROR</STRONG>
  66. System error occurred (see <STRONG>errno</STRONG>).
  67. <STRONG>E_REQUEST_DENIED</STRONG>
  68. The menu driver could not process the request.
  69. </PRE>
  70. <H2>SEE ALSO</H2><PRE>
  71. <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
  72. </PRE>
  73. <H2>NOTES</H2><PRE>
  74. The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
  75. file <STRONG>&lt;curses.h&gt;</STRONG>.
  76. </PRE>
  77. <H2>PORTABILITY</H2><PRE>
  78. These routines emulate the System V menu library. They
  79. were not supported on Version 7 or BSD versions.
  80. </PRE>
  81. <H2>AUTHORS</H2><PRE>
  82. Juergen Pfeifer. Manual pages and adaptation for new
  83. curses by Eric S. Raymond.
  84. <STRONG><A HREF="mitem_value.3x.html">mitem_value(3x)</A></STRONG>
  85. </PRE>
  86. <HR>
  87. <ADDRESS>
  88. Man(1) output converted with
  89. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  90. </ADDRESS>
  91. </BODY>
  92. </HTML>