ncurses 6.0 - patch 20151205
[ncurses.git] / man / menu_opts.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: menu_opts.3x,v 1.13 2015/12/05 23:42:45 tom Exp $
31 .TH menu_opts 3X ""
32 .SH NAME
33 \fBset_menu_opts\fP,
34 \fBmenu_opts_on\fP,
35 \fBmenu_opts_off\fP,
36 \fBmenu_opts\fR \- set and get menu options
37 .SH SYNOPSIS
38 \fB#include <menu.h>\fR
39 .br
40 int set_menu_opts(MENU *menu, Menu_Options opts);
41 .br
42 int menu_opts_on(MENU *menu, Menu_Options opts);
43 .br
44 int menu_opts_off(MENU *menu, Menu_Options opts);
45 .br
46 Menu_Options menu_opts(const MENU *menu);
47 .br
48 .SH DESCRIPTION
49 The function \fBset_menu_opts\fR sets all the given menu's option bits (menu
50 option bits may be logically-OR'ed together).
51 .PP
52 The function \fBmenu_opts_on\fR turns on the given option bits, and leaves
53 others alone.
54 .PP
55 The function \fBmenu_opts_off\fR turns off the given option bits, and leaves
56 others alone.
57 .PP
58 The function \fBmenu_opts\fR returns the menu's current option bits.
59 .PP
60 The following options are defined (all are on by default):
61 .TP 5
62 O_ONEVALUE
63 Only one item can be selected for this menu.
64 .TP 5
65 O_SHOWDESC
66 Display the item descriptions when the menu is posted.
67 .TP 5
68 O_ROWMAJOR
69 Display the menu in row-major order.
70 .TP 5
71 O_IGNORECASE
72 Ignore the case when pattern-matching.
73 .TP 5
74 O_SHOWMATCH
75 Move the cursor to within the item name while pattern-matching.
76 .TP 5
77 O_NONCYCLIC
78 Don't wrap around next-item and previous-item,
79 requests to the other end of the menu.
80 .SH RETURN VALUE
81 Except for \fBmenu_opts\fR, each routine returns one of the following:
82 .TP 5
83 .B E_OK
84 The routine succeeded.
85 .TP 5
86 .B E_SYSTEM_ERROR
87 System error occurred (see \fBerrno\fR).
88 .TP 5
89 .B E_POSTED
90 The menu is already posted.
91 .SH SEE ALSO
92 \fBcurses\fR(3X), \fBmenu\fR(3X).
93 .SH NOTES
94 The header file \fB<menu.h>\fR automatically includes the header file
95 \fB<curses.h>\fR.
96 .SH PORTABILITY
97 These routines emulate the System V menu library.  They were not supported on
98 Version 7 or BSD versions.
99 .SH AUTHORS
100 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
101 S. Raymond.