menu_opts.3x.html 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  2. <!--
  3. * t
  4. ****************************************************************************
  5. * Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. *
  6. * *
  7. * Permission is hereby granted, free of charge, to any person obtaining a *
  8. * copy of this software and associated documentation files (the *
  9. * "Software"), to deal in the Software without restriction, including *
  10. * without limitation the rights to use, copy, modify, merge, publish, *
  11. * distribute, distribute with modifications, sublicense, and/or sell *
  12. * copies of the Software, and to permit persons to whom the Software is *
  13. * furnished to do so, subject to the following conditions: *
  14. * *
  15. * The above copyright notice and this permission notice shall be included *
  16. * in all copies or substantial portions of the Software. *
  17. * *
  18. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
  19. * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
  20. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
  21. * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
  22. * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
  23. * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
  24. * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
  25. * *
  26. * Except as contained in this notice, the name(s) of the above copyright *
  27. * holders shall not be used in advertising or otherwise to promote the *
  28. * sale, use or other dealings in this Software without prior written *
  29. * authorization. *
  30. ****************************************************************************
  31. * @Id: menu_opts.3x,v 1.10 2007/02/24 17:33:59 tom Exp @
  32. -->
  33. <HTML>
  34. <HEAD>
  35. <TITLE>menu_opts 3x</TITLE>
  36. <link rev=made href="mailto:bug-ncurses@gnu.org">
  37. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  38. </HEAD>
  39. <BODY>
  40. <H1>menu_opts 3x</H1>
  41. <HR>
  42. <PRE>
  43. <!-- Manpage converted by man2html 3.0.1 -->
  44. <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG> <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
  45. </PRE>
  46. <H2>NAME</H2><PRE>
  47. <STRONG>menu_opts</STRONG> - set and get menu options
  48. </PRE>
  49. <H2>SYNOPSIS</H2><PRE>
  50. <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  51. int set_menu_opts(MENU *menu, Menu_Options opts);
  52. int menu_opts_on(MENU *menu, Menu_Options opts);
  53. int menu_opts_off(MENU *menu, Menu_Options opts);
  54. Menu_Options menu_opts(const MENU *menu);
  55. </PRE>
  56. <H2>DESCRIPTION</H2><PRE>
  57. The function <STRONG>set_menu_opts</STRONG> sets all the given menu's
  58. option bits (menu option bits may be logically-OR'ed
  59. together).
  60. The function <STRONG>menu_opts_on</STRONG> turns on the given option bits,
  61. and leaves others alone.
  62. The function <STRONG>menu_opts_off</STRONG> turns off the given option
  63. bits, and leaves others alone.
  64. The function <STRONG>menu_opts</STRONG> returns the menu's current option
  65. bits.
  66. The following options are defined (all are on by default):
  67. O_ONEVALUE
  68. Only one item can be selected for this menu.
  69. O_SHOWDESC
  70. Display the item descriptions when the menu is
  71. posted.
  72. O_ROWMAJOR
  73. Display the menu in row-major order.
  74. O_IGNORECASE
  75. Ignore the case when pattern-matching.
  76. O_SHOWMATCH
  77. Move the cursor to within the item name while pat-
  78. tern-matching.
  79. O_NONCYCLIC
  80. Don't wrap around next-item and previous-item,
  81. requests to the other end of the menu.
  82. </PRE>
  83. <H2>RETURN VALUE</H2><PRE>
  84. Except for <STRONG>menu_opts</STRONG>, each routine returns one of the fol-
  85. lowing:
  86. <STRONG>E_OK</STRONG> The routine succeeded.
  87. <STRONG>E_SYSTEM_ERROR</STRONG>
  88. System error occurred (see <STRONG>errno</STRONG>).
  89. <STRONG>E_POSTED</STRONG>
  90. The menu is already posted.
  91. </PRE>
  92. <H2>SEE ALSO</H2><PRE>
  93. <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
  94. </PRE>
  95. <H2>NOTES</H2><PRE>
  96. The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
  97. file <STRONG>&lt;curses.h&gt;</STRONG>.
  98. </PRE>
  99. <H2>PORTABILITY</H2><PRE>
  100. These routines emulate the System V menu library. They
  101. were not supported on Version 7 or BSD versions.
  102. </PRE>
  103. <H2>AUTHORS</H2><PRE>
  104. Juergen Pfeifer. Manual pages and adaptation for new
  105. curses by Eric S. Raymond.
  106. <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
  107. </PRE>
  108. <HR>
  109. <ADDRESS>
  110. Man(1) output converted with
  111. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  112. </ADDRESS>
  113. </BODY>
  114. </HTML>