mitem_opts(3x) — Linux manual page

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

mitem_opts(3X)                                            mitem_opts(3X)

NAME         top

       set_item_opts, item_opts_on, item_opts_off, item_opts - set and
       get menu item options

SYNOPSIS         top

       #include <menu.h>

       int set_item_opts(ITEM *item, Item_Options opts);
       Item_Options item_opts(const ITEM *item);

       int item_opts_on(ITEM *item, Item_Options opts);
       int item_opts_off(ITEM *item, Item_Options opts);

DESCRIPTION         top

       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         top

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

       E_OK The routine succeeded.

       E_SYSTEM_ERROR
            System error occurred (see errno(3)).

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
       [email protected].  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
       [email protected]

                                                          mitem_opts(3X)