ncurses 6.0 - patch 20170506
[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><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>set_menu_spacing</STRONG>,  <STRONG>menu_spacing</STRONG>  -  set  and  get  spacing between menu
51        items.
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56        int set_menu_spacing(MENU *menu,
57                             int spc_description,
58                             int spc_rows,
59                             int spc_columns);
60        int menu_spacing(const MENU *menu,
61                         int* spc_description,
62                         int* spc_rows,
63                         int* spc_columns);
64
65
66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67        The function <STRONG>set_menu_spacing</STRONG> sets  the  spacing  information  for  the
68        menu.   Its  parameter  <STRONG>spc_description</STRONG>  controls  the number of spaces
69        between an item name and an item description.  It must  not  be  larger
70        than  <STRONG>TABSIZE</STRONG>.  The menu system puts in the middle of this spacing area
71        the pad character.  The remaining parts are filled  with  spaces.   The
72        <STRONG>spc_rows</STRONG>  parameter  controls  the  number of rows that are used for an
73        item.  It must not be larger than 3.  The menu system inserts the blank
74        lines  between item rows, these lines will contain the pad character in
75        the appropriate positions.  The <STRONG>spc_columns</STRONG> parameter controls the num-
76        ber  of  blanks  between  columns of items.  It must not be larger than
77        TABSIZE.  A value of 0 for all the spacing values resets  them  to  the
78        default, which is 1 for all of them.
79        The  function  <STRONG>menu_spacing</STRONG>  passes back the spacing info for the menu.
80        If a pointer is NULL, this specific info is simply not returned.
81
82
83 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
84        Both routines return <STRONG>E_OK</STRONG>  on  success.   <STRONG>set_menu_spacing</STRONG>  may  return
85        <STRONG>E_POSTED</STRONG> if the menu is posted, or <STRONG>E_BAD_ARGUMENT</STRONG> if one of the spacing
86        values is out of range.
87
88
89 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
90        <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>.
91
92
93 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
94        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
95        <STRONG>&lt;curses.h&gt;</STRONG>.
96
97
98 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
99        These  routines  are  specific  to ncurses.  They were not supported on
100        Version 7, BSD or System V implementations.  It is recommended that any
101        code depending on them be conditioned using NCURSES_VERSION.
102
103
104 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
105        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
106        Raymond.
107
108
109
110                                                               <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
111 </PRE>
112 <div class="nav">
113 <ul>
114 <li><a href="#h2-NAME">NAME</a></li>
115 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
116 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
117 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
118 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
119 <li><a href="#h2-NOTES">NOTES</a></li>
120 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
121 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
122 </ul>
123 </div>
124 </BODY>
125 </HTML>