mitem_opts(3menu)

mitem_opts3menu

Set and get menu item options

Part of menu_opts(3menu).

Usage

#include <menu.h>
int set_item_opts(ITEM *item, Item_Options opts);
int item_opts_on(ITEM *item, Item_Options opts);
int item_opts_off(ITEM *item, Item_Options opts);
Item_Options item_opts(const ITEM *item);

Overview

The function set_item_opts sets all the given item's option bits (menu option bits may be logically-OR'ed together).

The function item_opts_on turns on the given option bits, and leaves others alone.

The function item_opts_off turns off the given option bits, and leaves others alone.

The function item_opts returns the item's current option bits.

There is only one defined option bit mask, O_SELECTABLE. When this is on, the item may be selected during menu processing. This option defaults to on.

Return value

Except for item_opts, each routine returns one of the following:

E_OK

The routine succeeded.

E_SYSTEM_ERROR

System error occurred (see errno).

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.

Releases

7 releases since Debian 3.0 (Woody); the text changed 4 times.

  1. 3.0
  2. 3.1
  3. 4.0
  4. 5.0–6.0
  5. 7–8

Authors

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

From ncurses-doc 5.9+20140913-1+deb8u3 in Debian 8 (Jessie). Parsed by carta from the page's man source.