xref: /freebsd/contrib/ncurses/man/menu_opts.3x (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
t
***************************************************************************
Copyright (c) 1998 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: menu_opts.3x,v 1.7 1998/11/29 01:10:21 Rick.Ohnemus Exp $
menu_opts 3X ""
NAME
menu_opts - set and get menu options
SYNOPSIS
#include <menu.h>

int set_menu_opts(MENU *menu, OPTIONS opts);

int menu_opts_on(MENU *menu, OPTIONS opts);

int menu_opts_off(MENU *menu, OPTIONS opts);

OPTIONS menu_opts(const MENU *menu);

DESCRIPTION
The function set_menu_opts sets all the given menu's option bits (menu option bits may be logically-OR'ed together). The function menu_opts_on turns on the given option bits, and leaves others alone. The function menu_opts_off turns off the given option bits, and leaves others alone. The function menu_opts returns the menu's current option bits. The following options are defined (all are on by default):

5 O_ONEVALUE Only one item can be selected for this menu.

5 O_SHOWDESC Display the item descriptions when the menu is posted.

5 O_ROWMAJOR Display the menu in row-major order.

5 O_IGNORECASE Ignore the case when pattern-matching.

5 O_SHOWMATCH Move the cursor to within the item name while pattern-matching.

5 O_NONCYCLIC Don't wrap around next-item and previous-item, requests to the other end of the menu.

RETURN VALUE
Except for menu_opts, each routine returns one of the following:

5 E_OK The routine succeeded.

5 E_SYSTEM_ERROR System error occurred (see errno).

5 E_POSTED The menu is already posted.

SEE ALSO
curses(3X), menu(3X).
NOTES
The header file <menu.h> automatically includes the header file <curses.h>.
PORTABILITY
These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. #
# The following sets edit modes for GNU EMACS
# Local Variables:
# mode:nroff
# fill-column:79
# End: