xref: /illumos-gate/usr/src/man/man3curses/menu_attributes.3curses (revision 09a48d4ca0ddda4ad26cc885769745870d989baf)
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_ATTRIBUTES 3CURSES "Dec 31, 1996"
NAME
menu_attributes, set_menu_fore, menu_fore, set_menu_back, menu_back, set_menu_grey, menu_grey, set_menu_pad, menu_pad - control menus display attributes
SYNOPSIS

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

int set_menu_fore(MENU *menu, chtype attr);

chtype menu_fore(MENU *menu);

int set_menu_back(MENU *menu, chtype attr);

chtype menu_back(MENU *menu);

int set_menu_grey(MENU*menu, chtype attr);

chtype menu_grey(MENU *menu);

int set_menu_pad(MENU *menu, int pad);

int menu_pad(MENU *menu);
DESCRIPTION

set_menu_fore() sets the foreground attribute of menu \(em the display attribute for the current item (if selectable) on single-valued menus and for selected items on multi-valued menus. This display attribute is a curses library visual attribute. menu_fore() returns the foreground attribute of menu.

set_menu_back() sets the background attribute of menu \(em the display attribute for unselected, yet selectable, items. This display attribute is a curses library visual attribute.

set_menu_grey() sets the grey attribute of menu \(em the display attribute for nonselectable items in multi-valued menus. This display attribute is a curses library visual attribute. menu_grey() returns the grey attribute of menu.

The pad character is the character that fills the space between the name and description of an item. set_menu_pad() sets the pad character for menu to pad. menu_pad() returns the pad character of menu.

RETURN VALUES

These routines return one of the following: E_OK

The routine returned successfully.

E_SYSTEM_ERROR

System error.

E_BAD_ARGUMENT

An incorrect argument was passed to the routine.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

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

NOTES

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