man/menu_spacing.3x

   1 '\" t
   2 .TH menu_spacing 3X ""
   3 .SH NAME
   4 \fBmenu_spacing\fR - Control spacing between menu items.
   5 .SH SYNOPSIS
   6 \fB#include <menu.h>\fR
   7 .br
   8 int set_menu_spacing(MENU *menu,
   9                      int spc_description
  10                      int spc_rows,
  11                      int spc_columns);
  12 .br
  13 int menu_spacing(const MENU *menu,
  14                  int* spc_description
  15                  int* spc_rows,
  16                  int* spc_columns);
  17 .br
  18 .SH DESCRIPTION
  19 The function \fBset_menu_spacing\fR sets the spacing informations for the menu.
  20 \fBspc_description\fR controls the number of spaces between an item name and an item
  21 description. It must not be larger than \fBTABSIZE\fR. The menu system puts in the
  22 middle of this spacing area the pad character. The remaining parts are filled with
  23 spaces.
  24 \fBspc_rows\fR controls the number of rows that are used for an item. It must not be
  25 larger than 3. The menu system inserts then blank lines between item rows, these lines
  26 will contain the pad character in the appropriate positions.
  27 \fBspc_columns\fR controls the number of blanks between columns of items. It must not
  28 be larger than TABSIZE.
  29 A value of 0 for all the spacing values resets them to the default, which is 1 for all
  30 of them.
  31 .br
  32 The function \fBmenu_spacing\fR passes back the spacing info for the menu. If a
  33 pointer is NULL, this specific info is simply not returned.
  34 .SH RETURN VALUE
  35 Both routines return \fBE_OK\fR on success. \fBset_menu_spacing\fR may return
  36 \fBE_POSTED\fR if the menu is posted, or \fBE_BAD_ARGUMENT\fR if one of the
  37 spacing values is out of range.
  38 .SH SEE ALSO
  39 \fBcurses\fR(3X), \fBmenu\fR(3X).
  40 .SH NOTES
  41 The header file \fB<menu.h>\fR automatically includes the header file
  42 \fB<curses.h>\fR.
  43 .SH PORTABILITY
  44 These routines are specific to ncurses.  They were not supported on
  45 Version 7, BSD or System V implementations.  It is recommended that
  46 any code depending on them be conditioned using NCURSES_VERSION.
  47 .SH AUTHORS
  48 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  49 S. Raymond.
  50 .\"#
  51 .\"# The following sets edit modes for GNU EMACS
  52 .\"# Local Variables:
  53 .\"# mode:nroff
  54 .\"# fill-column:79
  55 .\"# End: