ncurses 6.0 - patch 20151205
[ncurses.git] / man / menu_spacing.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: menu_spacing.3x,v 1.13 2015/12/05 23:42:45 tom Exp $
31 .TH menu_spacing 3X ""
32 .SH NAME
33 \fBset_menu_spacing\fP,
34 \fBmenu_spacing\fR \- set and get spacing between menu items.
35 .SH SYNOPSIS
36 \fB#include <menu.h>\fR
37 .br
38 int set_menu_spacing(MENU *menu,
39                      int spc_description,
40                      int spc_rows,
41                      int spc_columns);
42 .br
43 int menu_spacing(const MENU *menu,
44                  int* spc_description,
45                  int* spc_rows,
46                  int* spc_columns);
47 .br
48 .SH DESCRIPTION
49 The function \fBset_menu_spacing\fR sets the spacing information for the menu.
50 Its parameter \fBspc_description\fR controls the number of spaces between an item name and an item
51 description.
52 It must not be larger than \fBTABSIZE\fR.
53 The menu system puts in the
54 middle of this spacing area the pad character.
55 The remaining parts are filled with
56 spaces.
57 The \fBspc_rows\fR parameter controls the number of rows that are used for an item.
58 It must not be larger than 3.
59 The menu system inserts the blank lines between item rows, these lines
60 will contain the pad character in the appropriate positions.
61 The \fBspc_columns\fR parameter controls the number of blanks between columns of items.
62 It must not be larger than TABSIZE.
63 A value of 0 for all the spacing values resets them to the default, which is 1 for all
64 of them.
65 .br
66 The function \fBmenu_spacing\fR passes back the spacing info for the menu.
67 If a
68 pointer is NULL, this specific info is simply not returned.
69 .SH RETURN VALUE
70 Both routines return \fBE_OK\fR on success.
71 \fBset_menu_spacing\fR may return
72 \fBE_POSTED\fR if the menu is posted, or \fBE_BAD_ARGUMENT\fR if one of the
73 spacing values is out of range.
74 .SH SEE ALSO
75 \fBcurses\fR(3X),
76 \fBcurs_variables\fR(3X),
77 \fBmenu\fR(3X).
78 .SH NOTES
79 The header file \fB<menu.h>\fR automatically includes the header file
80 \fB<curses.h>\fR.
81 .SH PORTABILITY
82 These routines are specific to ncurses.
83 They were not supported on
84 Version 7, BSD or System V implementations.
85 It is recommended that
86 any code depending on them be conditioned using NCURSES_VERSION.
87 .SH AUTHORS
88 Juergen Pfeifer.
89 Manual pages and adaptation for new curses by Eric S. Raymond.