ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / menu_format.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: menu_format.3x,v 1.13 2015/12/05 23:01:16 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_format 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">menu_format 3x</H1>
43 <PRE>
44 <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>                                         <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>
45
46
47
48
49 </PRE>
50 <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>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        int set_menu_format(MENU *menu, int rows, int cols);
58        void menu_format(const MENU *menu, int *rows, int *cols);
59
60
61 </PRE>
62 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The function <STRONG>set_menu_format</STRONG> sets the maximum display size
64        of the given menu.  If this size is too small  to  display
65        all  menu items, the menu will be made scrollable. If this
66        size is larger than the menus subwindow and the  subwindow
67        is  too  small to display all menu items, <STRONG>post_menu()</STRONG> will
68        fail.
69
70        The  default  format  is  16  rows,  1  column.    Calling
71        <STRONG>set_menu_format</STRONG>  with a null menu pointer will change this
72        default.  A zero row or column argument to <STRONG>set_menu_format</STRONG>
73        is  interpreted  as  a  request  not to change the current
74        value.
75
76        The function <STRONG>menu_format</STRONG>  returns  the  maximum-size  con-
77        straints  for the given menu into the storage addressed by
78        <STRONG>rows</STRONG> and <STRONG>cols</STRONG>.
79
80
81 </PRE>
82 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
83        These routines returns one of the following:
84
85        <STRONG>E_OK</STRONG> The routine succeeded.
86
87        <STRONG>E_SYSTEM_ERROR</STRONG>
88             System error occurred (see <STRONG>errno</STRONG>).
89
90        <STRONG>E_BAD_ARGUMENT</STRONG>
91             Routine detected an incorrect or  out-of-range  argu-
92             ment.
93
94        <STRONG>E_POSTED</STRONG>
95             The menu is already posted.
96
97        <STRONG>E_NOT_CONNECTED</STRONG>
98             No items are connected to the menu.
99
100
101 </PRE>
102 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
103        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
104
105
106 </PRE>
107 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
108        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
109        file <STRONG>&lt;curses.h&gt;</STRONG>.
110
111
112 </PRE>
113 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
114        These routines emulate the System V  menu  library.   They
115        were not supported on Version 7 or BSD versions.
116
117
118 </PRE>
119 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
120        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
121        curses by Eric S. Raymond.
122
123
124
125                                                         <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG>
126 </PRE>
127 <div class="nav">
128 <ul>
129 <li><a href="#h2-NAME">NAME</a></li>
130 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
131 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
132 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
133 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
134 <li><a href="#h2-NOTES">NOTES</a></li>
135 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
136 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
137 </ul>
138 </div>
139 </BODY>
140 </HTML>