ncurses 6.2 - patch 20210515
[ncurses.git] / man / menu_format.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2015,2016 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 .\"
31 .\" $Id: menu_format.3x,v 1.18 2020/10/17 23:43:11 tom Exp $
32 .TH menu_format 3X ""
33 .SH NAME
34 \fBset_menu_format\fP,
35 \fBmenu_format\fP \- set and get menu sizes
36 .SH SYNOPSIS
37 \fB#include <menu.h>\fR
38 .sp
39 \fBint set_menu_format(MENU *\fP\fImenu\fP\fB, int \fP\fIrows\fP\fB, int \fP\fIcols\fP\fB);\fP
40 .br
41 \fBvoid menu_format(const MENU *\fP\fImenu\fP\fB, int *\fP\fIrows\fP\fB, int *\fP\fIcols\fP\fB);\fP
42 .br
43 .SH DESCRIPTION
44 The function \fBset_menu_format\fR sets the maximum display size of the given
45 menu.
46 If this size is too small to display all menu items, the menu will be
47 made scrollable.
48 If this size is larger than the menus subwindow and the
49 subwindow is too small to display all menu items, \fBpost_menu\fR will fail.
50 .PP
51 The default format is 16 rows, 1 column.
52 Calling \fBset_menu_format\fR with a
53 null menu pointer will change this default.
54 A zero row or column argument to
55 \fBset_menu_format\fR is interpreted as a request not to change the current
56 value.
57 .PP
58 The function \fBmenu_format\fR returns the maximum-size constraints for the
59 given menu into the storage addressed by \fBrows\fR and \fBcols\fR.
60 .SH RETURN VALUE
61 These routines returns one of the following:
62 .TP 5
63 .B E_OK
64 The routine succeeded.
65 .TP 5
66 .B E_SYSTEM_ERROR
67 System error occurred (see \fBerrno\fR(3)).
68 .TP 5
69 .B E_BAD_ARGUMENT
70 Routine detected an incorrect or out-of-range argument.
71 .TP 5
72 .B E_POSTED
73 The menu is already posted.
74 .TP 5
75 .B E_NOT_CONNECTED
76 No items are connected to the menu.
77 .SH SEE ALSO
78 \fBcurses\fR(3X), \fBmenu\fR(3X).
79 .SH NOTES
80 The header file \fB<menu.h>\fR automatically includes the header file
81 \fB<curses.h>\fR.
82 .SH PORTABILITY
83 These routines emulate the System V menu library.
84 They were not supported on
85 Version 7 or BSD versions.
86 .SH AUTHORS
87 Juergen Pfeifer.
88 Manual pages and adaptation for new curses by Eric S. Raymond.