X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_spacing.3x.html;h=df9c562be5c7cdcfbb8ffacbd07bd2d23a913b11;hp=f7a812eac9077ab03e3d0adb078a9a6abbdc159d;hb=HEAD;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280 diff --git a/doc/html/man/menu_spacing.3x.html b/doc/html/man/menu_spacing.3x.html index f7a812ea..6857baf4 100644 --- a/doc/html/man/menu_spacing.3x.html +++ b/doc/html/man/menu_spacing.3x.html @@ -1,7 +1,6 @@ - -menu_spacing 3x +menu_spacing 3x 2024-03-16 ncurses 6.4 Library calls - + -

menu_spacing 3x

+

menu_spacing 3x 2024-03-16 ncurses 6.4 Library calls

-menu_spacing(3x)                                              menu_spacing(3x)
+menu_spacing(3x)                 Library calls                menu_spacing(3x)
 
 
 
@@ -54,50 +53,52 @@

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);
+
+       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);

DESCRIPTION

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

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

SEE ALSO

-       curses(3x), curs_variables(3x), menu(3x).
+       The function menu_spacing returns the spacing information for the menu.
+       If  a  pointer  is  NULL,  the  corresponding information is simply not
+       returned.
 
 
-

NOTES

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

PORTABILITY

-       These  routines  are  specific  to ncurses.  They were not supported on
+       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.
 
@@ -107,8 +108,12 @@
        Raymond.
 
 
+

SEE ALSO

+       curses(3x), curs_variables(3x), menu(3x)
+
+
 
-                                                              menu_spacing(3x)
+ncurses 6.4                       2024-03-16                  menu_spacing(3x)