ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / menu_opts.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2015 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.13 2015/12/05 23:42:45 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 http://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>
50 <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> -
52        set and get menu options
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
58        int set_menu_opts(MENU *menu, Menu_Options opts);
59        int menu_opts_on(MENU *menu, Menu_Options opts);
60        int menu_opts_off(MENU *menu, Menu_Options opts);
61        Menu_Options menu_opts(const MENU *menu);
62
63
64 </PRE>
65 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66        The function  <STRONG>set_menu_opts</STRONG>  sets  all  the  given  menu's
67        option  bits  (menu  option  bits  may  be logically-OR'ed
68        together).
69
70        The function <STRONG>menu_opts_on</STRONG> turns on the given option  bits,
71        and leaves others alone.
72
73        The  function  <STRONG>menu_opts_off</STRONG>  turns  off  the given option
74        bits, and leaves others alone.
75
76        The function <STRONG>menu_opts</STRONG> returns the menu's  current  option
77        bits.
78
79        The following options are defined (all are on by default):
80
81        O_ONEVALUE
82             Only one item can be selected for this menu.
83
84        O_SHOWDESC
85             Display  the  item  descriptions  when  the  menu  is
86             posted.
87
88        O_ROWMAJOR
89             Display the menu in row-major order.
90
91        O_IGNORECASE
92             Ignore the case when pattern-matching.
93
94        O_SHOWMATCH
95             Move the cursor to within the item  name  while  pat-
96             tern-matching.
97
98        O_NONCYCLIC
99             Don't   wrap   around  next-item  and  previous-item,
100             requests to the other end of the menu.
101
102
103 </PRE>
104 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
105        Except for <STRONG>menu_opts</STRONG>, each routine returns one of the fol-
106        lowing:
107
108        <STRONG>E_OK</STRONG> The routine succeeded.
109
110        <STRONG>E_SYSTEM_ERROR</STRONG>
111             System error occurred (see <STRONG>errno</STRONG>).
112
113        <STRONG>E_POSTED</STRONG>
114             The menu is already posted.
115
116
117 </PRE>
118 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
119        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
120
121
122 </PRE>
123 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
124        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
125        file <STRONG>&lt;curses.h&gt;</STRONG>.
126
127
128 </PRE>
129 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
130        These routines emulate the System V  menu  library.   They
131        were not supported on Version 7 or BSD versions.
132
133
134 </PRE>
135 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
136        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
137        curses by Eric S. Raymond.
138
139
140
141                                                           <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
142 </PRE>
143 <div class="nav">
144 <ul>
145 <li><a href="#h2-NAME">NAME</a></li>
146 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
147 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
148 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
149 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
150 <li><a href="#h2-NOTES">NOTES</a></li>
151 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
152 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
153 </ul>
154 </div>
155 </BODY>
156 </HTML>