2 ****************************************************************************
3 * Copyright 2018-2019,2020 Thomas E. Dickey *
4 * Copyright 1998-2010,2017 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: menu_driver.3x,v 1.26 2020/02/02 23:34:34 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_driver 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">menu_driver 3x</H1>
44 <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG> <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>menu_driver</STRONG> - command-processing loop of the menu system
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
55 int menu_driver(MENU *menu, int c);
58 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
59 Once a menu has been posted (displayed), you should funnel input events
60 to it through <STRONG>menu_driver</STRONG>. This routine has three major input cases:
62 <STRONG>o</STRONG> The input is a form navigation request. Navigation request codes
63 are constants defined in <STRONG><form.h></STRONG>, which are distinct from the key-
64 and character codes returned by <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG>.
66 <STRONG>o</STRONG> The input is a printable character. Printable characters (which
67 must be positive, less than 256) are checked according to the pro-
68 gram's locale settings.
70 <STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with an mouse
73 The menu driver requests are as follows:
79 Move right to an item.
100 Move to the first item.
103 Move to the last item.
106 Move to the next item.
109 Move to the previous item.
112 Select/deselect an item.
115 Clear the menu pattern buffer.
118 Delete the previous character from the pattern buffer.
121 Move to the next item matching the pattern match.
124 Move to the previous item matching the pattern match.
126 If the second argument is a printable character, the code appends it to
127 the pattern buffer and attempts to move to the next item matching the
128 new pattern. If there is no such match, <STRONG>menu_driver</STRONG> returns <STRONG>E_NO_MATCH</STRONG>
129 and deletes the appended character from the buffer.
131 If the second argument is one of the above pre-defined requests, the
132 corresponding action is performed.
135 </PRE><H3><a name="h3-MOUSE-HANDLING">MOUSE HANDLING</a></H3><PRE>
136 If the second argument is the KEY_MOUSE special key, the associated
137 mouse event is translated into one of the above pre-defined requests.
138 Currently only clicks in the user window (e.g., inside the menu display
139 area or the decoration window) are handled.
141 If you click above the display region of the menu:
143 <STRONG>o</STRONG> a REQ_SCR_ULINE is generated for a single click,
145 <STRONG>o</STRONG> a REQ_SCR_UPAGE is generated for a double-click and
147 <STRONG>o</STRONG> a REQ_FIRST_ITEM is generated for a triple-click.
149 If you click below the display region of the menu:
151 <STRONG>o</STRONG> a REQ_SCR_DLINE is generated for a single click,
153 <STRONG>o</STRONG> a REQ_SCR_DPAGE is generated for a double-click and
155 <STRONG>o</STRONG> a REQ_LAST_ITEM is generated for a triple-click.
157 If you click at an item inside the display area of the menu:
159 <STRONG>o</STRONG> the menu cursor is positioned to that item.
161 <STRONG>o</STRONG> If you double-click an item a REQ_TOGGLE_ITEM is generated and
162 <STRONG>E_UNKNOWN_COMMAND</STRONG> is returned. This return value makes sense,
163 because a double click usually means that an item-specific action
164 should be returned. It is exactly the purpose of this return value
165 to signal that an application specific command should be executed.
167 <STRONG>o</STRONG> If a translation into a request was done, <STRONG>menu_driver</STRONG> returns the
168 result of this request.
170 If you clicked outside the user window or the mouse event could not be
171 translated into a menu request an <STRONG>E_REQUEST_DENIED</STRONG> is returned.
174 </PRE><H3><a name="h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></H3><PRE>
175 If the second argument is neither printable nor one of the above pre-
176 defined menu requests or KEY_MOUSE, the drive assumes it is an applica-
177 tion-specific command and returns <STRONG>E_UNKNOWN_COMMAND</STRONG>. Application-
178 defined commands should be defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum
179 value of these pre-defined requests.
182 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
183 <STRONG>menu_driver</STRONG> return one of the following error codes:
185 <STRONG>E_OK</STRONG> The routine succeeded.
187 <STRONG>E_SYSTEM_ERROR</STRONG>
188 System error occurred (see <STRONG>errno(3)</STRONG>).
190 <STRONG>E_BAD_ARGUMENT</STRONG>
191 Routine detected an incorrect or out-of-range argument.
193 <STRONG>E_BAD_STATE</STRONG>
194 Routine was called from an initialization or termination function.
196 <STRONG>E_NOT_POSTED</STRONG>
197 The menu has not been posted.
199 <STRONG>E_UNKNOWN_COMMAND</STRONG>
200 The menu driver code saw an unknown request code.
202 <STRONG>E_NO_MATCH</STRONG>
203 Character failed to match.
205 <STRONG>E_REQUEST_DENIED</STRONG>
206 The menu driver could not process the request.
209 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
210 <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>.
213 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
214 The header file <STRONG><menu.h></STRONG> automatically includes the header files
215 <STRONG><curses.h></STRONG>.
218 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
219 These routines emulate the System V menu library. They were not sup-
220 ported on Version 7 or BSD versions. The support for mouse events is
224 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
225 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
230 <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>
234 <li><a href="#h2-NAME">NAME</a></li>
235 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
236 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
238 <li><a href="#h3-MOUSE-HANDLING">MOUSE HANDLING</a></li>
239 <li><a href="#h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></li>
242 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
243 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
244 <li><a href="#h2-NOTES">NOTES</a></li>
245 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
246 <li><a href="#h2-AUTHORS">AUTHORS</a></li>