set_menu_opts(3x)

1menu_opts(3X)                                                    menu_opts(3X)
2
3
4

NAME

6       set_menu_opts,  menu_opts_on,  menu_opts_off,  menu_opts  - set and get
7       menu options
8

SYNOPSIS

10       #include <menu.h>
11
12       int set_menu_opts(MENU *menu, Menu_Options opts);
13       Menu_Options menu_opts(const MENU *menu);
14
15       int menu_opts_on(MENU *menu, Menu_Options opts);
16       int menu_opts_off(MENU *menu, Menu_Options opts);
17

DESCRIPTION

19       The function set_menu_opts sets all the given menu's option bits  (menu
20       option bits may be logically-OR'ed together).
21
22       The  function  menu_opts_on  turns on the given option bits, and leaves
23       others alone.
24
25       The function menu_opts_off turns off the given option bits, and  leaves
26       others alone.
27
28       The function menu_opts returns the menu's current option bits.
29
30       The following options are defined (all are on by default):
31
32       O_ONEVALUE
33            Only one item can be selected for this menu.
34
35       O_SHOWDESC
36            Display the item descriptions when the menu is posted.
37
38       O_ROWMAJOR
39            Display the menu in row-major order.
40
41       O_IGNORECASE
42            Ignore the case when pattern-matching.
43
44       O_SHOWMATCH
45            Move the cursor to within the item name while pattern-matching.
46
47       O_NONCYCLIC
48            Don't  wrap  around  next-item  and previous-item, requests to the
49            other end of the menu.
50
51       O_MOUSE_MENU
52            If user clicks with the mouse and it does not  fall  on  the  cur‐
53            rently active menu, push KEY_MOUSE and the MEVENT data back on the
54            queue to allow processing in another part of the calling program.
55

RETURN VALUE

57       Except for menu_opts, each routine returns one of the following:
58
59       E_OK The routine succeeded.
60
61       E_SYSTEM_ERROR
62            System error occurred (see errno(3)).
63
64       E_POSTED
65            The menu is already posted.
66

NOTES

71       The  header  file  <menu.h>  automatically  includes  the  header  file
72       <curses.h>.
73

PORTABILITY

75       These  routines  emulate the System V menu library.  They were not sup‐
76       ported on Version 7 or BSD versions.
77

AUTHORS

79       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
80       Raymond.
81
82
83
84                                                                 menu_opts(3X)