<!--
* t
****************************************************************************
- * Copyright (c) 1998,2001 Free Software Foundation, Inc. *
+ * 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: menu_spacing.3x,v 1.6 2001/08/04 20:36:16 William.Setzer Exp @
+ * @Id: menu_spacing.3x,v 1.12 2010/12/04 18:38:55 tom Exp @
-->
<HTML>
<HEAD>
<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>
</PRE>
<H2>DESCRIPTION</H2><PRE>
- The function <STRONG>set_menu_spacing</STRONG> sets the spacing informa-
- tions for the menu. <STRONG>spc_description</STRONG> controls the number
- of spaces between an item name and an item description. It
- must not be larger than <STRONG>TABSIZE</STRONG>. The menu system puts in
- the middle of this spacing area the pad character. The
- remaining parts are filled with spaces. <STRONG>spc_rows</STRONG> 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. <STRONG>spc_columns</STRONG> 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>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 sim-
- ply not returned.
+ the menu. If a pointer is NULL, this specific info is
+ simply not returned.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- 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_ARGUMENT</STRONG>
- 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>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
+ <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>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