ncurses 6.0 - patch 20180106
[ncurses.git] / doc / html / man / menu_opts.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2015,2016 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: menu_opts.3x,v 1.14 2016/03/26 22:42:41 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_opts 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">menu_opts 3x</H1>
43 <PRE>
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>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>set_menu_opts</STRONG>,  <STRONG>menu_opts_on</STRONG>,  <STRONG>menu_opts_off</STRONG>,  <STRONG>menu_opts</STRONG>  - set and get
51        menu options
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56        int set_menu_opts(MENU *menu, Menu_Options opts);
57        int menu_opts_on(MENU *menu, Menu_Options opts);
58        int menu_opts_off(MENU *menu, Menu_Options opts);
59        Menu_Options menu_opts(const MENU *menu);
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The function <STRONG>set_menu_opts</STRONG> sets all the given menu's option bits  (menu
64        option bits may be logically-OR'ed together).
65
66        The  function  <STRONG>menu_opts_on</STRONG>  turns on the given option bits, and leaves
67        others alone.
68
69        The function <STRONG>menu_opts_off</STRONG> turns off the given option bits, and  leaves
70        others alone.
71
72        The function <STRONG>menu_opts</STRONG> returns the menu's current option 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 posted.
81
82        O_ROWMAJOR
83             Display the menu in row-major order.
84
85        O_IGNORECASE
86             Ignore the case when pattern-matching.
87
88        O_SHOWMATCH
89             Move the cursor to within the item name while pattern-matching.
90
91        O_NONCYCLIC
92             Don't  wrap  around  next-item  and previous-item, requests to the
93             other end of the menu.
94
95        O_MOUSE_MENU
96             If user clicks with the mouse and it does not  fall  on  the  cur-
97             rently active menu, push <STRONG>KEY_MOUSE</STRONG> and the <STRONG>MEVENT</STRONG> data back on the
98             queue to allow processing in another part of the calling program.
99
100
101 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
102        Except for <STRONG>menu_opts</STRONG>, each routine returns one of the following:
103
104        <STRONG>E_OK</STRONG> The routine succeeded.
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><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
114        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
115
116
117 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
118        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
119        <STRONG>&lt;curses.h&gt;</STRONG>.
120
121
122 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
123        These  routines  emulate the System V menu library.  They were not sup-
124        ported on Version 7 or BSD versions.
125
126
127 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
128        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
129        Raymond.
130
131
132
133                                                                  <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
134 </PRE>
135 <div class="nav">
136 <ul>
137 <li><a href="#h2-NAME">NAME</a></li>
138 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
139 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
140 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
141 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
142 <li><a href="#h2-NOTES">NOTES</a></li>
143 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
144 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
145 </ul>
146 </div>
147 </BODY>
148 </HTML>