X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_spacing.3x.html;h=1521ee4c6edbbf5c8763749eecdb71ff626ee93f;hb=67327e4e3b2121f8273fb73ec14ef234ed01231e;hp=ba2cd1cdf9b992b71857513228c2943d994bd8dd;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/menu_spacing.3x.html b/doc/html/man/menu_spacing.3x.html index ba2cd1cd..1521ee4c 100644 --- a/doc/html/man/menu_spacing.3x.html +++ b/doc/html/man/menu_spacing.3x.html @@ -1,82 +1,130 @@ + + + + + +menu_spacing 3x 2023-12-16 ncurses 6.4 Library calls + + + +

menu_spacing 3x 2023-12-16 ncurses 6.4 Library calls

-
+menu_spacing(3x)                 Library calls                menu_spacing(3x)
 
-
-

NAME

-       menu_spacing - Control spacing between menu items.
 
 
-
-

SYNOPSIS

-       #include <menu.h>
-       int set_menu_spacing(MENU *menu,
-                            int spc_description
-                            int spc_rows,
-                            int spc_columns);
-       int menu_spacing(const MENU *menu,
-                        int* spc_description
-                        int* spc_rows,
-                        int* spc_columns);
 
+

NAME

+       set_menu_spacing,  menu_spacing  -  set  and  get  spacing between menu
+       items.
 
-
-

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.
 
+

SYNOPSIS

+       #include <menu.h>
 
-
-

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.
+       int set_menu_spacing(MENU *menu,
+                            int spc_description,
+                            int spc_rows,
+                            int spc_columns);
+       int menu_spacing(const MENU *menu,
+                        int* spc_description,
+                        int* spc_rows,
+                        int* spc_columns);
 
 
-
-

SEE ALSO

-       curses(3x), menu(3x).
+

DESCRIPTION

+       The function set_menu_spacing sets  the  spacing  information  for  the
+       menu.  Its parameters provide the description and the size (in rows and
+       columns).
 
+       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.
 
-
-

NOTES

-       The header file <menu.h> automatically includes the header
-       file <curses.h>.
+       spc_rows
+              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.
 
+       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.
 
-
-

PORTABILITY

-       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.
+       The function menu_spacing returns the spacing information for the menu.
+       If  a  pointer  is  NULL,  the  corresponding information 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.
+
+
+

PORTABILITY

+       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 conditioned using NCURSES_VERSION.
+
+
+

AUTHORS

+       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
+       Raymond.
+
+
+

SEE ALSO

+       curses(3x), curs_variables(3x), menu(3x)
+
+
+
+ncurses 6.4                       2023-12-16                  menu_spacing(3x)
-

AUTHORS

-       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
-       curses by Eric S. Raymond.
-
-
-
-Man(1) output converted with -man2html -
+
+ +