1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 1998-2008,2010 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.20 2010/12/04 18:38:55 tom Exp @
34 <TITLE>menu_driver 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 <H1>menu_driver 3x</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
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>
50 <STRONG>menu_driver</STRONG> - command-processing loop of the menu system
54 <H2>SYNOPSIS</H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
56 int menu_driver(MENU *menu, int c);
60 <H2>DESCRIPTION</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
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.
140 <STRONG>MOUSE</STRONG> <STRONG>HANDLING</STRONG>
141 If the second argument is the KEY_MOUSE special key, the
142 associated mouse event is translated into one of the above
143 pre-defined requests. Currently only clicks in the user
144 window (e.g., inside the menu display area or the decora-
145 tion window) are handled.
147 If you click above the display region of the menu:
149 <STRONG>o</STRONG> a REQ_SCR_ULINE is generated for a single click,
151 <STRONG>o</STRONG> a REQ_SCR_UPAGE is generated for a double-click and
153 <STRONG>o</STRONG> a REQ_FIRST_ITEM is generated for a triple-click.
155 If you click below the display region of the menu:
157 <STRONG>o</STRONG> a REQ_SCR_DLINE is generated for a single click,
159 <STRONG>o</STRONG> a REQ_SCR_DPAGE is generated for a double-click and
161 <STRONG>o</STRONG> a REQ_LAST_ITEM is generated for a triple-click.
163 If you click at an item inside the display area of the
166 <STRONG>o</STRONG> the menu cursor is positioned to that item.
168 <STRONG>o</STRONG> If you double-click an item a REQ_TOGGLE_ITEM is gen-
169 erated and <STRONG>E_UNKNOWN_COMMAND</STRONG> is returned. This return
170 value makes sense, because a double click usually
171 means that an item-specific action should be returned.
172 It is exactly the purpose of this return value to sig-
173 nal that an application specific command should be
176 <STRONG>o</STRONG> If a translation into a request was done, <STRONG>menu_driver</STRONG>
177 returns the result of this request.
179 If you clicked outside the user window or the mouse event
180 could not be translated into a menu request an
181 <STRONG>E_REQUEST_DENIED</STRONG> is returned.
183 <STRONG>APPLICATION-DEFINED</STRONG> <STRONG>COMMANDS</STRONG>
184 If the second argument is neither printable nor one of the
185 above pre-defined menu requests or KEY_MOUSE, the drive
186 assumes it is an application-specific command and returns
187 <STRONG>E_UNKNOWN_COMMAND</STRONG>. Application-defined commands should be
188 defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of
189 these pre-defined requests.
193 <H2>RETURN VALUE</H2><PRE>
194 <STRONG>menu_driver</STRONG> return one of the following error codes:
196 <STRONG>E_OK</STRONG> The routine succeeded.
198 <STRONG>E_SYSTEM_ERROR</STRONG>
199 System error occurred (see <STRONG>errno</STRONG>).
201 <STRONG>E_BAD_ARGUMENT</STRONG>
202 Routine detected an incorrect or out-of-range argu-
205 <STRONG>E_BAD_STATE</STRONG>
206 Routine was called from an initialization or termina-
209 <STRONG>E_NOT_POSTED</STRONG>
210 The menu has not been posted.
212 <STRONG>E_UNKNOWN_COMMAND</STRONG>
213 The menu driver code saw an unknown request code.
215 <STRONG>E_NO_MATCH</STRONG>
216 Character failed to match.
218 <STRONG>E_REQUEST_DENIED</STRONG>
219 The menu driver could not process the request.
223 <H2>SEE ALSO</H2><PRE>
224 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>, <STRONG><A HREF="getch.3x.html">getch(3x)</A></STRONG>.
229 The header file <STRONG><menu.h></STRONG> automatically includes the header
230 files <STRONG><curses.h></STRONG>.
234 <H2>PORTABILITY</H2><PRE>
235 These routines emulate the System V menu library. They
236 were not supported on Version 7 or BSD versions. The sup-
237 port for mouse events is ncurses specific.
241 <H2>AUTHORS</H2><PRE>
242 Juergen Pfeifer. Manual pages and adaptation for new
243 curses by Eric S. Raymond.
247 <STRONG><A HREF="menu_driver.3x.html">menu_driver(3x)</A></STRONG>
251 Man(1) output converted with
252 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>