menu_attributes.3x - Man Page

color and attribute control for menus

Synopsis

#include <menu.h>

int set_menu_fore(MENU *menu, chtype attr);
chtype menu_fore(const MENU *menu);

int set_menu_back(MENU *menu, chtype attr);
chtype menu_back(const MENU *menu);

int set_menu_grey(MENU *menu, chtype attr);
chtype menu_grey(const MENU *menu);

int set_menu_pad(MENU *menu, int pad);
int menu_pad(const MENU *menu);

Description

The function set_menu_fore sets the foreground attribute of menu. This is the highlight used for selected menu items. menu_fore returns the foreground attribute. The default is A_REVERSE.

The function set_menu_back sets the background attribute of menu. This is the highlight used for selectable (but not currently selected) menu items. The function menu_back returns the background attribute. The default is A_NORMAL.

The function set_menu_grey sets the grey attribute of menu. This is the highlight used for un-selectable menu items in menus that permit more than one selection. The function menu_grey returns the grey attribute. The default is A_UNDERLINE.

The function set_menu_pad sets the character used to fill the space between the name and description parts of a menu item. menu_pad returns the given menu's pad character. The default is a blank.

Return Value

These routines return one of the following:

E_OK

The routine succeeded.

E_SYSTEM_ERROR

System error occurred (see errno(3)).

E_BAD_ARGUMENT

Routine detected an incorrect or out-of-range argument.

See Also

curses(3X) and related pages whose names begin “menu_” for detailed descriptions of the entry points.

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.

Referenced By

The man pages menu_back.3x(3), menu_fore.3x(3), menu_grey.3x(3), menu_pad.3x(3), set_menu_back.3x(3), set_menu_fore.3x(3), set_menu_grey.3x(3) and set_menu_pad.3x(3) are aliases of menu_attributes.3x(3).