ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / menu_driver.3x.html
1 <!--
2   ****************************************************************************
3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
4   * Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
5   *                                                                          *
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:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
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.                               *
24   *                                                                          *
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       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: menu_driver.3x,v 1.28 2020/12/19 21:33:37 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
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">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">menu_driver 3X</H1>
43 <PRE>
44 <B><A HREF="menu_driver.3X.html">menu_driver(3X)</A></B>                                                <B><A HREF="menu_driver.3X.html">menu_driver(3X)</A></B>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <B>menu_driver</B> - command-processing loop of the menu system
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <B>#include</B> <B>&lt;menu.h&gt;</B>
55
56        <B>int</B> <B>menu_driver(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>int</B> <I>c</I><B>);</B>
57
58
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60        Once a menu has been posted (displayed), you should funnel input events
61        to it through <B>menu_driver</B>.  This routine has three major input cases:
62
63        <B>o</B>   The input is a form navigation request.  Navigation  request  codes
64            are constants defined in <B>&lt;form.h&gt;</B>, which are distinct from the key-
65            and character codes returned by <B><A HREF="curs_getch.3X.html">wgetch(3X)</A></B>.
66
67        <B>o</B>   The input is a printable character.   Printable  characters  (which
68            must  be  positive,  less  than  256)  are checked according to the
69            program's locale settings.
70
71        <B>o</B>   The input is the KEY_MOUSE special key  associated  with  an  mouse
72            event.
73
74        The menu driver requests are as follows:
75
76        REQ_LEFT_ITEM
77             Move left to an item.
78
79        REQ_RIGHT_ITEM
80             Move right to an item.
81
82        REQ_UP_ITEM
83             Move up to an item.
84
85        REQ_DOWN_ITEM
86             Move down to an item.
87
88        REQ_SCR_ULINE
89             Scroll up a line.
90
91        REQ_SCR_DLINE
92             Scroll down a line.
93
94        REQ_SCR_DPAGE
95             Scroll down a page.
96
97        REQ_SCR_UPAGE
98             Scroll up a page.
99
100        REQ_FIRST_ITEM
101             Move to the first item.
102
103        REQ_LAST_ITEM
104             Move to the last item.
105
106        REQ_NEXT_ITEM
107             Move to the next item.
108
109        REQ_PREV_ITEM
110             Move to the previous item.
111
112        REQ_TOGGLE_ITEM
113             Select/deselect an item.
114
115        REQ_CLEAR_PATTERN
116             Clear the menu pattern buffer.
117
118        REQ_BACK_PATTERN
119             Delete the previous character from the pattern buffer.
120
121        REQ_NEXT_MATCH
122             Move to the next item matching the pattern match.
123
124        REQ_PREV_MATCH
125             Move to the previous item matching the pattern match.
126
127        If the second argument is a printable character, the code appends it to
128        the pattern buffer and attempts to move to the next item  matching  the
129        new pattern.  If there is no such match, <B>menu_driver</B> returns <B>E_NO_MATCH</B>
130        and deletes the appended character from the buffer.
131
132        If the second argument is one of the above  pre-defined  requests,  the
133        corresponding action is performed.
134
135
136 </PRE><H3><a name="h3-MOUSE-HANDLING">MOUSE HANDLING</a></H3><PRE>
137        If  the  second  argument  is the KEY_MOUSE special key, the associated
138        mouse event is translated into one of the above  pre-defined  requests.
139        Currently only clicks in the user window (e.g., inside the menu display
140        area or the decoration window) are handled.
141
142        If you click above the display region of the menu:
143
144        <B>o</B>   a REQ_SCR_ULINE is generated for a single click,
145
146        <B>o</B>   a REQ_SCR_UPAGE is generated for a double-click and
147
148        <B>o</B>   a REQ_FIRST_ITEM is generated for a triple-click.
149
150        If you click below the display region of the menu:
151
152        <B>o</B>   a REQ_SCR_DLINE is generated for a single click,
153
154        <B>o</B>   a REQ_SCR_DPAGE is generated for a double-click and
155
156        <B>o</B>   a REQ_LAST_ITEM is generated for a triple-click.
157
158        If you click at an item inside the display area of the menu:
159
160        <B>o</B>   the menu cursor is positioned to that item.
161
162        <B>o</B>   If you double-click an item  a  REQ_TOGGLE_ITEM  is  generated  and
163            <B>E_UNKNOWN_COMMAND</B>  is  returned.   This  return  value makes sense,
164            because a double click usually means that an  item-specific  action
165            should be returned.  It is exactly the purpose of this return value
166            to signal that an application specific command should be executed.
167
168        <B>o</B>   If a translation into a request was done, <B>menu_driver</B>  returns  the
169            result of this request.
170
171        If  you clicked outside the user window or the mouse event could not be
172        translated into a menu request an <B>E_REQUEST_DENIED</B> is returned.
173
174
175 </PRE><H3><a name="h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></H3><PRE>
176        If the second argument is neither printable nor one of the  above  pre-
177        defined  menu  requests  or  KEY_MOUSE,  the  drive  assumes  it  is an
178        application-specific    command    and    returns    <B>E_UNKNOWN_COMMAND</B>.
179        Application-defined commands should be defined relative to <B>MAX_COMMAND</B>,
180        the maximum value of these pre-defined requests.
181
182
183 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
184        <B>menu_driver</B> return one of the following error codes:
185
186        <B>E_OK</B> The routine succeeded.
187
188        <B>E_SYSTEM_ERROR</B>
189             System error occurred (see <B>errno(3)</B>).
190
191        <B>E_BAD_ARGUMENT</B>
192             Routine detected an incorrect or out-of-range argument.
193
194        <B>E_BAD_STATE</B>
195             Routine was called from an initialization or termination function.
196
197        <B>E_NOT_POSTED</B>
198             The menu has not been posted.
199
200        <B>E_UNKNOWN_COMMAND</B>
201             The menu driver code saw an unknown request code.
202
203        <B>E_NO_MATCH</B>
204             Character failed to match.
205
206        <B>E_REQUEST_DENIED</B>
207             The menu driver could not process the request.
208
209
210 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
211        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_getch.3X.html">getch(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
212
213
214 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
215        The header  file  <B>&lt;menu.h&gt;</B>  automatically  includes  the  header  files
216        <B>&lt;curses.h&gt;</B>.
217
218
219 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
220        These  routines  emulate  the  System  V  menu  library.  They were not
221        supported on Version 7 or BSD versions.  The support for  mouse  events
222        is ncurses specific.
223
224
225 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
226        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
227        Raymond.
228
229
230
231                                                                <B><A HREF="menu_driver.3X.html">menu_driver(3X)</A></B>
232 </PRE>
233 <div class="nav">
234 <ul>
235 <li><a href="#h2-NAME">NAME</a></li>
236 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
237 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
238 <ul>
239 <li><a href="#h3-MOUSE-HANDLING">MOUSE HANDLING</a></li>
240 <li><a href="#h3-APPLICATION-DEFINED-COMMANDS">APPLICATION-DEFINED COMMANDS</a></li>
241 </ul>
242 </li>
243 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
244 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
245 <li><a href="#h2-NOTES">NOTES</a></li>
246 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
247 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
248 </ul>
249 </div>
250 </BODY>
251 </HTML>