doc/html/man/menu_format.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   5   * Copyright 1998-2015,2016 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_format.3x,v 1.18 2020/10/17 23:43:11 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_format 3x</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">menu_format 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>                                                <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>set_menu_format</STRONG>, <STRONG>menu_format</STRONG> - set and get menu sizes
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>set_menu_format(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>rows</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>cols</EM><STRONG>);</STRONG>
  58        <STRONG>void</STRONG> <STRONG>menu_format(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>rows</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>cols</EM><STRONG>);</STRONG>
  59
  60
  61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  62        The function <STRONG>set_menu_format</STRONG> sets the maximum display size of the given
  63        menu.  If this size is too small to display all menu  items,  the  menu
  64        will  be  made  scrollable.   If  this  size  is  larger than the menus
  65        subwindow and the subwindow is too small to  display  all  menu  items,
  66        <STRONG>post_menu</STRONG> will fail.
  67
  68        The  default format is 16 rows, 1 column.  Calling <STRONG>set_menu_format</STRONG> with
  69        a null menu pointer will change this default.  A  zero  row  or  column
  70        argument  to  <STRONG>set_menu_format</STRONG> is interpreted as a request not to change
  71        the current value.
  72
  73        The function <STRONG>menu_format</STRONG> returns the maximum-size constraints  for  the
  74        given menu into the storage addressed by <STRONG>rows</STRONG> and <STRONG>cols</STRONG>.
  75
  76
  77 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  78        These routines returns one of the following:
  79
  80        <STRONG>E_OK</STRONG> The routine succeeded.
  81
  82        <STRONG>E_SYSTEM_ERROR</STRONG>
  83             System error occurred (see <STRONG>errno(3)</STRONG>).
  84
  85        <STRONG>E_BAD_ARGUMENT</STRONG>
  86             Routine detected an incorrect or out-of-range argument.
  87
  88        <STRONG>E_POSTED</STRONG>
  89             The menu is already posted.
  90
  91        <STRONG>E_NOT_CONNECTED</STRONG>
  92             No items are connected to the menu.
  93
  94
  95 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  96        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
  97
  98
  99 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 100        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
 101        <STRONG>&lt;curses.h&gt;</STRONG>.
 102
 103
 104 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 105        These routines emulate the  System  V  menu  library.   They  were  not
 106        supported on Version 7 or BSD versions.
 107
 108
 109 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 110        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 111        Raymond.
 112
 113
 114
 115                                                                <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>
 116 </PRE>
 117 <div class="nav">
 118 <ul>
 119 <li><a href="#h2-NAME">NAME</a></li>
 120 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 121 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 122 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 124 <li><a href="#h2-NOTES">NOTES</a></li>
 125 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 126 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 127 </ul>
 128 </div>
 129 </BODY>
 130 </HTML>