ncurses 5.3
[ncurses.git] / doc / html / man / menu_spacing.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998,2001 Free Software Foundation, Inc.                   *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: menu_spacing.3x,v 1.6 2001/08/04 20:36:16 William.Setzer Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>menu_spacing 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>menu_spacing 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>menu_spacing</STRONG> - Control spacing between menu items.
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
53        int set_menu_spacing(MENU *menu,
54                             int spc_description,
55                             int spc_rows,
56                             int spc_columns);
57        int menu_spacing(const MENU *menu,
58                         int* spc_description,
59                         int* spc_rows,
60                         int* spc_columns);
61
62
63 </PRE>
64 <H2>DESCRIPTION</H2><PRE>
65        The  function  <STRONG>set_menu_spacing</STRONG>  sets the spacing informa-
66        tions for the menu.  <STRONG>spc_description</STRONG> controls  the  number
67        of spaces between an item name and an item description. It
68        must not be larger than <STRONG>TABSIZE</STRONG>. The menu system  puts  in
69        the  middle  of  this  spacing area the pad character. The
70        remaining parts are filled with spaces.  <STRONG>spc_rows</STRONG> controls
71        the  number of rows that are used for an item. It must not
72        be larger than 3. The menu system inserts then blank lines
73        between  item rows, these lines will contain the pad char-
74        acter in the appropriate positions.  <STRONG>spc_columns</STRONG>  controls
75        the number of blanks between columns of items. It must not
76        be larger than TABSIZE.  A value of 0 for all the  spacing
77        values  resets  them to the default, which is 1 for all of
78        them.
79        The function <STRONG>menu_spacing</STRONG> passes back the spacing info for
80        the menu. If a pointer is NULL, this specific info is sim-
81        ply not returned.
82
83
84 </PRE>
85 <H2>RETURN VALUE</H2><PRE>
86        Both routines return <STRONG>E_OK</STRONG> on success. <STRONG>set_menu_spacing</STRONG> may
87        return  <STRONG>E_POSTED</STRONG>  if the menu is posted, or <STRONG>E_BAD_ARGUMENT</STRONG>
88        if one of the spacing values is out of range.
89
90
91 </PRE>
92 <H2>SEE ALSO</H2><PRE>
93        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
94
95
96 </PRE>
97 <H2>NOTES</H2><PRE>
98        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
99        file <STRONG>&lt;curses.h&gt;</STRONG>.
100
101
102 </PRE>
103 <H2>PORTABILITY</H2><PRE>
104        These  routines  are  specific  to ncurses.  They were not
105        supported on Version 7, BSD or System  V  implementations.
106        It  is recommended that any code depending on them be con-
107        ditioned using NCURSES_VERSION.
108
109
110 </PRE>
111 <H2>AUTHORS</H2><PRE>
112        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
113        curses by Eric S. Raymond.
114 </PRE>
115 <HR>
116 <ADDRESS>
117 Man(1) output converted with
118 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
119 </ADDRESS>
120 </BODY>
121 </HTML>