ncurses 5.6 - patch 20070217
[ncurses.git] / man / menu_driver.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc.              *
3 .\"                                                                          *
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:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
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.                               *
22 .\"                                                                          *
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       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: menu_driver.3x,v 1.12 2006/11/04 17:13:50 tom Exp $
30 .TH menu_driver 3X ""
31 .SH NAME
32 \fBmenu_driver\fR - command-processing loop of the menu system
33 .SH SYNOPSIS
34 \fB#include <menu.h>\fR
35 .br
36 int menu_driver(MENU *menu, int c);
37 .br
38 .SH DESCRIPTION
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; either
41 the input is a menu navigation request, it's a printable ASCII character or it
42 is the KEY_MOUSE special key associated with an mouse event.
43 The menu driver requests are as follows:
44 .TP 5
45 REQ_LEFT_ITEM
46 Move left to an item.
47 .TP 5
48 REQ_RIGHT_ITEM
49 Move right to an item.
50 .TP 5
51 REQ_UP_ITEM
52 Move up to an item.
53 .TP 5
54 REQ_DOWN_ITEM
55 Move down to an item.
56 .TP 5
57 REQ_SCR_ULINE
58 Scroll up a line.
59 .TP 5
60 REQ_SCR_DLINE
61 Scroll down a line.
62 .TP 5
63 REQ_SCR_DPAGE
64 Scroll down a page.
65 .TP 5
66 REQ_SCR_UPAGE
67 Scroll up a page.
68 .TP 5
69 REQ_FIRST_ITEM
70 Move to the first item.
71 .TP 5
72 REQ_LAST_ITEM
73 Move to the last item.
74 .TP 5
75 REQ_NEXT_ITEM
76 Move to the next item.
77 .TP 5
78 REQ_PREV_ITEM
79 Move to the previous item.
80 .TP 5
81 REQ_TOGGLE_ITEM
82 Select/deselect an item.
83 .TP 5
84 REQ_CLEAR_PATTERN
85 Clear the menu pattern buffer.
86 .TP 5
87 REQ_BACK_PATTERN
88 Delete the previous character from the pattern buffer.
89 .TP 5
90 REQ_NEXT_MATCH
91 Move to the next item matching the pattern match.
92 .TP 5
93 REQ_PREV_MATCH
94 Move to the previous item matching the pattern match.
95 .PP
96 If the second argument is a printable ASCII character, the code appends
97 it to the pattern buffer and attempts to move to the next item matching
98 the new pattern.  If there is no such match, \fBmenu_driver\fR returns
99 \fBE_NO_MATCH\fR and deletes the appended character from the buffer.
100 .PP
101 If the second argument is one of the above pre-defined requests, the
102 corresponding action is performed.
103 .PP
104 If the second argument is the KEY_MOUSE special key, the associated
105 mouse event is translated into one of the above pre-defined requests.
106 Currently only clicks in the user window (e.g. inside the menu display
107 area or the decoration window) are handled. If you click above the
108 display region of the menu, a REQ_SCR_ULINE is generated, if you
109 doubleclick a REQ_SCR_UPAGE is generated and if you tripleclick a
110 REQ_FIRST_ITEM is generated. If you click below the display region of
111 the menu, a REQ_SCR_DLINE is generated, if you doubleclick a REQ_SCR_DPAGE
112 is generated and if you tripleclick a REQ_LAST_ITEM is generated. If you
113 click at an item inside the display area of the menu, the menu cursor
114 is positioned to that item. If you double-click at an item a REQ_TOGGLE_ITEM
115 is generated and \fBE_UNKNOWN_COMMAND\fR is returned. This return value makes
116 sense, because a double click usually means that an item-specific action should
117 be returned. It's exactly the purpose of this return value to signal that an
118 application specific command should be executed. If a translation
119 into a request was done, \fBmenu_driver\fR returns the result of this request.
120 If you clicked outside the user window or the mouse event couldn't be translated
121 into a menu request an \fBE_REQUEST_DENIED\fR is returned.
122 .PP
123 If the second argument is neither printable ASCII nor one of the above
124 pre-defined menu requests or KEY_MOUSE, the drive assumes it is an application-specific
125 command and returns \fBE_UNKNOWN_COMMAND\fR.  Application-defined commands
126 should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these
127 pre-defined requests.
128 .SH RETURN VALUE
129 \fBmenu_driver\fR return one of the following error codes:
130 .TP 5
131 .B E_OK
132 The routine succeeded.
133 .TP 5
134 .B E_SYSTEM_ERROR
135 System error occurred (see \fBerrno\fR).
136 .TP 5
137 .B E_BAD_ARGUMENT
138 Routine detected an incorrect or out-of-range argument.
139 .TP 5
140 .B E_BAD_STATE
141 Routine was called from an initialization or termination function.
142 .TP 5
143 .B E_NOT_POSTED
144 The menu has not been posted.
145 .TP 5
146 .B E_UNKNOWN_COMMAND
147 The menu driver code saw an unknown request code.
148 .TP 5
149 .B E_NO_MATCH
150 Character failed to match.
151 .TP 5
152 .B E_REQUEST_DENIED
153 The menu driver could not process the request.
154 .SH SEE ALSO
155 \fBcurses\fR(3X), \fBmenu\fR(3X).
156 .SH NOTES
157 The header file \fB<menu.h>\fR automatically includes the header files
158 \fB<curses.h>\fR.
159 .SH PORTABILITY
160 These routines emulate the System V menu library.  They were not supported on
161 Version 7 or BSD versions. The support for mouse events is ncurses specific.
162 .SH AUTHORS
163 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
164 S. Raymond.
165 .\"#
166 .\"# The following sets edit modes for GNU EMACS
167 .\"# Local Variables:
168 .\"# mode:nroff
169 .\"# fill-column:79
170 .\"# End: