ncurses 6.2 - patch 20210116
[ncurses.git] / doc / html / man / menu_opts.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2015,2016 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.18 2020/10/17 23:46:35 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
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">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">menu_opts 3x</H1>
44 <PRE>
45 <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>                                                    <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>set_menu_opts</STRONG>,  <STRONG>menu_opts_on</STRONG>,  <STRONG>menu_opts_off</STRONG>,  <STRONG>menu_opts</STRONG>  - set and get
52        menu options
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57
58        <STRONG>int</STRONG> <STRONG>set_menu_opts(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
59        <STRONG>Menu_Options</STRONG> <STRONG>menu_opts(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
60
61        <STRONG>int</STRONG> <STRONG>menu_opts_on(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
62        <STRONG>int</STRONG> <STRONG>menu_opts_off(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
63
64
65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66        The function <STRONG>set_menu_opts</STRONG> sets all the given menu's option bits  (menu
67        option bits may be logically-OR'ed together).
68
69        The  function  <STRONG>menu_opts_on</STRONG>  turns on the given option bits, and leaves
70        others alone.
71
72        The function <STRONG>menu_opts_off</STRONG> turns off the given option bits, and  leaves
73        others alone.
74
75        The function <STRONG>menu_opts</STRONG> returns the menu's current option bits.
76
77        The following options are defined (all are on by default):
78
79        O_ONEVALUE
80             Only one item can be selected for this menu.
81
82        O_SHOWDESC
83             Display the item descriptions when the menu is posted.
84
85        O_ROWMAJOR
86             Display the menu in row-major order.
87
88        O_IGNORECASE
89             Ignore the case when pattern-matching.
90
91        O_SHOWMATCH
92             Move the cursor to within the item name while pattern-matching.
93
94        O_NONCYCLIC
95             Don't  wrap  around  next-item  and previous-item, requests to the
96             other end of the menu.
97
98        O_MOUSE_MENU
99             If user clicks with the mouse and it does not  fall  on  the  cur-
100             rently active menu, push <STRONG>KEY_MOUSE</STRONG> and the <STRONG>MEVENT</STRONG> data back on the
101             queue to allow processing in another part of the calling program.
102
103
104 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
105        Except for <STRONG>menu_opts</STRONG>, each routine returns one of the following:
106
107        <STRONG>E_OK</STRONG> The routine succeeded.
108
109        <STRONG>E_SYSTEM_ERROR</STRONG>
110             System error occurred (see <STRONG>errno(3)</STRONG>).
111
112        <STRONG>E_POSTED</STRONG>
113             The menu is already posted.
114
115
116 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
117        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
118
119
120 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
121        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
122        <STRONG>&lt;curses.h&gt;</STRONG>.
123
124
125 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
126        These  routines  emulate the System V menu library.  They were not sup-
127        ported on Version 7 or BSD versions.
128
129
130 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
131        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
132        Raymond.
133
134
135
136                                                                  <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
137 </PRE>
138 <div class="nav">
139 <ul>
140 <li><a href="#h2-NAME">NAME</a></li>
141 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
142 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
143 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
144 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
145 <li><a href="#h2-NOTES">NOTES</a></li>
146 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
147 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
148 </ul>
149 </div>
150 </BODY>
151 </HTML>