xref: /illumos-gate/usr/src/man/man3curses/menu_opts.3curses (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
MENU_OPTS 3CURSES "Dec 31, 1996"
NAME
menu_opts, set_menu_opts, menu_opts_on, menu_opts_off - menus option routines
SYNOPSIS

cc [ flag... ] file... -lmenu  -lcurses  [ library... ]
#include <menu.h>

OPTIONS menu_opts(MENU *menu);

int set_menu_opts(MENU *menu, OPTIONS opts);

int menu_opts_on(MENU *menu, OPTIONS opts);

int menu_opts_off(MENU *menu, OPTIONS opts);
DESCRIPTION
"Menu Options"

set_menu_opts() turns on the named options for menu and turns off all other options. Options are boolean values that can be OR-ed together.

menu_opts_on() turns on the named options for menu; no other option is changed.

menu_opts_off() turns off the named options for menu; no other option is changed.

menu_opts() returns the current options of menu.

The following values can be OR'd together to create opts. O_ONEVALUE

Only one item can be selected from the menu.

O_SHOWDESC

Display the description of the items.

O_ROWMAJOR

Display the menu in row major order.

O_IGNORECASE

Ignore the case when pattern matching.

O_SHOWMATCH

Place the cursor within the item name when pattern matching.

O_NONCYCLIC

Make certain menu driver requests non-cyclic.

RETURN VALUES

Except for menu_opts(), these routines return one of the following: E_OK

The routine returned successfully.

E_SYSTEM_ERROR

System error.

E_POSTED

The menu is already posted.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

curses (3CURSES), menus (3CURSES), attributes (7)

NOTES

The header <menu.h> automatically includes the headers <eti.h> and <curses.h>.