<!--
* t
****************************************************************************
- * Copyright (c) 1998-2001,2004 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.8 2004/12/11 23:39:07 tom Exp @
+ * @Id: menu_spacing.3x,v 1.9 2010/01/30 21:29:04 tom Exp @
-->
<HTML>
<HEAD>
</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 the 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.
+ tions for the menu. Its parameter <STRONG>spc_description</STRONG> con-
+ trols 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. 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 con-
+ trols 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>
</PRE>
<H2>PORTABILITY</H2><PRE>
- 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-
+ 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-
ditioned using NCURSES_VERSION.
</PRE>
<H2>AUTHORS</H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
+ Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
projects / ncurses.git / blobdiff