diff options
Diffstat (limited to 'doc/html/man/menu_driver.3x.html')
| -rw-r--r-- | doc/html/man/menu_driver.3x.html | 176 |
1 files changed, 85 insertions, 91 deletions
diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html index 4eaf63166795..5a35438e006a 100644 --- a/doc/html/man/menu_driver.3x.html +++ b/doc/html/man/menu_driver.3x.html @@ -1,7 +1,6 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2018,2019 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 * @@ -27,52 +26,48 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: menu_driver.3x,v 1.20 2010/12/04 18:38:55 tom Exp @ + * @Id: menu_driver.3x,v 1.25 2019/01/20 20:32:23 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>menu_driver 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>menu_driver 3x</H1> -<HR> +<H1 class="no-header">menu_driver 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> +<STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> -</PRE> -<H2>NAME</H2><PRE> +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> <STRONG>menu_driver</STRONG> - command-processing loop of the menu system -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> int menu_driver(MENU *menu, int c); -</PRE> -<H2>DESCRIPTION</H2><PRE> - Once a menu has been posted (displayed), you should funnel - input events to it through <STRONG>menu_driver</STRONG>. This routine has - three major input cases: +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + Once a menu has been posted (displayed), you should funnel input events + to it through <STRONG>menu_driver</STRONG>. This routine has three major input cases: - <STRONG>o</STRONG> The input is a form navigation request. Navigation - request codes are constants defined in <STRONG><form.h></STRONG>, which - are distinct from the key- and character codes - returned by <STRONG>wgetch</STRONG>. + <STRONG>o</STRONG> The input is a form navigation request. Navigation request codes + are constants defined in <STRONG><form.h></STRONG>, which are distinct from the key- + and character codes returned by <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG>. - <STRONG>o</STRONG> The input is a printable character. Printable charac- - ters (which must be positive, less than 256) are - checked according to the program's locale settings. + <STRONG>o</STRONG> The input is a printable character. Printable characters (which + must be positive, less than 256) are checked according to the pro- + gram's locale settings. - <STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with - an mouse event. + <STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with an mouse + event. The menu driver requests are as follows: @@ -119,8 +114,7 @@ Clear the menu pattern buffer. REQ_BACK_PATTERN - Delete the previous character from the pattern buf- - fer. + Delete the previous character from the pattern buffer. REQ_NEXT_MATCH Move to the next item matching the pattern match. @@ -128,21 +122,20 @@ REQ_PREV_MATCH Move to the previous item matching the pattern match. - If the second argument is a printable character, the code - appends it to the pattern buffer and attempts to move to - the next item matching the new pattern. If there is no - such match, <STRONG>menu_driver</STRONG> returns <STRONG>E_NO_MATCH</STRONG> and deletes the - appended character from the buffer. + If the second argument is a printable character, the code appends it to + the pattern buffer and attempts to move to the next item matching the + new pattern. If there is no such match, <STRONG>menu_driver</STRONG> returns <STRONG>E_NO_MATCH</STRONG> + and deletes the appended character from the buffer. + + If the second argument is one of the above pre-defined requests, the + corresponding action is performed. - If the second argument is one of the above pre-defined - requests, the corresponding action is performed. - <STRONG>MOUSE</STRONG> <STRONG>HANDLING</STRONG> - If the second argument is the KEY_MOUSE special key, the - associated mouse event is translated into one of the above - pre-defined requests. Currently only clicks in the user - window (e.g., inside the menu display area or the decora- - tion window) are handled. +</PRE><H3><a name="h3-MOUSE-HANDLING">MOUSE HANDLING</a></H3><PRE> + If the second argument is the KEY_MOUSE special key, the associated + mouse event is translated into one of the above pre-defined requests. + Currently only clicks in the user window (e.g., inside the menu display + area or the decoration window) are handled. If you click above the display region of the menu: @@ -160,51 +153,44 @@ <STRONG>o</STRONG> a REQ_LAST_ITEM is generated for a triple-click. - If you click at an item inside the display area of the - menu: + If you click at an item inside the display area of the menu: <STRONG>o</STRONG> the menu cursor is positioned to that item. - <STRONG>o</STRONG> If you double-click an item a REQ_TOGGLE_ITEM is gen- - erated and <STRONG>E_UNKNOWN_COMMAND</STRONG> is returned. This return - value makes sense, because a double click usually - means that an item-specific action should be returned. - It is exactly the purpose of this return value to sig- - nal that an application specific command should be - executed. + <STRONG>o</STRONG> If you double-click an item a REQ_TOGGLE_ITEM is generated and + <STRONG>E_UNKNOWN_COMMAND</STRONG> is returned. This return value makes sense, + because a double click usually means that an item-specific action + should be returned. It is exactly the purpose of this return value + to signal that an application specific command should be executed. - <STRONG>o</STRONG> If a translation into a request was done, <STRONG>menu_driver</STRONG> - returns the result of this request. + <STRONG>o</STRONG> If a translation into a request was done, <STRONG>menu_driver</STRONG> returns the + result of this request. - If you clicked outside the user window or the mouse event - could not be translated into a menu request an - <STRONG>E_REQUEST_DENIED</STRONG> is returned. + If you clicked outside the user window or the mouse event could not be + translated into a menu request an <STRONG>E_REQUEST_DENIED</STRONG> is returned. - <STRONG>APPLICATION-DEFINED</STRONG> <STRONG>COMMANDS</STRONG> - If the second argument is neither printable nor one of the - above pre-defined menu requests or KEY_MOUSE, the drive - assumes it is an application-specific command and returns - <STRONG>E_UNKNOWN_COMMAND</STRONG>. Application-defined commands should be - defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of - these pre-defined requests. +</PRE><H3><a name="h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></H3><PRE> + If the second argument is neither printable nor one of the above pre- + defined menu requests or KEY_MOUSE, the drive assumes it is an applica- + tion-specific command and returns <STRONG>E_UNKNOWN_COMMAND</STRONG>. Application- + defined commands should be defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum + value of these pre-defined requests. -</PRE> -<H2>RETURN VALUE</H2><PRE> + +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> <STRONG>menu_driver</STRONG> return one of the following error codes: <STRONG>E_OK</STRONG> The routine succeeded. <STRONG>E_SYSTEM_ERROR</STRONG> - System error occurred (see <STRONG>errno</STRONG>). + System error occurred (see <STRONG>errno(3)</STRONG>). <STRONG>E_BAD_ARGUMENT</STRONG> - Routine detected an incorrect or out-of-range argu- - ment. + Routine detected an incorrect or out-of-range argument. <STRONG>E_BAD_STATE</STRONG> - Routine was called from an initialization or termina- - tion function. + Routine was called from an initialization or termination function. <STRONG>E_NOT_POSTED</STRONG> The menu has not been posted. @@ -219,37 +205,45 @@ The menu driver could not process the request. -</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>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>. +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">getch(3x)</A></STRONG>. -</PRE> -<H2>NOTES</H2><PRE> - The header file <STRONG><menu.h></STRONG> automatically includes the header - files <STRONG><curses.h></STRONG>. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header files + <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. The sup- - port for mouse events is ncurses specific. +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + These routines emulate the System V menu library. They were not sup- + ported on Version 7 or BSD versions. The support for mouse events is + ncurses specific. -</PRE> -<H2>AUTHORS</H2><PRE> - Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. - <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> + <STRONG><A HREF="menu_driver.3x.html">menu_driver(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> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a> +<ul> +<li><a href="#h3-MOUSE-HANDLING">MOUSE HANDLING</a></li> +<li><a href="#h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></li> +</ul> +</li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-AUTHORS">AUTHORS</a></li> +</ul> +</div> </BODY> </HTML> |