doc/html/man/menu_spacing.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2022,2023 Thomas E. Dickey                                *
   5   * Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
   6   *                                                                          *
   7   * Permission is hereby granted, free of charge, to any person obtaining a  *
   8   * copy of this software and associated documentation files (the            *
   9   * "Software"), to deal in the Software without restriction, including      *
  10   * without limitation the rights to use, copy, modify, merge, publish,      *
  11   * distribute, distribute with modifications, sublicense, and/or sell       *
  12   * copies of the Software, and to permit persons to whom the Software is    *
  13   * furnished to do so, subject to the following conditions:                 *
  14   *                                                                          *
  15   * The above copyright notice and this permission notice shall be included  *
  16   * in all copies or substantial portions of the Software.                   *
  17   *                                                                          *
  18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  25   *                                                                          *
  26   * Except as contained in this notice, the name(s) of the above copyright   *
  27   * holders shall not be used in advertising or otherwise to promote the     *
  28   * sale, use or other dealings in this Software without prior written       *
  29   * authorization.                                                           *
  30   ****************************************************************************
  31   * @Id: menu_spacing.3x,v 1.31 2023/09/30 23:44:51 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>menu_spacing 3x 2023-09-30 ncurses 6.4 Library calls</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">menu_spacing 3x 2023-09-30 ncurses 6.4 Library calls</H1>
  44 <PRE>
  45 <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>                 Library calls                <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>set_menu_spacing</STRONG>,  <STRONG>menu_spacing</STRONG>  -  set  and  get  spacing between menu
  52        items.
  53
  54
  55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  57
  58        <STRONG>int</STRONG> <STRONG>set_menu_spacing(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG>
  59                             <STRONG>int</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>description</EM><STRONG>,</STRONG>
  60                             <STRONG>int</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>rows</EM><STRONG>,</STRONG>
  61                             <STRONG>int</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>columns</EM><STRONG>);</STRONG>
  62        <STRONG>int</STRONG> <STRONG>menu_spacing(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG>
  63                         <STRONG>int*</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>description</EM><STRONG>,</STRONG>
  64                         <STRONG>int*</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>rows</EM><STRONG>,</STRONG>
  65                         <STRONG>int*</STRONG> <EM>spc</EM><STRONG>_</STRONG><EM>columns</EM><STRONG>);</STRONG>
  66
  67
  68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  69        The function <STRONG>set_menu_spacing</STRONG> sets  the  spacing  information  for  the
  70        menu.  Its parameters provide the description and the size (in rows and
  71        columns).
  72
  73        <EM>spc</EM><STRONG>_</STRONG><EM>description</EM>
  74               controls the number of spaces between an item name and  an  item
  75               description.   It  must  not  be  larger than <STRONG>TABSIZE</STRONG>.  The menu
  76               system  puts  in  the  middle  of  this  spacing  area  the  pad
  77               character.  The remaining parts are filled with spaces.
  78
  79        <EM>spc</EM><STRONG>_</STRONG><EM>rows</EM>
  80               controls  the number of rows that are used for an item.  It must
  81               not be larger than 3.  The menu system inserts the  blank  lines
  82               between item rows, these lines will contain the pad character in
  83               the appropriate positions.
  84
  85        <EM>spc</EM><STRONG>_</STRONG><EM>columns</EM>
  86               controls the number of blanks between columns of items.  It must
  87               not  be  larger  than <STRONG>TABSIZE</STRONG>.  A value of 0 for all the spacing
  88               values resets them to the default, which is 1 for all of them.
  89
  90        The function <STRONG>menu_spacing</STRONG> returns the spacing information for the menu.
  91        If  a  pointer  is  NULL,  the  corresponding information is simply not
  92        returned.
  93
  94
  95 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  96        Both routines return <STRONG>E_OK</STRONG>  on  success.   <STRONG>set_menu_spacing</STRONG>  may  return
  97        <STRONG>E_POSTED</STRONG> if the menu is posted, or <STRONG>E_BAD_ARGUMENT</STRONG> if one of the spacing
  98        values is out of range.
  99
 100
 101 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 102        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
 103        <STRONG>&lt;curses.h&gt;</STRONG>.
 104
 105
 106 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 107        These  routines  are  specific  to ncurses.  They were not supported on
 108        Version 7, BSD or System V implementations.  It is recommended that any
 109        code depending on them be conditioned using NCURSES_VERSION.
 110
 111
 112 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 113        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 114        Raymond.
 115
 116
 117 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 118        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
 119
 120
 121
 122 ncurses 6.4                       2023-09-30                  <STRONG><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></STRONG>
 123 </PRE>
 124 <div class="nav">
 125 <ul>
 126 <li><a href="#h2-NAME">NAME</a></li>
 127 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 128 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 129 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 130 <li><a href="#h2-NOTES">NOTES</a></li>
 131 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 132 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 133 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 134 </ul>
 135 </div>
 136 </BODY>
 137 </HTML>