ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / menu_spacing.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2010,2015 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.16 2020/02/02 23:34:34 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>menu_spacing 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">menu_spacing 3x</H1>
44 <PRE>
45 <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>                                              <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>set_menu_spacing</STRONG>,  <STRONG>menu_spacing</STRONG>  -  set  and  get  spacing between menu
52        items.
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        int set_menu_spacing(MENU *menu,
58                             int spc_description,
59                             int spc_rows,
60                             int spc_columns);
61        int menu_spacing(const MENU *menu,
62                         int* spc_description,
63                         int* spc_rows,
64                         int* spc_columns);
65
66
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68        The function <STRONG>set_menu_spacing</STRONG> sets  the  spacing  information  for  the
69        menu.   Its  parameter  <STRONG>spc_description</STRONG>  controls  the number of spaces
70        between an item name and an item description.  It must  not  be  larger
71        than  <STRONG>TABSIZE</STRONG>.  The menu system puts in the middle of this spacing area
72        the pad character.  The remaining parts are filled  with  spaces.   The
73        <STRONG>spc_rows</STRONG>  parameter  controls  the  number of rows that are used for an
74        item.  It must not be larger than 3.  The menu system inserts the blank
75        lines  between item rows, these lines will contain the pad character in
76        the appropriate positions.  The <STRONG>spc_columns</STRONG> parameter controls the num-
77        ber  of  blanks  between  columns of items.  It must not be larger than
78        <STRONG>TABSIZE</STRONG>.  A value of 0 for all the spacing values resets  them  to  the
79        default, which is 1 for all of them.
80        The  function  <STRONG>menu_spacing</STRONG>  passes back the spacing info for the menu.
81        If a pointer is NULL, this specific info is simply not returned.
82
83
84 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
85        Both routines return <STRONG>E_OK</STRONG>  on  success.   <STRONG>set_menu_spacing</STRONG>  may  return
86        <STRONG>E_POSTED</STRONG> if the menu is posted, or <STRONG>E_BAD_ARGUMENT</STRONG> if one of the spacing
87        values is out of range.
88
89
90 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
91        <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>.
92
93
94 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
95        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
96        <STRONG>&lt;curses.h&gt;</STRONG>.
97
98
99 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
100        These  routines  are  specific  to ncurses.  They were not supported on
101        Version 7, BSD or System V implementations.  It is recommended that any
102        code depending on them be conditioned using NCURSES_VERSION.
103
104
105 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
106        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
107        Raymond.
108
109
110
111                                                               <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
112 </PRE>
113 <div class="nav">
114 <ul>
115 <li><a href="#h2-NAME">NAME</a></li>
116 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
117 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
118 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
119 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
120 <li><a href="#h2-NOTES">NOTES</a></li>
121 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
122 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
123 </ul>
124 </div>
125 </BODY>
126 </HTML>