1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
4 ****************************************************************************
5 * Copyright (c) 1998 Free Software Foundation, Inc. *
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: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
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. *
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 *
30 ****************************************************************************
31 * @Id: menu_opts.3x,v 1.7 1998/11/29 01:10:21 Rick.Ohnemus Exp @
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">
43 <!-- Manpage converted by man2html 3.0.1 -->
47 <STRONG>menu_opts</STRONG> - set and get menu options
51 <H2>SYNOPSIS</H2><PRE>
52 <STRONG>#include</STRONG> <STRONG><menu.h></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);
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
65 The function <STRONG>menu_opts_on</STRONG> turns on the given option bits,
66 and leaves others alone.
68 The function <STRONG>menu_opts_off</STRONG> turns off the given option
69 bits, and leaves others alone.
71 The function <STRONG>menu_opts</STRONG> returns the menu's current option
74 The following options are defined (all are on by default):
77 Only one item can be selected for this menu.
80 Display the item descriptions when the menu is
84 Display the menu in row-major order.
87 Ignore the case when pattern-matching.
90 Move the cursor to within the item name while pat-
94 Don't wrap around next-item and previous-item,
95 requests to the other end of the menu.
99 <H2>RETURN VALUE</H2><PRE>
100 Except for <STRONG>menu_opts</STRONG>, each routine returns one of the fol-
103 <STRONG>E_OK</STRONG> The routine succeeded.
106 <STRONG>E_SYSTEM_ERROR</STRONG>
107 System error occurred (see <STRONG>errno</STRONG>).
109 <STRONG>E_POSTED</STRONG>
110 The menu is already posted.
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>.
120 The header file <STRONG><menu.h></STRONG> automatically includes the header
121 file <STRONG><curses.h></STRONG>.
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.
131 <H2>AUTHORS</H2><PRE>
132 Juergen Pfeifer. Manual pages and adaptation for new
133 curses by Eric S. Raymond.
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>