| 1 | '\" t
|
|---|
| 2 | .\"***************************************************************************
|
|---|
| 3 | .\" Copyright (c) 1998 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.7 1998/11/29 01:10:21 Rick.Ohnemus Exp $
|
|---|
| 31 | .TH menu_opts 3X ""
|
|---|
| 32 | .SH NAME
|
|---|
| 33 | \fBmenu_opts\fR - set and get menu options
|
|---|
| 34 | .SH SYNOPSIS
|
|---|
| 35 | \fB#include <menu.h>\fR
|
|---|
| 36 | .br
|
|---|
| 37 | int set_menu_opts(MENU *menu, OPTIONS opts);
|
|---|
| 38 | .br
|
|---|
| 39 | int menu_opts_on(MENU *menu, OPTIONS opts);
|
|---|
| 40 | .br
|
|---|
| 41 | int menu_opts_off(MENU *menu, OPTIONS opts);
|
|---|
| 42 | .br
|
|---|
| 43 | OPTIONS menu_opts(const MENU *menu);
|
|---|
| 44 | .br
|
|---|
| 45 | .SH DESCRIPTION
|
|---|
| 46 | The function \fBset_menu_opts\fR sets all the given menu's option bits (menu
|
|---|
| 47 | option bits may be logically-OR'ed together).
|
|---|
| 48 |
|
|---|
| 49 | The function \fBmenu_opts_on\fR turns on the given option bits, and leaves
|
|---|
| 50 | others alone.
|
|---|
| 51 |
|
|---|
| 52 | The function \fBmenu_opts_off\fR turns off the given option bits, and leaves
|
|---|
| 53 | others alone.
|
|---|
| 54 |
|
|---|
| 55 | The function \fBmenu_opts\fR returns the menu's current option bits.
|
|---|
| 56 |
|
|---|
| 57 | The following options are defined (all are on by default):
|
|---|
| 58 | .TP 5
|
|---|
| 59 | O_ONEVALUE
|
|---|
| 60 | Only one item can be selected for this menu.
|
|---|
| 61 | .TP 5
|
|---|
| 62 | O_SHOWDESC
|
|---|
| 63 | Display the item descriptions when the menu is posted.
|
|---|
| 64 | .TP 5
|
|---|
| 65 | O_ROWMAJOR
|
|---|
| 66 | Display the menu in row-major order.
|
|---|
| 67 | .TP 5
|
|---|
| 68 | O_IGNORECASE
|
|---|
| 69 | Ignore the case when pattern-matching.
|
|---|
| 70 | .TP 5
|
|---|
| 71 | O_SHOWMATCH
|
|---|
| 72 | Move the cursor to within the item name while pattern-matching.
|
|---|
| 73 | .TP 5
|
|---|
| 74 | O_NONCYCLIC
|
|---|
| 75 | Don't wrap around next-item and previous-item,
|
|---|
| 76 | requests to the other end of the menu.
|
|---|
| 77 | .SH RETURN VALUE
|
|---|
| 78 | Except for \fBmenu_opts\fR, each routine returns one of the following:
|
|---|
| 79 | .TP 5
|
|---|
| 80 | \fBE_OK\fR
|
|---|
| 81 | The routine succeeded.
|
|---|
| 82 | .TP 5
|
|---|
| 83 | \fBE_SYSTEM_ERROR\fR
|
|---|
| 84 | System error occurred (see \fBerrno\fR).
|
|---|
| 85 | .TP 5
|
|---|
| 86 | \fBE_POSTED\fR
|
|---|
| 87 | The menu is already posted.
|
|---|
| 88 | .SH SEE ALSO
|
|---|
| 89 | \fBcurses\fR(3X), \fBmenu\fR(3X).
|
|---|
| 90 | .SH NOTES
|
|---|
| 91 | The header file \fB<menu.h>\fR automatically includes the header file
|
|---|
| 92 | \fB<curses.h>\fR.
|
|---|
| 93 | .SH PORTABILITY
|
|---|
| 94 | These routines emulate the System V menu library. They were not supported on
|
|---|
| 95 | Version 7 or BSD versions.
|
|---|
| 96 | .SH AUTHORS
|
|---|
| 97 | Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
|
|---|
| 98 | S. Raymond.
|
|---|
| 99 | .\"#
|
|---|
| 100 | .\"# The following sets edit modes for GNU EMACS
|
|---|
| 101 | .\"# Local Variables:
|
|---|
| 102 | .\"# mode:nroff
|
|---|
| 103 | .\"# fill-column:79
|
|---|
| 104 | .\"# End:
|
|---|
