1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 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 * @Id: menu_format.3x,v 1.35 2024/03/16 15:35:01 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 https://invisible-island.net/scripts/readme.html#others_scripts"> 37<TITLE>menu_format 3x 2024-03-16 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">menu_format 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> Library calls <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>set_menu_format</STRONG>, <STRONG>menu_format</STRONG> - set and get menu sizes 51 52 53</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 54 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> 55 56 <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> 57 <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> 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 64 subwindow and the subwindow is too small to display all menu items, 65 <STRONG>post_menu</STRONG> 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-PORTABILITY">PORTABILITY</a></H2><PRE> 95 These routines emulate the System V menu library. They were not 96 supported on Version 7 or BSD versions. 97 98 99</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 100 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 101 Raymond. 102 103 104</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 105 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG> 106 107 108 109ncurses 6.5 2024-03-16 <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> 110</PRE> 111<div class="nav"> 112<ul> 113<li><a href="#h2-NAME">NAME</a></li> 114<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 115<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 116<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 117<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 118<li><a href="#h2-AUTHORS">AUTHORS</a></li> 119<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 120</ul> 121</div> 122</BODY> 123</HTML> 124