diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/menu.3x.html')
| -rw-r--r-- | ncurses-5.2/doc/html/man/menu.3x.html | 244 |
1 files changed, 244 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/menu.3x.html b/ncurses-5.2/doc/html/man/menu.3x.html new file mode 100644 index 0000000..c72b67f --- /dev/null +++ b/ncurses-5.2/doc/html/man/menu.3x.html @@ -0,0 +1,244 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>menu</B> - curses extension for programming menus + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>menu</B> library provides terminal-independent facilities + for composing menu systems on character-cell terminals. + The library includes: item routines, which create and mod- + ify menu items; and menu routines, which group items into + menus, display menus on the screen, and handle interaction + with the user. + + The <B>menu</B> library uses the <B>curses</B> libraries, and a curses + initialization routine such as <B>initscr</B> must be called + before using any of these functions. To use the <B>menu</B> + library, link with the options <B>-lmenu</B> <B>-lcurses</B>. + + + <B>Current</B> <B>Default</B> <B>Values</B> <B>for</B> <B>Item</B> <B>Attributes</B> + The <B>menu</B> library maintains a default value for item + attributes. You can get or set this default by calling + the appropriate <B>get_</B> or <B>set_</B> routine with a <B>NULL</B> item + pointer. Changing this default with a <B>set_</B> function + affects future item creations, but does not change the + rendering of items already created. + + + <B>Routine</B> <B>Name</B> <B>Index</B> + The following table lists each <B>menu</B> routine and the name + of the manual page on which it is described. + + <B>curses</B> Routine Name Manual Page Name + -------------------------------------------- + current_item <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + free_item <B><A HREF="mitem_new.3x.html">mitem_new(3x)</A></B> + free_menu <B><A HREF="menu_new.3x.html">menu_new(3x)</A></B> + item_count <B><A HREF="menu_items.3x.html">menu_items(3x)</A></B> + item_description <B><A HREF="mitem_name.3x.html">mitem_name(3x)</A></B> + item_index <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + item_init <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + item_name <B><A HREF="mitem_name.3x.html">mitem_name(3x)</A></B> + item_opts <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + item_opts_off <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + item_opts_on <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + item_term <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + item_userptr <B><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></B> + item_value <B><A HREF="mitem_value.3x.html">mitem_value(3x)</A></B> + item_visible <B><A HREF="mitem_visible.3x.html">mitem_visible(3x)</A></B> + menu_back <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + menu_driver <B><A HREF="menu_driver.3x.html">menu_driver(3x)</A></B> + menu_fore <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + + menu_format <B><A HREF="menu_format.3x.html">menu_format(3x)</A></B> + menu_grey <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + menu_init <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + menu_items <B><A HREF="menu_items.3x.html">menu_items(3x)</A></B> + menu_mark <B><A HREF="menu_mark.3x.html">menu_mark(3x)</A></B> + menu_opts <B><A HREF="menu_opts.3x.html">menu_opts(3x)</A></B> + menu_opts_off <B><A HREF="menu_opts.3x.html">menu_opts(3x)</A></B> + menu_opts_on <B><A HREF="menu_opts.3x.html">menu_opts(3x)</A></B> + menu_pad <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + menu_pattern <B><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></B> + menu_request_by_name <B><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></B> + menu_request_name <B><A HREF="menu_requestname.3x.html">menu_requestname(3x)</A></B> + menu_spacing <B><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></B> + menu_sub <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + menu_term <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + menu_userptr <B><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></B> + menu_win <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + new_item <B><A HREF="mitem_new.3x.html">mitem_new(3x)</A></B> + new_menu <B><A HREF="menu_new.3x.html">menu_new(3x)</A></B> + pos_menu_cursor <B><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></B> + post_menu <B><A HREF="menu_post.3x.html">menu_post(3x)</A></B> + scale_menu <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + set_current_item <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + set_item_init <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + set_item_opts <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + set_item_term <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + set_item_userptr <B><A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A></B> + set_item_value <B><A HREF="mitem_value.3x.html">mitem_value(3x)</A></B> + set_menu_back <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + set_menu_fore <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + set_menu_format <B><A HREF="menu_format.3x.html">menu_format(3x)</A></B> + set_menu_grey <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + set_menu_init <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + set_menu_items <B><A HREF="menu_items.3x.html">menu_items(3x)</A></B> + set_menu_mark <B><A HREF="menu_mark.3x.html">menu_mark(3x)</A></B> + set_menu_opts <B><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></B> + set_menu_pad <B><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></B> + set_menu_pattern <B><A HREF="menu_pattern.3x.html">menu_pattern(3x)</A></B> + set_menu_spacing <B><A HREF="menu_spacing.3x.html">menu_spacing(3x)</A></B> + set_menu_sub <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + set_menu_term <B><A HREF="menu_hook.3x.html">menu_hook(3x)</A></B> + set_menu_userptr <B><A HREF="menu_userptr.3x.html">menu_userptr(3x)</A></B> + set_menu_win <B><A HREF="menu_win.3x.html">menu_win(3x)</A></B> + set_top_row <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + top_row <B><A HREF="mitem_current.3x.html">mitem_current(3x)</A></B> + unpost_menu <B><A HREF="menu_post.3x.html">menu_post(3x)</A></B> + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + Routines that return pointers return <B>NULL</B> on error. Rou- + tines that return an integer return one of the following + error codes: + + <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. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or termina- + tion function. + + <B>E_NO_ROOM</B> + Menu is too large for its window. + + <B>E_NOT_POSTED</B> + The menu has not been posted. + + <B>E_UNKNOWN_COMMAND</B> + The menu driver code saw an unknown request code. + + <B>E_NO_MATCH</B> + Character failed to match. + + <B>E_NOT_SELECTABLE</B> + The designated item cannot be selected. + + <B>E_NOT_CONNECTED</B> + No items are connected to the menu. + + <B>E_REQUEST_DENIED</B> + The menu driver could not process the request. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B> and 3x pages whose names begin "menu_" for + detailed descriptions of the entry points. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + files <B><curses.h></B> and <B><eti.h></B>. + + In your library list, libmenu.a should be before libn- + curses.a; that is, you want to say `-lmenu -lncurses', not + the other way around (which would give you a link error + using GNU <B><A HREF="ld.1.html">ld(1)</A></B> and many other linkers). + + +</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 ncurses + 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> |