https://invisible-island.net/ncurses/man/


menu_spacing 3x 2023-12-16 ncurses 6.4 Library calls

menu_spacing(3x)                 Library calls                menu_spacing(3x)




NAME

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


SYNOPSIS

       #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

       The function set_menu_spacing sets  the  spacing  information  for  the
       menu.  Its parameters provide the description and the size (in rows and
       columns).

       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.

       spc_rows
              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.

       spc_columns
              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 returns the spacing information for the menu.
       If  a  pointer  is  NULL,  the  corresponding information is simply not
       returned.


RETURN VALUE

       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.


PORTABILITY

       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

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


SEE ALSO

       curses(3x), curs_variables(3x), menu(3x)



ncurses 6.4                       2023-12-16                  menu_spacing(3x)