ncurses 6.2 - patch 20200425
[ncurses.git] / 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.17 2020/02/02 23:34:34 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        int set_menu_format(MENU *menu, int rows, int cols);
57        void menu_format(const MENU *menu, int *rows, int *cols);
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        The function <STRONG>set_menu_format</STRONG> sets the maximum display size of the given
62        menu.  If this size is too small to display all menu  items,  the  menu
63        will be made scrollable.  If this size is larger than the menus subwin-
64        dow and the subwindow is too small to display all menu items, <STRONG>post_menu</STRONG>
65        will fail.
66
67        The  default format is 16 rows, 1 column.  Calling <STRONG>set_menu_format</STRONG> with
68        a null menu pointer will change this default.  A  zero  row  or  column
69        argument  to  <STRONG>set_menu_format</STRONG> is interpreted as a request not to change
70        the current value.
71
72        The function <STRONG>menu_format</STRONG> returns the maximum-size constraints  for  the
73        given menu into the storage addressed by <STRONG>rows</STRONG> and <STRONG>cols</STRONG>.
74
75
76 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
77        These routines returns one of the following:
78
79        <STRONG>E_OK</STRONG> The routine succeeded.
80
81        <STRONG>E_SYSTEM_ERROR</STRONG>
82             System error occurred (see <STRONG>errno(3)</STRONG>).
83
84        <STRONG>E_BAD_ARGUMENT</STRONG>
85             Routine detected an incorrect or out-of-range argument.
86
87        <STRONG>E_POSTED</STRONG>
88             The menu is already posted.
89
90        <STRONG>E_NOT_CONNECTED</STRONG>
91             No items are connected to the menu.
92
93
94 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
95        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
96
97
98 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
99        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
100        <STRONG>&lt;curses.h&gt;</STRONG>.
101
102
103 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
104        These routines emulate the System V menu library.  They were  not  sup-
105        ported on Version 7 or BSD versions.
106
107
108 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
109        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
110        Raymond.
111
112
113
114                                                                <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>
115 </PRE>
116 <div class="nav">
117 <ul>
118 <li><a href="#h2-NAME">NAME</a></li>
119 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
120 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
121 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
122 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
123 <li><a href="#h2-NOTES">NOTES</a></li>
124 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
125 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
126 </ul>
127 </div>
128 </BODY>
129 </HTML>