man7.org > Linux > man-pages

Linux/UNIX system programming training

menu_attributes(3x) — Linux manual page

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

menu_attributes(3X)                                  menu_attributes(3X)

NAME         top

       menu_back, menu_fore, menu_grey, menu_pad, set_menu_back,
       set_menu_fore, set_menu_grey, set_menu_pad - color and attribute
       control for menus

SYNOPSIS         top

       #include <menu.h>

       int set_menu_fore(MENU *menu, chtype attr);
       chtype menu_fore(const MENU *menu);

       int set_menu_back(MENU *menu, chtype attr);
       chtype menu_back(const MENU *menu);

       int set_menu_grey(MENU *menu, chtype attr);
       chtype menu_grey(const MENU *menu);

       int set_menu_pad(MENU *menu, int pad);
       int menu_pad(const MENU *menu);

DESCRIPTION         top

       The function set_menu_fore sets the foreground attribute of menu.
       This is the highlight used for selected menu items.  menu_fore
       returns the foreground attribute.  The default is A_REVERSE.

       The function set_menu_back sets the background attribute of menu.
       This is the highlight used for selectable (but not currently
       selected) menu items.  The function menu_back returns the
       background attribute.  The default is A_NORMAL.

       The function set_menu_grey sets the grey attribute of menu. This
       is the highlight used for un-selectable menu items in menus that
       permit more than one selection.  The function menu_grey returns
       the grey attribute.  The default is A_UNDERLINE.

       The function set_menu_pad sets the character used to fill the
       space between the name and description parts of a menu item.
       menu_pad returns the given menu's pad character.  The default is
       a blank.

RETURN VALUE         top

       These routines return one of the following:

       E_OK The routine succeeded.

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

       E_BAD_ARGUMENT
            Routine detected an incorrect or out-of-range argument.

SEE ALSO         top

       curses(3X) and related pages whose names begin “menu_” for
       detailed descriptions of the entry points.

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]

                                                     menu_attributes(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