X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu.3x.html;h=4f7409e2ab7a258512464525e490dfed0628c6ee;hb=a09e8b13568e210a03ca4ad64e8552c0edea07c5;hp=fc558ef77ac7437bd07c846969909eb73ae61b28;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;p=ncurses.git diff --git a/doc/html/man/menu.3x.html b/doc/html/man/menu.3x.html index fc558ef7..4f7409e2 100644 --- a/doc/html/man/menu.3x.html +++ b/doc/html/man/menu.3x.html @@ -1,8 +1,8 @@ - - +
+ +- -menu(3x) menu(3x) +menu(3x) menu(3x) --
+
menu - curses extension for programming menus --
+
#include <menu.h> --
- The menu 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 menu library uses the curses libraries, and a curses - initialization routine such as initscr must be called - before using any of these functions. To use the menu - library, link with the options -lmenu -lcurses. - - - Current Default Values for Item Attributes - The menu library maintains a default value for item - attributes. You can get or set this default by calling - the appropriate get_ or set_ routine with a NULL item - pointer. Changing this default with a set_ function - affects future item creations, but does not change the +
+ The menu library provides terminal-independent facilities for composing + menu systems on character-cell terminals. The library includes: item + routines, which create and modify menu items; and menu routines, which + group items into menus, display menus on the screen, and handle + interaction with the user. + + The menu library uses the curses libraries, and a curses initialization + routine such as initscr must be called before using any of these + functions. To use the menu library, link with the options -lmenu + -lcurses. + + +
+ The menu library maintains a default value for item attributes. You + can get or set this default by calling the appropriate get_ or set_ + routine with a NULL item pointer. Changing this default with a set_ + function affects future item creations, but does not change the rendering of items already created. - Routine Name Index - The following table lists each menu routine and the name - of the manual page on which it is described. +
+ The following table lists each menu routine and the name of the manual + page on which it is described. curses Routine Name Manual Page Name -------------------------------------------- @@ -112,11 +108,11 @@ menu_opts menu_opts(3x) menu_opts_off menu_opts(3x) menu_opts_on menu_opts(3x) - menu_pad menu_attributes(3x) menu_pattern menu_pattern(3x) menu_request_by_name menu_requestname(3x) menu_request_name menu_requestname(3x) + menu_spacing menu_spacing(3x) menu_sub menu_win(3x) menu_term menu_hook(3x) @@ -153,86 +149,102 @@ unpost_menu menu_post(3x) --
- Routines that return pointers return NULL on error. Rou- - tines that return an integer return one of the following - error codes: +
+ Routines that return pointers return NULL on error. Routines that + return an integer return one of the following error codes: E_OK The routine succeeded. - E_SYSTEM_ERROR - System error occurred (see errno). - E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. - - E_POSTED - The menu is already posted. + Routine detected an incorrect or out-of-range argument. E_BAD_STATE - Routine was called from an initialization or termina- - tion function. + Routine was called from an initialization or termination function. + + E_NO_MATCH + Character failed to match. E_NO_ROOM Menu is too large for its window. + E_NOT_CONNECTED + No items are connected to the menu. + E_NOT_POSTED The menu has not been posted. - E_UNKNOWN_COMMAND - The menu driver code saw an unknown request code. - - E_NO_MATCH - Character failed to match. - E_NOT_SELECTABLE The designated item cannot be selected. - E_NOT_CONNECTED - No items are connected to the menu. + E_POSTED + The menu is already posted. E_REQUEST_DENIED The menu driver could not process the request. + E_SYSTEM_ERROR + System error occurred (see errno(3)). --
- curses(3x) and related pages whose names begin "menu_" for - detailed descriptions of the entry points. + E_UNKNOWN_COMMAND + The menu driver code saw an unknown request code. --
- The header file <menu.h> automatically includes the header - files <curses.h> and <eti.h>. +
+ The header file <menu.h> automatically includes the header files + <curses.h> and <eti.h>. - 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 ld(1) and many other linkers). + In your library list, libmenu.a should be before libncurses.a; that is, + you should say "-lmenu -lncurses", not the other way around (which + would give a link-error when using static libraries). --
- These routines emulate the System V menu library. They - were not supported on Version 7 or BSD versions. +
+ These routines emulate the System V menu library. They were not + supported on Version 7 or BSD versions. + The menu facility was documented in SVr4.2 in Character User Interface + Programming (UNIX SVR4.2). --
- Juergen Pfeifer. Manual pages and adaptation for ncurses - by Eric S. Raymond. + It is not part of X/Open Curses. + + Aside from ncurses, there are few implementations: + + o systems based on SVr4 source code, e.g., Solaris. + + o NetBSD curses. + + +
+ Juergen Pfeifer. Manual pages and adaptation for ncurses by Eric S. + Raymond. + + +
+ curses(3x) and related pages whose names begin "menu_" for detailed + descriptions of the entry points. + + This describes ncurses version 6.3 (patch 20221210). - menu(3x) + menu(3x)-