X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_spacing.3x.html;h=50f3b52b84ee9abd9ed37de8b0fc3cec3c8792a9;hp=ba2cd1cdf9b992b71857513228c2943d994bd8dd;hb=761e4f0825b330e970558e82a4bd638383914429;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/menu_spacing.3x.html b/doc/html/man/menu_spacing.3x.html index ba2cd1cd..50f3b52b 100644 --- a/doc/html/man/menu_spacing.3x.html +++ b/doc/html/man/menu_spacing.3x.html @@ -1,63 +1,106 @@ + + + +menu_spacing 3x + + + +

menu_spacing 3x

 
+menu_spacing(3x)                                       menu_spacing(3x)
+
+
+

NAME

-       menu_spacing - Control spacing between menu items.
+       menu_spacing - Control spacing between menu items.

SYNOPSIS

-       #include <menu.h>
+       #include <menu.h>
        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);

DESCRIPTION

-       The  function  set_menu_spacing  sets the spacing informa-
-       tions for the menu.  spc_description controls  the  number
-       of spaces between an item name and an item description. It
-       must not be larger than TABSIZE. The menu system  puts  in
-       the  middle  of  this  spacing area the pad character. The
-       remaining parts are filled with spaces.  spc_rows 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.  spc_columns  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 menu_spacing passes back the spacing info for
-       the menu. If a pointer is NULL, this specific info is sim-
-       ply not returned.
+       The function set_menu_spacing sets the spacing information
+       for the menu.  Its parameter spc_description controls  the
+       number of spaces between an item name and an item descrip-
+       tion.  It must not be larger than TABSIZE.  The menu  sys-
+       tem  puts in the middle of this spacing area the pad char-
+       acter.  The remaining parts are filled with  spaces.   The
+       spc_rows  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 spc_columns 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 menu_spacing passes back the spacing info for
+       the  menu.   If  a  pointer is NULL, this specific info is
+       simply not returned.

RETURN VALUE

-       Both routines return E_OK on success. set_menu_spacing may
-       return  E_POSTED  if the menu is posted, or E_BAD_ARGUMENT
-       if one of the spacing values is out of range.
+       Both routines return E_OK  on  success.   set_menu_spacing
+       may  return E_POSTED if the menu is posted, or E_BAD_ARGU-
+       MENT if one of the spacing values is out of range.

NOTES

-       The header file <menu.h> automatically includes the header
-       file <curses.h>.
+       The header file <menu.h> automatically includes the header
+       file <curses.h>.

@@ -72,6 +115,10 @@

AUTHORS

        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
        curses by Eric S. Raymond.
+
+
+
+                                                       menu_spacing(3x)