2002-10-13 11:35:53 +08:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
|
|
|
|
|
<!--
|
|
|
|
|
* t
|
|
|
|
|
****************************************************************************
|
2010-05-30 09:08:46 +08:00
|
|
|
* Copyright (c) 1998-2004,2010 Free Software Foundation, Inc. *
|
2002-10-13 11:35:53 +08:00
|
|
|
* *
|
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a *
|
|
|
|
|
* copy of this software and associated documentation files (the *
|
|
|
|
|
* "Software"), to deal in the Software without restriction, including *
|
|
|
|
|
* without limitation the rights to use, copy, modify, merge, publish, *
|
|
|
|
|
* distribute, distribute with modifications, sublicense, and/or sell *
|
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is *
|
|
|
|
|
* furnished to do so, subject to the following conditions: *
|
|
|
|
|
* *
|
|
|
|
|
* The above copyright notice and this permission notice shall be included *
|
|
|
|
|
* in all copies or substantial portions of the Software. *
|
|
|
|
|
* *
|
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
|
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
|
|
|
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
|
|
|
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
|
|
|
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
|
|
|
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
|
|
|
* *
|
|
|
|
|
* Except as contained in this notice, the name(s) of the above copyright *
|
|
|
|
|
* holders shall not be used in advertising or otherwise to promote the *
|
|
|
|
|
* sale, use or other dealings in this Software without prior written *
|
|
|
|
|
* authorization. *
|
|
|
|
|
****************************************************************************
|
2010-08-01 08:45:28 +08:00
|
|
|
* @Id: menu_spacing.3x,v 1.10 2010/07/31 15:45:16 tom Exp @
|
2002-10-13 11:35:53 +08:00
|
|
|
-->
|
1997-05-15 12:00:00 +08:00
|
|
|
<HTML>
|
2002-10-13 11:35:53 +08:00
|
|
|
<HEAD>
|
|
|
|
|
<TITLE>menu_spacing 3x</TITLE>
|
|
|
|
|
<link rev=made href="mailto:bug-ncurses@gnu.org">
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
|
</HEAD>
|
1999-10-24 12:32:42 +08:00
|
|
|
<BODY>
|
2002-10-13 11:35:53 +08:00
|
|
|
<H1>menu_spacing 3x</H1>
|
|
|
|
|
<HR>
|
1997-05-15 12:00:00 +08:00
|
|
|
<PRE>
|
2000-07-09 10:46:08 +08:00
|
|
|
<!-- Manpage converted by man2html 3.0.1 -->
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
|
2004-02-09 10:15:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>NAME</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>menu_spacing</STRONG> - Control spacing between menu items.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SYNOPSIS</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
|
1997-05-15 12:00:00 +08:00
|
|
|
int set_menu_spacing(MENU *menu,
|
2002-10-13 11:35:53 +08:00
|
|
|
int spc_description,
|
1997-05-15 12:00:00 +08:00
|
|
|
int spc_rows,
|
|
|
|
|
int spc_columns);
|
|
|
|
|
int menu_spacing(const MENU *menu,
|
2002-10-13 11:35:53 +08:00
|
|
|
int* spc_description,
|
1997-05-15 12:00:00 +08:00
|
|
|
int* spc_rows,
|
|
|
|
|
int* spc_columns);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>DESCRIPTION</H2><PRE>
|
2010-08-01 08:45:28 +08:00
|
|
|
The function <STRONG>set_menu_spacing</STRONG> sets the spacing information
|
|
|
|
|
for the menu. Its parameter <STRONG>spc_description</STRONG> controls the
|
|
|
|
|
number of spaces between an item name and an item descrip-
|
|
|
|
|
tion. It must not be larger than <STRONG>TABSIZE</STRONG>. The menu sys-
|
|
|
|
|
tem puts in the middle of this spacing area the pad char-
|
|
|
|
|
acter. The remaining parts are filled with spaces. The
|
|
|
|
|
<STRONG>spc_rows</STRONG> parameter controls the number of rows that are
|
|
|
|
|
used for an item. It must not be larger than 3. The menu
|
|
|
|
|
system inserts the blank lines between item rows, these
|
|
|
|
|
lines will contain the pad character in the appropriate
|
|
|
|
|
positions. The <STRONG>spc_columns</STRONG> parameter controls the number
|
|
|
|
|
of blanks between columns of items. It must not be larger
|
|
|
|
|
than TABSIZE. A value of 0 for all the spacing values
|
|
|
|
|
resets them to the default, which is 1 for all of them.
|
2002-10-13 11:35:53 +08:00
|
|
|
The function <STRONG>menu_spacing</STRONG> passes back the spacing info for
|
2010-08-01 08:45:28 +08:00
|
|
|
the menu. If a pointer is NULL, this specific info is
|
2010-05-30 09:08:46 +08:00
|
|
|
simply not returned.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>RETURN VALUE</H2><PRE>
|
2010-08-01 08:45:28 +08:00
|
|
|
Both routines return <STRONG>E_OK</STRONG> on success. <STRONG>set_menu_spacing</STRONG>
|
|
|
|
|
may return <STRONG>E_POSTED</STRONG> if the menu is posted, or <STRONG>E_BAD_ARGU-</STRONG>
|
2010-05-30 09:08:46 +08:00
|
|
|
<STRONG>MENT</STRONG> if one of the spacing values is out of range.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SEE ALSO</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>NOTES</H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
The header file <STRONG><menu.h></STRONG> automatically includes the header
|
|
|
|
|
file <STRONG><curses.h></STRONG>.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>PORTABILITY</H2><PRE>
|
2010-08-01 08:45:28 +08:00
|
|
|
These routines are specific to ncurses. They were not
|
|
|
|
|
supported on Version 7, BSD or System V implementations.
|
|
|
|
|
It is recommended that any code depending on them be con-
|
1997-05-15 12:00:00 +08:00
|
|
|
ditioned using NCURSES_VERSION.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>AUTHORS</H2><PRE>
|
2010-08-01 08:45:28 +08:00
|
|
|
Juergen Pfeifer. Manual pages and adaptation for new
|
2000-07-09 10:46:08 +08:00
|
|
|
curses by Eric S. Raymond.
|
2004-02-09 10:15:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
|
1997-05-15 12:00:00 +08:00
|
|
|
</PRE>
|
2000-07-09 10:46:08 +08:00
|
|
|
<HR>
|
|
|
|
|
<ADDRESS>
|
|
|
|
|
Man(1) output converted with
|
|
|
|
|
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
|
|
|
|
|
</ADDRESS>
|
1997-05-15 12:00:00 +08:00
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
