X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmenu_driver.3x;h=706005fa21649a4b28ef602d599d9ae088a3c554;hb=16fbf3f4f7d96b6ee6bf9159b22f26e05962aa3d;hp=39c520d74c2076e0022edb73c8c610a4ec3e7472;hpb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;p=ncurses.git diff --git a/man/menu_driver.3x b/man/menu_driver.3x index 39c520d7..706005fa 100644 --- a/man/menu_driver.3x +++ b/man/menu_driver.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2017,2018 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 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,22 +27,22 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_driver.3x,v 1.24 2018/07/28 22:08:59 tom Exp $ +.\" $Id: menu_driver.3x,v 1.31 2022/02/12 20:05:11 tom Exp $ .TH menu_driver 3X "" .de bP .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); +\fB#include \fP +.sp +\fBint menu_driver(MENU *\fImenu\fB, int \fIc\fB);\fR .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: +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, @@ -110,8 +111,8 @@ Move to the previous item matching the pattern match. 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. +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. @@ -143,7 +144,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. @@ -151,27 +152,27 @@ 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. +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\fR is returned. +into a menu request an \fBE_REQUEST_DENIED\fP 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 -command and returns \fBE_UNKNOWN_COMMAND\fR. Application-defined commands -should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these +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. @@ -191,12 +192,12 @@ 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), -\fBgetch\fR(3X). +\fBcurses\fP(3X), +\fBgetch\fP(3X), +\fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header files -\fB\fR. +The header file \fB\fP automatically includes the header files +\fB\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on