ncurses 5.7 - patch 20100529
[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-2004,2010 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.9 2010/01/30 21:29:04 tom 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 <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>NAME</H2><PRE>
51        <STRONG>menu_spacing</STRONG> - Control spacing between menu items.
52
53
54 </PRE>
55 <H2>SYNOPSIS</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>
68 <H2>DESCRIPTION</H2><PRE>
69        The  function  <STRONG>set_menu_spacing</STRONG>  sets the spacing informa-
70        tions for the menu.  Its  parameter  <STRONG>spc_description</STRONG>  con-
71        trols  the  number  of  spaces between an item name and an
72        item description.  It must not  be  larger  than  <STRONG>TABSIZE</STRONG>.
73        The  menu  system  puts in the middle of this spacing area
74        the pad character.  The remaining parts  are  filled  with
75        spaces.   The  <STRONG>spc_rows</STRONG>  parameter  controls the number of
76        rows that are used for an item.  It  must  not  be  larger
77        than  3.   The menu system inserts the blank lines between
78        item rows, these lines will contain the pad  character  in
79        the appropriate positions.  The <STRONG>spc_columns</STRONG> parameter con-
80        trols the number of blanks between columns of  items.   It
81        must not be larger than TABSIZE.  A value of 0 for all the
82        spacing values resets them to the default, which is 1  for
83        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>RETURN VALUE</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>SEE ALSO</H2><PRE>
98        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
99
100
101 </PRE>
102 <H2>NOTES</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>PORTABILITY</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>AUTHORS</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 <HR>
125 <ADDRESS>
126 Man(1) output converted with
127 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
128 </ADDRESS>
129 </BODY>
130 </HTML>