ncurses 5.3
[ncurses.git] / doc / html / man / menu_opts.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 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.7 1998/11/29 01:10:21 Rick.Ohnemus 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
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>menu_opts</STRONG> - set and get menu options
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
53        int set_menu_opts(MENU *menu, OPTIONS opts);
54        int menu_opts_on(MENU *menu, OPTIONS opts);
55        int menu_opts_off(MENU *menu, OPTIONS opts);
56        OPTIONS menu_opts(const MENU *menu);
57
58
59 </PRE>
60 <H2>DESCRIPTION</H2><PRE>
61        The  function  <STRONG>set_menu_opts</STRONG>  sets  all  the  given menu's
62        option bits  (menu  option  bits  may  be  logically-OR'ed
63        together).
64
65        The  function <STRONG>menu_opts_on</STRONG> turns on the given option bits,
66        and leaves others alone.
67
68        The function <STRONG>menu_opts_off</STRONG>  turns  off  the  given  option
69        bits, and leaves others alone.
70
71        The  function  <STRONG>menu_opts</STRONG> returns the menu's current option
72        bits.
73
74        The following options are defined (all are on by default):
75
76        O_ONEVALUE
77             Only one item can be selected for this menu.
78
79        O_SHOWDESC
80             Display  the  item  descriptions  when  the  menu  is
81             posted.
82
83        O_ROWMAJOR
84             Display the menu in row-major order.
85
86        O_IGNORECASE
87             Ignore the case when pattern-matching.
88
89        O_SHOWMATCH
90             Move the cursor to within the item  name  while  pat-
91             tern-matching.
92
93        O_NONCYCLIC
94             Don't   wrap   around  next-item  and  previous-item,
95             requests to the other end of the menu.
96
97
98 </PRE>
99 <H2>RETURN VALUE</H2><PRE>
100        Except for <STRONG>menu_opts</STRONG>, each routine returns one of the fol-
101        lowing:
102
103        <STRONG>E_OK</STRONG> The routine succeeded.
104
105
106        <STRONG>E_SYSTEM_ERROR</STRONG>
107             System error occurred (see <STRONG>errno</STRONG>).
108
109        <STRONG>E_POSTED</STRONG>
110             The menu is already posted.
111
112
113 </PRE>
114 <H2>SEE ALSO</H2><PRE>
115        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
116
117
118 </PRE>
119 <H2>NOTES</H2><PRE>
120        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
121        file <STRONG>&lt;curses.h&gt;</STRONG>.
122
123
124 </PRE>
125 <H2>PORTABILITY</H2><PRE>
126        These routines emulate the System V  menu  library.   They
127        were not supported on Version 7 or BSD versions.
128
129
130 </PRE>
131 <H2>AUTHORS</H2><PRE>
132        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
133        curses by Eric S. Raymond.
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>