man7.org > Linux > man-pages

Linux/UNIX system programming training

menu_opts(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | NOTES | PORTABILITY | AUTHORS | COLOPHON 

menu_opts(3X)                                              menu_opts(3X)

NAME         top

       set_menu_opts, menu_opts_on, menu_opts_off, menu_opts - set and
       get menu options

SYNOPSIS         top

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

DESCRIPTION         top

       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         top

       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.

SEE ALSO         top

       curses(3X), menu(3X).

NOTES         top

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

PORTABILITY         top

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

AUTHORS         top

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

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have
       a bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨https://github.com/mirror/ncurses.git⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-03-12.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                                           menu_opts(3X)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI