diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/menu_format.3x.html')
-rw-r--r-- | ncurses-5.2/doc/html/man/menu_format.3x.html | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/menu_format.3x.html b/ncurses-5.2/doc/html/man/menu_format.3x.html new file mode 100644 index 0000000..8702733 --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu_format.3x.html @@ -0,0 +1,136 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu_format</B> - set and get menu sizes + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + int set_menu_format(MENU *menu, int rows, int cols); + int menu_format(const MENU *menu, int *rows, int *cols); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_menu_format</B> 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, <B>post_menu()</B> will + fail. + + The default format is 16 rows, 1 column. Calling + <B>set_menu_format</B> with a null menu pointer will change this + default. A zero row or column argument to <B>set_menu_format</B> + is interpreted as a request not to change the current + value. + + The function <B>menu_format</B> returns the maximum-size con- + straints for the given menu into the storage addressed by + <B>rows</B> and <B>cols</B>. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + These routines returns one of the following: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_POSTED</B> + The menu is already posted. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |