X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_driver.3x;h=5366040c18af024407a1157bcd58dd4004156626;hp=a256141ae7db6499de0fa77214c27aa914286fdd;hb=40cf934fff2d2790c060619e3a29bd54c20994b0;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/menu_driver.3x b/man/menu_driver.3x index a256141a..5366040c 100644 --- a/man/menu_driver.3x +++ b/man/menu_driver.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2008 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,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_driver.3x,v 1.12 2006/11/04 17:13:50 tom Exp $ +.\" $Id: menu_driver.3x,v 1.15 2008/06/21 21:55:30 tom Exp $ .TH menu_driver 3X "" .SH NAME \fBmenu_driver\fR - command-processing loop of the menu system @@ -37,9 +37,21 @@ 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's 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: +.TP 3 +- +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. +.TP 3 +- +The input is a printable character. +Printable characters (which must be positive, less than 256) are +checked according to the program's locale settings. +.TP 3 +- +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,34 +105,65 @@ 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. .PP If the second argument is one of the above pre-defined requests, the corresponding action is performed. +.SS MOUSE HANDLING .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 -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 +area or the decoration window) are handled. +.PP +If you click above the display region of the menu: +.RS +.TP +a REQ_SCR_ULINE is generated for a single click, +.TP +a REQ_SCR_UPAGE is generated for a double-click and +.TP +a REQ_FIRST_ITEM is generated for a triple-click. +.RE +.PP +If you click below the display region of the menu: +.RS +.TP +a REQ_SCR_DLINE is generated for a single click, +.TP +a REQ_SCR_DPAGE is generated for a double-click and +.TP +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 +- +the menu cursor is positioned to that item. +.TP 3 +- +If you double-click 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 is exactly the purpose of this return value to signal that an +application specific command should be executed. +.TP 3 +- +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 +.RE +.PP +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 @@ -152,7 +195,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), +\fBwgetch\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header files \fB\fR.