2 ****************************************************************************
3 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: menu_spacing.3x,v 1.37 2024/03/16 15:35:01 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_spacing 3x 2024-03-16 ncurses 6.5 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">menu_spacing 3x 2024-03-16 ncurses 6.5 Library calls</H1>
44 <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> Library calls <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
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
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>set_menu_spacing(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG>
58 <STRONG>int</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>description</EM><STRONG>,</STRONG>
59 <STRONG>int</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>rows</EM><STRONG>,</STRONG>
60 <STRONG>int</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>columns</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>menu_spacing(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG>
62 <STRONG>int*</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>description</EM><STRONG>,</STRONG>
63 <STRONG>int*</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>rows</EM><STRONG>,</STRONG>
64 <STRONG>int*</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>columns</EM><STRONG>);</STRONG>
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 parameters provide the description and the size (in rows and
72 <EM>spc</EM><STRONG>_</STRONG><EM>description</EM>
73 controls the number of spaces between an item name and an item
74 description. It must not be larger than <STRONG>TABSIZE</STRONG>. The menu
75 system puts in the middle of this spacing area the pad
76 character. The remaining parts are filled with spaces.
78 <EM>spc</EM><STRONG>_</STRONG><EM>rows</EM>
79 controls the number of rows that are used for an item. It must
80 not be larger than 3. The menu system inserts the blank lines
81 between item rows, these lines will contain the pad character in
82 the appropriate positions.
84 <EM>spc</EM><STRONG>_</STRONG><EM>columns</EM>
85 controls the number of blanks between columns of items. It must
86 not be larger than <STRONG>TABSIZE</STRONG>. A value of 0 for all the spacing
87 values resets them to the default, which is 1 for all of them.
89 The function <STRONG>menu_spacing</STRONG> returns the spacing information for the menu.
90 If a pointer is NULL, the corresponding information is simply not
94 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
95 Both routines return <STRONG>E_OK</STRONG> on success. <STRONG>set_menu_spacing</STRONG> may return
96 <STRONG>E_POSTED</STRONG> if the menu is posted, or <STRONG>E_BAD_ARGUMENT</STRONG> if one of the spacing
97 values is out of range.
100 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
101 These routines are specific to <EM>ncurses</EM>. They were not supported on
102 Version 7, BSD or System V implementations. It is recommended that any
103 code depending on them be conditioned using NCURSES_VERSION.
106 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
107 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
111 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
112 <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>
116 ncurses 6.5 2024-03-16 <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
120 <li><a href="#h2-NAME">NAME</a></li>
121 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
122 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
123 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
124 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
125 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
126 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>