X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_driver.3x;h=1fe5001fec056e8cb6a362fb2fb0caf53283f868;hp=bf7d8770a449aaba5f7edd6c5f891dd1751bb55a;hb=5e36f11feab6f790e0cc6f2c882a67b7b65e3b6b;hpb=3853a8e97d7efa8cb6a3c93c696d2c52895d6a70 diff --git a/man/menu_driver.3x b/man/menu_driver.3x index bf7d8770..1fe5001f 100644 --- a/man/menu_driver.3x +++ b/man/menu_driver.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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 * @@ -26,10 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_driver.3x,v 1.14 2007/06/02 22:50:09 tom Exp $ +.\" $Id: menu_driver.3x,v 1.20 2010/12/04 18:38:55 tom Exp $ .TH menu_driver 3X "" +.de bP +.IP \(bu 4 +.. .SH NAME -\fBmenu_driver\fR - command-processing loop of the menu system +\fBmenu_driver\fR \- command-processing loop of the menu system .SH SYNOPSIS \fB#include \fR .br @@ -37,9 +40,18 @@ int menu_driver(MENU *menu, int c); .br .SH DESCRIPTION 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 is a printable ASCII character or it -is the KEY_MOUSE special key associated with an mouse event. +through \fBmenu_driver\fR. This routine has three major input cases: +.bP +The input is a form navigation request. +Navigation request codes are constants defined in \fB\fP, +which are distinct from the key- and character codes returned by \fBwgetch\fP. +.bP +The input is a printable character. +Printable characters (which must be positive, less than 256) are +checked according to the program's locale settings. +.bP +The input is the KEY_MOUSE special key associated with an mouse event. +.PP The menu driver requests are as follows: .TP 5 REQ_LEFT_ITEM @@ -93,7 +105,7 @@ Move to the next item matching the pattern match. REQ_PREV_MATCH Move to the previous item matching the pattern match. .PP -If the second argument is a printable ASCII character, the code appends +If the second argument is a printable 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. @@ -104,36 +116,29 @@ corresponding action is performed. .PP 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 +Currently only clicks in the user window (e.g., inside the menu display area or the decoration window) are handled. .PP If you click above the display region of the menu: -.RS -.TP +.bP a REQ_SCR_ULINE is generated for a single click, -.TP +.bP a REQ_SCR_UPAGE is generated for a double-click and -.TP +.bP a REQ_FIRST_ITEM is generated for a triple-click. -.RE .PP If you click below the display region of the menu: -.RS -.TP +.bP a REQ_SCR_DLINE is generated for a single click, -.TP +.bP a REQ_SCR_DPAGE is generated for a double-click and -.TP +.bP a REQ_LAST_ITEM is generated for a triple-click. -.RE .PP If you click at an item inside the display area of the menu: -.RS -.TP 3 -- +.bP the menu cursor is positioned to that item. -.TP 3 -- +.bP If you double-click an item a REQ_TOGGLE_ITEM is generated and \fBE_UNKNOWN_COMMAND\fR is returned. This return value makes sense, @@ -141,17 +146,15 @@ because a double click usually means that an item-specific action should be returned. It is exactly the purpose of this return value to signal that an application specific command should be executed. -.TP 3 -- +.bP If a translation into a request was done, \fBmenu_driver\fR returns the result of this request. -.RE .PP -If you clicked outside the user window or the mouse event couldn't be translated +If you clicked outside the user window or the mouse event could not be translated into a menu request an \fBE_REQUEST_DENIED\fR is returned. .SS APPLICATION-DEFINED COMMANDS .PP -If the second argument is neither printable ASCII nor one of the above +If the second argument is neither printable 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 @@ -183,7 +186,9 @@ Character failed to match. .B E_REQUEST_DENIED The menu driver could not process the request. .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fR(3X), +\fBmenu\fR(3X), +\fBgetch\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header files \fB\fR. @@ -193,9 +198,3 @@ Version 7 or BSD versions. The support for mouse events is ncurses specific. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: