X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_driver.3x;h=e395358296c46d8f131bf44041526739d79811ac;hp=1f5f28dcc69a2d43a405bc45dd9c2025817a2e3e;hb=HEAD;hpb=0ac2306dd3aaab1338d8b1458c15a7e476cfc3ff diff --git a/man/menu_driver.3x b/man/menu_driver.3x index 1f5f28dc..6a117283 100644 --- a/man/menu_driver.3x +++ b/man/menu_driver.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * +.\" Copyright 1998-2010,2017 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,25 +27,29 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_driver.3x,v 1.18 2010/09/18 20:20:39 tom Exp $ -.TH menu_driver 3X "" +.\" $Id: menu_driver.3x,v 1.47 2024/03/16 15:35:01 tom Exp $ +.TH menu_driver 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .SH NAME -\fBmenu_driver\fR \- command-processing loop of the menu system +\fBmenu_driver\fP \- +command-processing loop of the menu system .SH SYNOPSIS -\fB#include \fR -.br -int menu_driver(MENU *menu, int c); -.br +.nf +\fB#include +.PP +\fBint menu_driver(MENU *\fImenu\fP, int \fIc\fP); +.fi .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: +through \fBmenu_driver\fP. 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. +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 @@ -107,13 +112,13 @@ 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 -\fBE_NO_MATCH\fR and deletes the appended character from the buffer. +the new pattern. +If there is no such match, \fBmenu_driver\fP returns +\fBE_NO_MATCH\fP 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 +.SS "Mouse Handling" 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 @@ -140,7 +145,7 @@ If you click at an item inside the display area of the menu: the menu cursor is positioned to that item. .bP If you double-click an item a REQ_TOGGLE_ITEM -is generated and \fBE_UNKNOWN_COMMAND\fR is returned. +is generated and \fBE_UNKNOWN_COMMAND\fP is returned. This return value makes sense, because a double click usually means that an item-specific action should be returned. @@ -148,25 +153,26 @@ It is exactly the purpose of this return value to signal that an application specific command should be executed. .bP 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 -into a menu request an \fBE_REQUEST_DENIED\fR is returned. -.SS APPLICATION-DEFINED COMMANDS +into a request was done, \fBmenu_driver\fP returns the result of this request. .PP +If you clicked outside the user window +or the mouse event could not be translated +into a menu request an \fBE_REQUEST_DENIED\fP is returned. +.SS "Application-defined Commands" 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 +pre-defined menu requests or KEY_MOUSE, +the drive assumes it is an application-specific +command and returns \fBE_UNKNOWN_COMMAND\fP. Application-defined commands +should be defined relative to \fBMAX_COMMAND\fP, the maximum value of these pre-defined requests. .SH RETURN VALUE -\fBmenu_driver\fR return one of the following error codes: +\fBmenu_driver\fP return one of the following error codes: .TP 5 .B E_OK The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. @@ -185,22 +191,15 @@ Character failed to match. .TP 5 .B E_REQUEST_DENIED The menu driver could not process the request. -.SH SEE ALSO -\fBcurses\fR(3X), -\fBmenu\fR(3X), -\fBwgetch\fR(3X). -.SH NOTES -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 \fI\%ncurses\fP 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: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%getch\fP(3X), +\fB\%menu\fP(3X)