2 ****************************************************************************
3 * Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************
29 * @Id: menu_driver.3x,v 1.20 2010/12/04 18:38:55 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>menu_driver 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 <H1 class="no-header">menu_driver 3x</H1>
43 <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 <H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>menu_driver</STRONG> - command-processing loop of the menu system
54 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
56 int menu_driver(MENU *menu, int c);
60 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61 Once a menu has been posted (displayed), you should funnel
62 input events to it through <STRONG>menu_driver</STRONG>. This routine has
63 three major input cases:
65 <STRONG>o</STRONG> The input is a form navigation request. Navigation
66 request codes are constants defined in <STRONG><form.h></STRONG>, which
67 are distinct from the key- and character codes
68 returned by <STRONG>wgetch</STRONG>.
70 <STRONG>o</STRONG> The input is a printable character. Printable charac-
71 ters (which must be positive, less than 256) are
72 checked according to the program's locale settings.
74 <STRONG>o</STRONG> The input is the KEY_MOUSE special key associated with
77 The menu driver requests are as follows:
83 Move right to an item.
104 Move to the first item.
107 Move to the last item.
110 Move to the next item.
113 Move to the previous item.
116 Select/deselect an item.
119 Clear the menu pattern buffer.
122 Delete the previous character from the pattern buf-
126 Move to the next item matching the pattern match.
129 Move to the previous item matching the pattern match.
131 If the second argument is a printable character, the code
132 appends it to the pattern buffer and attempts to move to
133 the next item matching the new pattern. If there is no
134 such match, <STRONG>menu_driver</STRONG> returns <STRONG>E_NO_MATCH</STRONG> and deletes the
135 appended character from the buffer.
137 If the second argument is one of the above pre-defined
138 requests, the corresponding action is performed.
142 <H3><a name="h3-MOUSE-HANDLING">MOUSE HANDLING</a></H3><PRE>
143 If the second argument is the KEY_MOUSE special key, the
144 associated mouse event is translated into one of the above
145 pre-defined requests. Currently only clicks in the user
146 window (e.g., inside the menu display area or the decora-
147 tion window) are handled.
149 If you click above the display region of the menu:
151 <STRONG>o</STRONG> a REQ_SCR_ULINE is generated for a single click,
153 <STRONG>o</STRONG> a REQ_SCR_UPAGE is generated for a double-click and
155 <STRONG>o</STRONG> a REQ_FIRST_ITEM is generated for a triple-click.
157 If you click below the display region of the menu:
159 <STRONG>o</STRONG> a REQ_SCR_DLINE is generated for a single click,
161 <STRONG>o</STRONG> a REQ_SCR_DPAGE is generated for a double-click and
163 <STRONG>o</STRONG> a REQ_LAST_ITEM is generated for a triple-click.
165 If you click at an item inside the display area of the
168 <STRONG>o</STRONG> the menu cursor is positioned to that item.
170 <STRONG>o</STRONG> If you double-click an item a REQ_TOGGLE_ITEM is gen-
171 erated and <STRONG>E_UNKNOWN_COMMAND</STRONG> is returned. This return
172 value makes sense, because a double click usually
173 means that an item-specific action should be returned.
174 It is exactly the purpose of this return value to sig-
175 nal that an application specific command should be
178 <STRONG>o</STRONG> If a translation into a request was done, <STRONG>menu_driver</STRONG>
179 returns the result of this request.
181 If you clicked outside the user window or the mouse event
182 could not be translated into a menu request an
183 <STRONG>E_REQUEST_DENIED</STRONG> is returned.
187 <H3><a name="h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></H3><PRE>
188 If the second argument is neither printable nor one of the
189 above pre-defined menu requests or KEY_MOUSE, the drive
190 assumes it is an application-specific command and returns
191 <STRONG>E_UNKNOWN_COMMAND</STRONG>. Application-defined commands should be
192 defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of
193 these pre-defined requests.
197 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
198 <STRONG>menu_driver</STRONG> return one of the following error codes:
200 <STRONG>E_OK</STRONG> The routine succeeded.
202 <STRONG>E_SYSTEM_ERROR</STRONG>
203 System error occurred (see <STRONG>errno</STRONG>).
205 <STRONG>E_BAD_ARGUMENT</STRONG>
206 Routine detected an incorrect or out-of-range argu-
209 <STRONG>E_BAD_STATE</STRONG>
210 Routine was called from an initialization or termina-
213 <STRONG>E_NOT_POSTED</STRONG>
214 The menu has not been posted.
216 <STRONG>E_UNKNOWN_COMMAND</STRONG>
217 The menu driver code saw an unknown request code.
219 <STRONG>E_NO_MATCH</STRONG>
220 Character failed to match.
222 <STRONG>E_REQUEST_DENIED</STRONG>
223 The menu driver could not process the request.
227 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
228 <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>.
232 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
233 The header file <STRONG><menu.h></STRONG> automatically includes the header
234 files <STRONG><curses.h></STRONG>.
238 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
239 These routines emulate the System V menu library. They
240 were not supported on Version 7 or BSD versions. The sup-
241 port for mouse events is ncurses specific.
245 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
246 Juergen Pfeifer. Manual pages and adaptation for new
247 curses by Eric S. Raymond.
251 <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>
255 <li><a href="#h2-NAME">NAME</a></li>
256 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
257 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
259 <li><a href="#h3-MOUSE-HANDLING">MOUSE HANDLING</a></li>
260 <li><a href="#h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></li>
263 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
264 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
265 <li><a href="#h2-NOTES">NOTES</a></li>
266 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
267 <li><a href="#h2-AUTHORS">AUTHORS</a></li>