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

menu_spacing(3X)                                            menu_spacing(3X)

NAME         top

       set_menu_spacing,  menu_spacing  -  set  and get spacing between menu
       items.

SYNOPSIS         top

       #include <menu.h>
       int set_menu_spacing(MENU *menu,
                            int spc_description,
                            int spc_rows,
                            int spc_columns);
       int menu_spacing(const MENU *menu,
                        int* spc_description,
                        int* spc_rows,
                        int* spc_columns);

DESCRIPTION         top

       The function set_menu_spacing sets the spacing information for the
       menu.  Its parameter spc_description controls the number of spaces
       between an item name and an item description.  It must not be larger
       than TABSIZE.  The menu system puts in the middle of this spacing
       area the pad character.  The remaining parts are filled with spaces.
       The spc_rows parameter controls the number of rows that are used for
       an item.  It must not be larger than 3.  The menu system inserts the
       blank lines between item rows, these lines will contain the pad
       character in the appropriate positions.  The spc_columns parameter
       controls the number of blanks between columns of items.  It must not
       be larger than TABSIZE.  A value of 0 for all the spacing values
       resets them to the default, which is 1 for all of them.
       The function menu_spacing passes back the spacing info for the menu.
       If a pointer is NULL, this specific info is simply not returned.

RETURN VALUE         top

       Both routines return E_OK on success.  set_menu_spacing may return
       E_POSTED if the menu is posted, or E_BAD_ARGUMENT if one of the
       spacing values is out of range.

SEE ALSO         top

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

NOTES         top

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

PORTABILITY         top

       These routines are specific to ncurses.  They were not supported on
       Version 7, BSD or System V implementations.  It is recommended that
       any code depending on them be conditioned using NCURSES_VERSION.

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 
       ⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2017-07-05.  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_spacing(3X)