X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_driver.3x;h=39c520d74c2076e0022edb73c8c610a4ec3e7472;hp=7612eeb84fd13c0b28340761689ffa1ac01d3c88;hb=321b81e6b3fa425daddac02420d862100dc3aac8;hpb=06078d3fa68db669ed37178c01873546b4b28745 diff --git a/man/menu_driver.3x b/man/menu_driver.3x index 7612eeb8..39c520d7 100644 --- a/man/menu_driver.3x +++ b/man/menu_driver.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2017 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2017,2018 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.22 2017/11/18 23:47:37 tom Exp $ +.\" $Id: menu_driver.3x,v 1.24 2018/07/28 22:08:59 tom Exp $ .TH menu_driver 3X "" .de bP .ie n .IP \(bu 4 @@ -45,7 +45,8 @@ 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(3X). +which are distinct from the key- and character codes +returned by \fBwgetch\fP(3X). .bP The input is a printable character. Printable characters (which must be positive, less than 256) are @@ -108,7 +109,8 @@ Move to the previous item matching the pattern match. .PP 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 +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 @@ -151,12 +153,14 @@ application specific command should be executed. If a translation into a request was done, \fBmenu_driver\fR returns the result of this request. .PP -If you clicked outside the user window or the mouse event could not 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 nor one of the above -pre-defined menu requests or KEY_MOUSE, the drive assumes it is an application-specific +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 pre-defined requests. @@ -194,8 +198,10 @@ The menu driver could not process the request. The header file \fB\fR automatically includes the header files \fB\fR. .SH PORTABILITY -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. +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. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.