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