1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
4 ****************************************************************************
5 * Copyright (c) 1998-2007,2010 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.12 2010/12/04 18:40:45 tom 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 -->
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>
51 <STRONG>menu_opts</STRONG> - set and get menu options
55 <H2>SYNOPSIS</H2><PRE>
56 <STRONG>#include</STRONG> <STRONG><menu.h></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);
64 <H2>DESCRIPTION</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
69 The function <STRONG>menu_opts_on</STRONG> turns on the given option bits,
70 and leaves others alone.
72 The function <STRONG>menu_opts_off</STRONG> turns off the given option
73 bits, and leaves others alone.
75 The function <STRONG>menu_opts</STRONG> returns the menu's current option
78 The following options are defined (all are on by default):
81 Only one item can be selected for this menu.
84 Display the item descriptions when the menu is
88 Display the menu in row-major order.
91 Ignore the case when pattern-matching.
94 Move the cursor to within the item name while pat-
98 Don't wrap around next-item and previous-item,
99 requests to the other end of the menu.
103 <H2>RETURN VALUE</H2><PRE>
104 Except for <STRONG>menu_opts</STRONG>, each routine returns one of the fol-
107 <STRONG>E_OK</STRONG> The routine succeeded.
109 <STRONG>E_SYSTEM_ERROR</STRONG>
110 System error occurred (see <STRONG>errno</STRONG>).
112 <STRONG>E_POSTED</STRONG>
113 The menu is already posted.
117 <H2>SEE ALSO</H2><PRE>
118 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
123 The header file <STRONG><menu.h></STRONG> automatically includes the header
124 file <STRONG><curses.h></STRONG>.
128 <H2>PORTABILITY</H2><PRE>
129 These routines emulate the System V menu library. They
130 were not supported on Version 7 or BSD versions.
134 <H2>AUTHORS</H2><PRE>
135 Juergen Pfeifer. Manual pages and adaptation for new
136 curses by Eric S. Raymond.
140 <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
144 Man(1) output converted with
145 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>