ncurses 4.1
[ncurses.git] / Ada95 / html / menu_spacing.3x.html
1 <HTML>
2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
3 <PRE>
4        <STRONG>menu_spacing</STRONG> - Control spacing between menu items.
5
6
7 </PRE>
8 <H2>SYNOPSIS</H2><PRE>
9        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
10        int set_menu_spacing(MENU *menu,
11                             int spc_description
12                             int spc_rows,
13                             int spc_columns);
14        int menu_spacing(const MENU *menu,
15                         int* spc_description
16                         int* spc_rows,
17                         int* spc_columns);
18
19
20 </PRE>
21 <H2>DESCRIPTION</H2><PRE>
22        The  function  <STRONG>set_menu_spacing</STRONG>  sets the spacing informa-
23        tions for the menu.  <STRONG>spc_description</STRONG> controls  the  number
24        of spaces between an item name and an item description. It
25        must not be larger than <STRONG>TABSIZE</STRONG>. The menu system  puts  in
26        the  middle  of  this  spacing area the pad character. The
27        remaining parts are filled with spaces.  <STRONG>spc_rows</STRONG> controls
28        the  number of rows that are used for an item. It must not
29        be larger than 3. The menu system inserts then blank lines
30        between  item rows, these lines will contain the pad char-
31        acter in the appropriate positions.  <STRONG>spc_columns</STRONG>  controls
32        the number of blanks between columns of items. It must not
33        be larger than TABSIZE.  A value of 0 for all the  spacing
34        values  resets  them to the default, which is 1 for all of
35        them.
36        The function <STRONG>menu_spacing</STRONG> passes back the spacing info for
37        the menu. If a pointer is NULL, this specific info is sim-
38        ply not returned.
39
40
41 </PRE>
42 <H2>RETURN VALUE</H2><PRE>
43        Both routines return <STRONG>E_OK</STRONG> on success. <STRONG>set_menu_spacing</STRONG> may
44        return  <STRONG>E_POSTED</STRONG>  if the menu is posted, or <STRONG>E_BAD_ARGUMENT</STRONG>
45        if one of the spacing values is out of range.
46
47
48 </PRE>
49 <H2>SEE ALSO</H2><PRE>
50        <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3X)</A></STRONG>.
51
52
53 </PRE>
54 <H2>NOTES</H2><PRE>
55        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
56        file <STRONG>&lt;curses.h&gt;</STRONG>.
57
58
59 </PRE>
60 <H2>PORTABILITY</H2><PRE>
61        These  routines  are  specific  to ncurses.  They were not
62        supported on Version 7, BSD or System  V  implementations.
63        It  is recommended that any code depending on them be con-
64        ditioned using NCURSES_VERSION.
65
66
67 </PRE>
68 <H2>AUTHORS</H2><PRE>
69        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
70 </PRE>
71 </BODY>
72 </HTML>