1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc. *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a *
5 .\" copy of this software and associated documentation files (the *
6 .\" "Software"), to deal in the Software without restriction, including *
7 .\" without limitation the rights to use, copy, modify, merge, publish, *
8 .\" distribute, distribute with modifications, sublicense, and/or sell *
9 .\" copies of the Software, and to permit persons to whom the Software is *
10 .\" furnished to do so, subject to the following conditions: *
12 .\" The above copyright notice and this permission notice shall be included *
13 .\" in all copies or substantial portions of the Software. *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 .\" Except as contained in this notice, the name(s) of the above copyright *
24 .\" holders shall not be used in advertising or otherwise to promote the *
25 .\" sale, use or other dealings in this Software without prior written *
27 .\"***************************************************************************
29 .\" $Id: menu_driver.3x,v 1.15 2008/06/21 21:55:30 tom Exp $
32 \fBmenu_driver\fR - command-processing loop of the menu system
34 \fB#include <menu.h>\fR
36 int menu_driver(MENU *menu, int c);
39 Once a menu has been posted (displayed), you should funnel input events to it
40 through \fBmenu_driver\fR. This routine has three major input cases:
43 The input is a form navigation request.
44 Navigation request codes are constants defined in \fB<form.h>\fP,
45 which are distinct from the key- and character codes returned by \fBwgetch\fP.
48 The input is a printable character.
49 Printable characters (which must be positive, less than 256) are
50 checked according to the program's locale settings.
53 The input is the KEY_MOUSE special key associated with an mouse event.
55 The menu driver requests are as follows:
61 Move right to an item.
82 Move to the first item.
85 Move to the last item.
88 Move to the next item.
91 Move to the previous item.
94 Select/deselect an item.
97 Clear the menu pattern buffer.
100 Delete the previous character from the pattern buffer.
103 Move to the next item matching the pattern match.
106 Move to the previous item matching the pattern match.
108 If the second argument is a printable character, the code appends
109 it to the pattern buffer and attempts to move to the next item matching
110 the new pattern. If there is no such match, \fBmenu_driver\fR returns
111 \fBE_NO_MATCH\fR and deletes the appended character from the buffer.
113 If the second argument is one of the above pre-defined requests, the
114 corresponding action is performed.
117 If the second argument is the KEY_MOUSE special key, the associated
118 mouse event is translated into one of the above pre-defined requests.
119 Currently only clicks in the user window (e.g. inside the menu display
120 area or the decoration window) are handled.
122 If you click above the display region of the menu:
125 a REQ_SCR_ULINE is generated for a single click,
127 a REQ_SCR_UPAGE is generated for a double-click and
129 a REQ_FIRST_ITEM is generated for a triple-click.
132 If you click below the display region of the menu:
135 a REQ_SCR_DLINE is generated for a single click,
137 a REQ_SCR_DPAGE is generated for a double-click and
139 a REQ_LAST_ITEM is generated for a triple-click.
142 If you click at an item inside the display area of the menu:
146 the menu cursor is positioned to that item.
149 If you double-click an item a REQ_TOGGLE_ITEM
150 is generated and \fBE_UNKNOWN_COMMAND\fR is returned.
151 This return value makes sense,
152 because a double click usually means that an item-specific action should
154 It is exactly the purpose of this return value to signal that an
155 application specific command should be executed.
159 into a request was done, \fBmenu_driver\fR returns the result of this request.
162 If you clicked outside the user window or the mouse event could not be translated
163 into a menu request an \fBE_REQUEST_DENIED\fR is returned.
164 .SS APPLICATION-DEFINED COMMANDS
166 If the second argument is neither printable nor one of the above
167 pre-defined menu requests or KEY_MOUSE, the drive assumes it is an application-specific
168 command and returns \fBE_UNKNOWN_COMMAND\fR. Application-defined commands
169 should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these
170 pre-defined requests.
172 \fBmenu_driver\fR return one of the following error codes:
175 The routine succeeded.
178 System error occurred (see \fBerrno\fR).
181 Routine detected an incorrect or out-of-range argument.
184 Routine was called from an initialization or termination function.
187 The menu has not been posted.
190 The menu driver code saw an unknown request code.
193 Character failed to match.
196 The menu driver could not process the request.
202 The header file \fB<menu.h>\fR automatically includes the header files
205 These routines emulate the System V menu library. They were not supported on
206 Version 7 or BSD versions. The support for mouse events is ncurses specific.
208 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
211 .\"# The following sets edit modes for GNU EMACS
212 .\"# Local Variables: