3 ****************************************************************************
4 * Copyright 2018-2019,2020 Thomas E. Dickey *
5 * Copyright 1998-2015,2016 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.18 2020/10/17 23:46:35 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>menu_opts 3X</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
43 <H1 class="no-header">menu_opts 3X</H1>
45 <B><A HREF="menu_opts.3X.html">menu_opts(3X)</A></B> <B><A HREF="menu_opts.3X.html">menu_opts(3X)</A></B>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <B>set_menu_opts</B>, <B>menu_opts_on</B>, <B>menu_opts_off</B>, <B>menu_opts</B> - set and get
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <B>#include</B> <B><menu.h></B>
58 <B>int</B> <B>set_menu_opts(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>Menu_Options</B> <I>opts</I><B>);</B>
59 <B>Menu_Options</B> <B>menu_opts(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
61 <B>int</B> <B>menu_opts_on(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>Menu_Options</B> <I>opts</I><B>);</B>
62 <B>int</B> <B>menu_opts_off(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>Menu_Options</B> <I>opts</I><B>);</B>
65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66 The function <B>set_menu_opts</B> sets all the given menu's option bits (menu
67 option bits may be logically-OR'ed together).
69 The function <B>menu_opts_on</B> turns on the given option bits, and leaves
72 The function <B>menu_opts_off</B> turns off the given option bits, and leaves
75 The function <B>menu_opts</B> returns the menu's current option bits.
77 The following options are defined (all are on by default):
80 Only one item can be selected for this menu.
83 Display the item descriptions when the menu is posted.
86 Display the menu in row-major order.
89 Ignore the case when pattern-matching.
92 Move the cursor to within the item name while pattern-matching.
95 Don't wrap around next-item and previous-item, requests to the
96 other end of the menu.
99 If user clicks with the mouse and it does not fall on the
100 currently active menu, push <B>KEY_MOUSE</B> and the <B>MEVENT</B> data back on
101 the queue to allow processing in another part of the calling
105 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
106 Except for <B>menu_opts</B>, each routine returns one of the following:
108 <B>E_OK</B> The routine succeeded.
110 <B>E_SYSTEM_ERROR</B>
111 System error occurred (see <B>errno(3)</B>).
114 The menu is already posted.
117 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
118 <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
121 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
122 The header file <B><menu.h></B> automatically includes the header file
123 <B><curses.h></B>.
126 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
127 These routines emulate the System V menu library. They were not
128 supported on Version 7 or BSD versions.
131 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
132 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
137 <B><A HREF="menu_opts.3X.html">menu_opts(3X)</A></B>
141 <li><a href="#h2-NAME">NAME</a></li>
142 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
143 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
144 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
145 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
146 <li><a href="#h2-NOTES">NOTES</a></li>
147 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
148 <li><a href="#h2-AUTHORS">AUTHORS</a></li>