menu_opts(3)

menu_opts3

Set and get menu options

Usage

#include <menu.h>

int set_menu_opts(MENU *menu, Menu_Options opts); Menu_Options menu_opts(const MENU *menu);

int menu_opts_on(MENU *menu, Menu_Options opts); int menu_opts_off(MENU *menu, Menu_Options opts);

Overview

The function set_menu_opts sets all the given menu's option bits (menu option bits may be logically “or”-ed together).

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

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

The function menu_opts returns the menu's current option bits.

The following options are defined (all are on by default):

O_ONEVALUE

Only one item can be selected for this menu.

O_SHOWDESC

Display the item descriptions when the menu is posted.

O_ROWMAJOR

Display the menu in row-major order.

O_IGNORECASE

Ignore the case when pattern-matching.

O_SHOWMATCH

Move the cursor to within the item name while pattern-matching.

O_NONCYCLIC

Don't wrap around next-item and previous-item, requests to the other end of the menu.

O_MOUSE_MENU

If user clicks with the mouse and it does not fall on the currently active menu, push KEY_MOUSE and the MEVENT data back on the queue to allow processing in another part of the calling program.

Return value

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

E_OK

The routine succeeded.

E_SYSTEM_ERROR

System error occurred (see errno(3)).

E_POSTED

The menu is already posted.

Portability

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

Releases

66 releases since FreeBSD 4.3-RELEASE; the text changed 11 times.

  1. 4.3–6.2
  2. 6.3
  3. 6.4
  4. 7.0
  5. 7.1–10.4
  6. 11.0–12.4
  7. 13.0–13.5
  8. 14.0–14.1
  9. 14.2–14.4
  10. 14.5
  11. 15.0
  12. 15.1–16.0

Authors

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

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's man source.