1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> 2<!-- 3 * t 4 **************************************************************************** 5 * Copyright (c) 1998-2001,2004 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.8 2004/12/11 23:39:07 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><menu.h></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. <STRONG>spc_description</STRONG> controls the number 71 of spaces between an item name and an item description. It 72 must not be larger than <STRONG>TABSIZE</STRONG>. The menu system puts in 73 the middle of this spacing area the pad character. The 74 remaining parts are filled with spaces. <STRONG>spc_rows</STRONG> controls 75 the number of rows that are used for an item. It must not 76 be larger than 3. The menu system inserts the blank lines 77 between item rows, these lines will contain the pad char- 78 acter in the appropriate positions. <STRONG>spc_columns</STRONG> controls 79 the number of blanks between columns of items. It must not 80 be larger than TABSIZE. A value of 0 for all the spacing 81 values resets them to the default, which is 1 for all of 82 them. 83 The function <STRONG>menu_spacing</STRONG> passes back the spacing info for 84 the menu. If a pointer is NULL, this specific info is sim- 85 ply not returned. 86 87 88</PRE> 89<H2>RETURN VALUE</H2><PRE> 90 Both routines return <STRONG>E_OK</STRONG> on success. <STRONG>set_menu_spacing</STRONG> may 91 return <STRONG>E_POSTED</STRONG> if the menu is posted, or <STRONG>E_BAD_ARGUMENT</STRONG> 92 if one of the spacing values is out of range. 93 94 95</PRE> 96<H2>SEE ALSO</H2><PRE> 97 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. 98 99 100</PRE> 101<H2>NOTES</H2><PRE> 102 The header file <STRONG><menu.h></STRONG> automatically includes the header 103 file <STRONG><curses.h></STRONG>. 104 105 106</PRE> 107<H2>PORTABILITY</H2><PRE> 108 These routines are specific to ncurses. They were not 109 supported on Version 7, BSD or System V implementations. 110 It is recommended that any code depending on them be con- 111 ditioned using NCURSES_VERSION. 112 113 114</PRE> 115<H2>AUTHORS</H2><PRE> 116 Juergen Pfeifer. Manual pages and adaptation for new 117 curses by Eric S. Raymond. 118 119 120 121 <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> 122</PRE> 123<HR> 124<ADDRESS> 125Man(1) output converted with 126<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> 127</ADDRESS> 128</BODY> 129</HTML> 130