Documentation Archive Developer
Search
ADC Home > Reference Library > Reference > Mac OS X > Mac OS X Man Pages

 

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).



menu_spacing(3X)                                              menu_spacing(3X)



NAME
       menu_spacing - Control 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 informations for the
       menu.  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 num-ber number
       ber 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_col-umns spc_columns
       umns  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
       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
       curses(3X), menu(3X).

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

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.



                                                              menu_spacing(3X)