ncurses 6.0 - patch 20151024
[ncurses.git] / doc / html / man / menu_opts.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2007,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: menu_opts.3x,v 1.12 2010/12/04 18:40:45 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 http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_opts 3x</TITLE>
38 <link rev=made 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">menu_opts 3x</H1>
43 <PRE>
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
46
47
48
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>menu_opts</STRONG> - set and get menu options
52
53
54 </PRE>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        int set_menu_opts(MENU *menu, Menu_Options opts);
58        int menu_opts_on(MENU *menu, Menu_Options opts);
59        int menu_opts_off(MENU *menu, Menu_Options opts);
60        Menu_Options menu_opts(const MENU *menu);
61
62
63 </PRE>
64 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
65        The  function  <STRONG>set_menu_opts</STRONG>  sets  all  the  given menu's
66        option bits  (menu  option  bits  may  be  logically-OR'ed
67        together).
68
69        The  function <STRONG>menu_opts_on</STRONG> turns on the given option bits,
70        and leaves others alone.
71
72        The function <STRONG>menu_opts_off</STRONG>  turns  off  the  given  option
73        bits, and leaves others alone.
74
75        The  function  <STRONG>menu_opts</STRONG> returns the menu's current option
76        bits.
77
78        The following options are defined (all are on by default):
79
80        O_ONEVALUE
81             Only one item can be selected for this menu.
82
83        O_SHOWDESC
84             Display  the  item  descriptions  when  the  menu  is
85             posted.
86
87        O_ROWMAJOR
88             Display the menu in row-major order.
89
90        O_IGNORECASE
91             Ignore the case when pattern-matching.
92
93        O_SHOWMATCH
94             Move  the  cursor  to within the item name while pat-
95             tern-matching.
96
97        O_NONCYCLIC
98             Don't  wrap  around  next-item   and   previous-item,
99             requests to the other end of the menu.
100
101
102 </PRE>
103 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
104        Except for <STRONG>menu_opts</STRONG>, each routine returns one of the fol-
105        lowing:
106
107        <STRONG>E_OK</STRONG> The routine succeeded.
108
109        <STRONG>E_SYSTEM_ERROR</STRONG>
110             System error occurred (see <STRONG>errno</STRONG>).
111
112        <STRONG>E_POSTED</STRONG>
113             The menu is already posted.
114
115
116 </PRE>
117 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
118        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
119
120
121 </PRE>
122 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
123        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
124        file <STRONG>&lt;curses.h&gt;</STRONG>.
125
126
127 </PRE>
128 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
129        These  routines  emulate  the System V menu library.  They
130        were not supported on Version 7 or BSD versions.
131
132
133 </PRE>
134 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
135        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
136        curses by Eric S. Raymond.
137
138
139
140                                                           <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
141 </PRE>
142 <div class="nav">
143 <ul>
144 <li><a href="#h2-NAME">NAME</a></li>
145 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
146 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
147 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
148 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
149 <li><a href="#h2-NOTES">NOTES</a></li>
150 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
151 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
152 </ul>
153 </div>
154 </BODY>
155 </HTML>