Diffstat (limited to 'contrib/ncurses/man/menu_driver.3x')
1 files changed, 170 insertions, 0 deletions
diff --git a/contrib/ncurses/man/menu_driver.3x b/contrib/ncurses/man/menu_driver.3x
new file mode 100644
@@ -0,0 +1,170 @@
+.\" Copyright (c) 1998 Free Software Foundation, Inc. *
+.\" Permission is hereby granted, free of charge, to any person obtaining a *
+.\" copy of this software and associated documentation files (the *
+.\" "Software"), to deal in the Software without restriction, including *
+.\" without limitation the rights to use, copy, modify, merge, publish, *
+.\" distribute, distribute with modifications, sublicense, and/or sell *
+.\" copies of the Software, and to permit persons to whom the Software is *
+.\" furnished to do so, subject to the following conditions: *
+.\" The above copyright notice and this permission notice shall be included *
+.\" in all copies or substantial portions of the Software. *
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+.\" Except as contained in this notice, the name(s) of the above copyright *
+.\" holders shall not be used in advertising or otherwise to promote the *
+.\" sale, use or other dealings in this Software without prior written *
+.\" authorization. *
+.'" $Id: menu_driver.3x,v 1.8 1999/01/09 22:55:18 tom Exp $
+.TH menu_driver 3X ""
+\fBmenu_driver\fR - command-processing loop of the menu system
+int menu_driver(MENU *menu, int c);
+Once a menu has been posted (displayed), you should funnel input events to it
+through \fBmenu_driver\fR. This routine has three major input cases; either
+the input is a menu navigation request, it's a printable ASCII character or it
+is the KEY_MOUSE special key associated with an mouse event.
+The menu driver requests are as follows:
+Move left to an item.
+Move right to an item.
+Move up to an item.
+Move down to an item.
+Scroll up a line.
+Scroll down a line.
+Scroll down a page.
+Scroll up a page.
+Move to the first item.
+Move to the last item.
+Move to the next item.
+Move to the previous item.
+Select/deselect an item.
+Clear the menu pattern buffer.
+Delete the previous character from the pattern buffer.
+Move to the next item matching the pattern match.
+Move to the previous item matching the pattern match.
+If the second argument is a printable ASCII character, the code appends
+it to the pattern buffer and attempts to move to the next item matching
+the new pattern. If there is no such match, \fBmenu_driver\fR returns
+\fBE_NO_MATCH\fR and deletes the appended character from the buffer.
+If the second argument is one of the above pre-defined requests, the
+corresponding action is performed.
+If the second argument is the KEY_MOUSE special key, the associated
+mouse event is translated into one of the above pre-defined requests.
+Currently only clicks in the user window (e.g. inside the menu display
+area or the decoration window) are handled. If you click above the
+display region of the menu, a REQ_SCR_ULINE is generated, if you
+doubleclick a REQ_SCR_UPAGE is generated and if you tripleclick a
+REQ_FIRST_ITEM is generated. If you click below the display region of
+the menu, a REQ_SCR_DLINE is generated, if you doubleclick a REQ_SCR_DPAGE
+is generated and if you tripleclick a REQ_LAST_ITEM is generated. If you
+click at an item inside the display area of the menu, the menu cursor
+is positioned to that item. If you double-click at an item a REQ_TOGGLE_ITEM
+is generated and \fBE_UNKNOWN_COMMAND\fR is returned. This return value makes
+sense, because a double click usually means that an item-specific action should
+be returned. It's exactly the purpose of this return value to signal that an
+application specific command should be executed. If a translation
+into a request was done, \fBmenu_driver\fR returns the result of this request.
+If you clicked outside the user window or the mouse event couldn't be translated
+into a menu request an \fBE_REQUEST_DENIED\fR is returned.
+If the second argument is neither printable ASCII nor one of the above
+pre-defined menu requests or KEY_MOUSE, the drive assumes it is an application-specific
+command and returns \fBE_UNKNOWN_COMMAND\fR. Application-defined commands
+should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these
+.SH RETURN VALUE
+\fBmenu_driver\fR return one of the following error codes:
+The routine succeeded.
+System error occurred (see \fBerrno\fR).
+Routine detected an incorrect or out-of-range argument.
+Routine was called from an initialization or termination function.
+The menu has not been posted.
+The menu driver code saw an unknown request code.
+Character failed to match.
+The menu driver could not process the request.
+.SH SEE ALSO
+The header file \fB<menu.h>\fR automatically includes the header files
+These routines emulate the System V menu library. They were not supported on
+Version 7 or BSD versions. The support for mouse events is ncurses specific.
+Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
+.\"# The following sets edit modes for GNU EMACS
+.\"# Local Variables: