ncurses 5.3
[ncurses.git] / doc / html / man / menu_format.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998,2001 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.8 2001/08/04 20:36:19 William.Setzer Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>menu_format 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>menu_format 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>menu_format</STRONG> - set and get menu sizes
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
53        int set_menu_format(MENU *menu, int rows, int cols);
54        void menu_format(const MENU *menu, int *rows, int *cols);
55
56
57 </PRE>
58 <H2>DESCRIPTION</H2><PRE>
59        The function <STRONG>set_menu_format</STRONG> sets the maximum display size
60        of the given menu.  If this size is too small  to  display
61        all  menu items, the menu will be made scrollable. If this
62        size is larger than the menus subwindow and the  subwindow
63        is  too  small to display all menu items, <STRONG>post_menu()</STRONG> will
64        fail.
65
66        The  default  format  is  16  rows,  1  column.    Calling
67        <STRONG>set_menu_format</STRONG>  with a null menu pointer will change this
68        default.  A zero row or column argument to <STRONG>set_menu_format</STRONG>
69        is  interpreted  as  a  request  not to change the current
70        value.
71
72        The function <STRONG>menu_format</STRONG>  returns  the  maximum-size  con-
73        straints  for the given menu into the storage addressed by
74        <STRONG>rows</STRONG> and <STRONG>cols</STRONG>.
75
76
77 </PRE>
78 <H2>RETURN VALUE</H2><PRE>
79        These routines returns one of the following:
80
81        <STRONG>E_OK</STRONG> The routine succeeded.
82
83        <STRONG>E_SYSTEM_ERROR</STRONG>
84             System error occurred (see <STRONG>errno</STRONG>).
85
86        <STRONG>E_BAD_ARGUMENT</STRONG>
87             Routine detected an incorrect or  out-of-range  argu-
88             ment.
89
90        <STRONG>E_POSTED</STRONG>
91             The menu is already posted.
92
93
94 </PRE>
95 <H2>SEE ALSO</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>
100 <H2>NOTES</H2><PRE>
101        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
102        file <STRONG>&lt;curses.h&gt;</STRONG>.
103
104
105 </PRE>
106 <H2>PORTABILITY</H2><PRE>
107        These routines emulate the System V  menu  library.   They
108        were not supported on Version 7 or BSD versions.
109
110
111 </PRE>
112 <H2>AUTHORS</H2><PRE>
113        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
114        curses by Eric S. Raymond.
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>