| 1 |
.\"*************************************************************************** |
| 2 |
.\" Copyright 2018-2024,2025 Thomas E. Dickey * |
| 3 |
.\" Copyright 1998-2015,2016 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.38 2025/01/19 00:51:10 tom Exp $ |
| 31 |
.TH opts 3MENU 2025-01-18 "ncurses 6.6" "Library calls" |
| 32 |
.ie \n(.g \{\ |
| 33 |
.ds `` \(lq |
| 34 |
.ds '' \(rq |
| 35 |
.\} |
| 36 |
.el \{\ |
| 37 |
.ie t .ds `` `` |
| 38 |
.el .ds `` "" |
| 39 |
.ie t .ds '' '' |
| 40 |
.el .ds '' "" |
| 41 |
.\} |
| 42 |
.SH NAME |
| 43 |
\fBset_menu_opts\fP, |
| 44 |
\fBmenu_opts_on\fP, |
| 45 |
\fBmenu_opts_off\fP, |
| 46 |
\fBmenu_opts\fP \- |
| 47 |
set and get menu options |
| 48 |
.SH SYNOPSIS |
| 49 |
.nf |
| 50 |
\fB#include <menu.h> |
| 51 |
.PP |
| 52 |
\fBint set_menu_opts(MENU *\fImenu\fP, Menu_Options \fIopts\fP); |
| 53 |
\fBMenu_Options menu_opts(const MENU *\fImenu\fP); |
| 54 |
.PP |
| 55 |
\fBint menu_opts_on(MENU *\fImenu\fP, Menu_Options \fIopts\fP); |
| 56 |
\fBint menu_opts_off(MENU *\fImenu\fP, Menu_Options \fIopts\fP); |
| 57 |
.fi |
| 58 |
.SH DESCRIPTION |
| 59 |
The function \fBset_menu_opts\fP sets all the given menu's option bits |
| 60 |
(menu option bits may be logically \*(``or\*(''-ed together). |
| 61 |
.PP |
| 62 |
The function \fBmenu_opts_on\fP turns on the given option bits, and leaves |
| 63 |
others alone. |
| 64 |
.PP |
| 65 |
The function \fBmenu_opts_off\fP turns off the given option bits, and leaves |
| 66 |
others alone. |
| 67 |
.PP |
| 68 |
The function \fBmenu_opts\fP returns the menu's current option bits. |
| 69 |
.PP |
| 70 |
The following options are defined (all are on by default): |
| 71 |
.TP 5 |
| 72 |
O_ONEVALUE |
| 73 |
Only one item can be selected for this menu. |
| 74 |
.TP 5 |
| 75 |
O_SHOWDESC |
| 76 |
Display the item descriptions when the menu is posted. |
| 77 |
.TP 5 |
| 78 |
O_ROWMAJOR |
| 79 |
Display the menu in row-major order. |
| 80 |
.TP 5 |
| 81 |
O_IGNORECASE |
| 82 |
Ignore the case when pattern-matching. |
| 83 |
.TP 5 |
| 84 |
O_SHOWMATCH |
| 85 |
Move the cursor to within the item name while pattern-matching. |
| 86 |
.TP 5 |
| 87 |
O_NONCYCLIC |
| 88 |
Don't wrap around next-item and previous-item, |
| 89 |
requests to the other end of the menu. |
| 90 |
.TP 5 |
| 91 |
O_MOUSE_MENU |
| 92 |
If user clicks with the mouse |
| 93 |
and it does not fall on the currently active menu, |
| 94 |
push \fBKEY_MOUSE\fP and the \fBMEVENT\fP data |
| 95 |
back on the queue to allow processing in another part of the calling program. |
| 96 |
.SH RETURN VALUE |
| 97 |
Except for \fBmenu_opts\fP, each routine returns one of the following: |
| 98 |
.TP 5 |
| 99 |
.B E_OK |
| 100 |
The routine succeeded. |
| 101 |
.TP 5 |
| 102 |
.B E_SYSTEM_ERROR |
| 103 |
System error occurred (see \fBerrno\fP(3)). |
| 104 |
.TP 5 |
| 105 |
.B E_POSTED |
| 106 |
The menu is already posted. |
| 107 |
.SH PORTABILITY |
| 108 |
These routines emulate the System V menu library. |
| 109 |
They were not supported on |
| 110 |
Version 7 or BSD versions. |
| 111 |
.SH AUTHORS |
| 112 |
Juergen Pfeifer. |
| 113 |
Manual pages and adaptation for new curses by Eric S. Raymond. |
| 114 |
.SH SEE ALSO |
| 115 |
\fB\%ncurses\fP(3NCURSES), |
| 116 |
\fB\%menu\fP(3MENU) |