X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_driver.3x;h=835d675178144459277e4563ef149432795011f4;hp=69961058ca76902d4c26dab15d0174e802b7ebb7;hb=d62b54c082a8564aa0c715cddadb1160498b057f;hpb=41068edef084c39be0cecdf949d9b538d925f42c diff --git a/man/menu_driver.3x b/man/menu_driver.3x index 69961058..835d6751 100644 --- a/man/menu_driver.3x +++ b/man/menu_driver.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 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,10 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_driver.3x,v 1.16 2010/01/30 21:29:04 tom Exp $ +.\" $Id: menu_driver.3x,v 1.21 2017/01/07 19:25:15 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 @@ -38,18 +41,15 @@ int menu_driver(MENU *menu, int c); .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: -.TP 3 -- +.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. -.TP 3 -- +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 checked according to the program's locale settings. -.TP 3 -- +.bP The input is the KEY_MOUSE special key associated with an mouse event. .PP The menu driver requests are as follows: @@ -120,32 +120,25 @@ 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, @@ -153,11 +146,9 @@ 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 could not be translated into a menu request an \fBE_REQUEST_DENIED\fR is returned. @@ -197,7 +188,7 @@ The menu driver could not process the request. .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X), -\fBwgetch\fR(3X). +\fBgetch\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header files \fB\fR. @@ -207,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: