diff options
Diffstat (limited to 'doc/html/man/menu_format.3x.html')
| -rw-r--r-- | doc/html/man/menu_format.3x.html | 133 |
1 files changed, 133 insertions, 0 deletions
diff --git a/doc/html/man/menu_format.3x.html b/doc/html/man/menu_format.3x.html new file mode 100644 index 0000000000000..c419406c35e44 --- /dev/null +++ b/doc/html/man/menu_format.3x.html @@ -0,0 +1,133 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + * t + **************************************************************************** + * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: menu_format.3x,v 1.12 2010/12/04 18:40:45 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>menu_format 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>menu_format 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>menu_format</STRONG> - set and get menu sizes + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> + int set_menu_format(MENU *menu, int rows, int cols); + void menu_format(const MENU *menu, int *rows, int *cols); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <STRONG>set_menu_format</STRONG> sets the maximum display size + of the given menu. If this size is too small to display + all menu items, the menu will be made scrollable. If this + size is larger than the menus subwindow and the subwindow + is too small to display all menu items, <STRONG>post_menu()</STRONG> will + fail. + + The default format is 16 rows, 1 column. Calling + <STRONG>set_menu_format</STRONG> with a null menu pointer will change this + default. A zero row or column argument to <STRONG>set_menu_format</STRONG> + is interpreted as a request not to change the current + value. + + The function <STRONG>menu_format</STRONG> returns the maximum-size con- + straints for the given menu into the storage addressed by + <STRONG>rows</STRONG> and <STRONG>cols</STRONG>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines returns one of the following: + + <STRONG>E_OK</STRONG> The routine succeeded. + + <STRONG>E_SYSTEM_ERROR</STRONG> + System error occurred (see <STRONG>errno</STRONG>). + + <STRONG>E_BAD_ARGUMENT</STRONG> + Routine detected an incorrect or out-of-range argu- + ment. + + <STRONG>E_POSTED</STRONG> + The menu is already posted. + + <STRONG>E_NOT_CONNECTED</STRONG> + No items are connected to the menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header + file <STRONG><curses.h></STRONG>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + These routines emulate the System V menu library. They + were not supported on Version 7 or BSD versions. + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + <STRONG><A HREF="menu_format.3x.html">menu_format(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |