carta
menu_pad(3menu)

menu_pad3menu

Color and attribute control for menus

Part of attributes(3menu).

Usage

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);

Overview

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.

Portability

These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions.

History

  • Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie) to Debian 7 (Wheezy)
  • Debian 6.0 (Squeeze) to Debian 5.0 (Lenny)
  • Debian 4.0 (Etch)
  • Debian 3.1 (Sarge)
  • Debian 3.0 (Woody)

Authors

Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.

From ncurses-doc 6.5+20250216-2 in Debian 13 (Trixie). Parsed by carta from the page's man source.