+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
+<!--
+ * t
+ ****************************************************************************
+ * Copyright (c) 1998-2004,2010 Free Software Foundation, Inc. *
+ * *
+ * 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. *
+ ****************************************************************************
+ * @Id: menu_spacing.3x,v 1.12 2010/12/04 18:38:55 tom Exp @
+-->
<HTML>
+<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>
<BODY>
+<H1>menu_spacing 3x</H1>
+<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG> <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
+
+
+
</PRE>
<H2>NAME</H2><PRE>
- <B>menu_spacing</B> - Control spacing between menu items.
+ <STRONG>menu_spacing</STRONG> - Control spacing between menu items.
</PRE>
<H2>SYNOPSIS</H2><PRE>
- <B>#include</B> <B><menu.h></B>
+ <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
int set_menu_spacing(MENU *menu,
- int spc_description
+ int spc_description,
int spc_rows,
int spc_columns);
int menu_spacing(const MENU *menu,
- int* spc_description
+ int* spc_description,
int* spc_rows,
int* spc_columns);
</PRE>
<H2>DESCRIPTION</H2><PRE>
- The function <B>set_menu_spacing</B> sets the spacing informa-
- tions for the menu. <B>spc_description</B> controls the number
- of spaces between an item name and an item description. It
- must not be larger than <B>TABSIZE</B>. The menu system puts in
- the middle of this spacing area the pad character. The
- remaining parts are filled with spaces. <B>spc_rows</B> controls
- the number of rows that are used for an item. It must not
- be larger than 3. The menu system inserts then blank lines
- between item rows, these lines will contain the pad char-
- acter in the appropriate positions. <B>spc_columns</B> 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.
- The function <B>menu_spacing</B> passes back the spacing info for
- the menu. If a pointer is NULL, this specific info is sim-
- ply not returned.
+ 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.
+ The function <STRONG>menu_spacing</STRONG> passes back the spacing info for
+ the menu. If a pointer is NULL, this specific info is
+ simply not returned.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- Both routines return <B>E_OK</B> on success. <B>set_menu_spacing</B> may
- return <B>E_POSTED</B> if the menu is posted, or <B>E_BAD_ARGUMENT</B>
- if one of the spacing values is out of range.
+ 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>
+ <STRONG>MENT</STRONG> if one of the spacing values is out of range.
</PRE>
<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
+ <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>.
</PRE>
<H2>NOTES</H2><PRE>
- The header file <B><menu.h></B> automatically includes the header
- file <B><curses.h></B>.
+ The header file <STRONG><menu.h></STRONG> automatically includes the header
+ file <STRONG><curses.h></STRONG>.
</PRE>
<H2>AUTHORS</H2><PRE>
Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
+
+
+
+ <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
</PRE>
<HR>
<ADDRESS>
projects / ncurses.git / blobdiff