path: root/man/menu_driver.3x
diff options
authorXin LI <delphij@FreeBSD.org>2014-02-28 19:12:44 +0000
committerXin LI <delphij@FreeBSD.org>2014-02-28 19:12:44 +0000
commit4b819fa20a8d007a10f2d3e8d6a5dedf7f18fc9a (patch)
treeb8f6e12b479a78216f3bffb8e1258d54087268de /man/menu_driver.3x
parente07762606a5bf651a501cb095c98cba90e4a8fe2 (diff)
Undo two previous imports which was never done in preparation of doing a
new import.
Notes: svn path=/vendor/ncurses/dist/; revision=262616
Diffstat (limited to 'man/menu_driver.3x')
1 files changed, 35 insertions, 20 deletions
diff --git a/man/menu_driver.3x b/man/menu_driver.3x
index 1fe5001fec05..5366040c18af 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-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,13 +26,10 @@
.\" authorization. *
-.\" $Id: menu_driver.3x,v 1.20 2010/12/04 18:38:55 tom Exp $
+.\" $Id: menu_driver.3x,v 1.15 2008/06/21 21:55:30 tom Exp $
.TH menu_driver 3X ""
-.de bP
-.IP \(bu 4
-\fBmenu_driver\fR \- command-processing loop of the menu system
+\fBmenu_driver\fR - command-processing loop of the menu system
\fB#include <menu.h>\fR
@@ -41,15 +38,18 @@ int menu_driver(MENU *menu, int c);
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
The input is a form navigation request.
Navigation request codes are constants defined in \fB<form.h>\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.
The menu driver requests are as follows:
@@ -116,29 +116,36 @@ corresponding action is performed.
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
+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 for a single click,
a REQ_SCR_UPAGE is generated for a double-click and
a REQ_FIRST_ITEM is generated for a triple-click.
If you click below the display region of the menu:
a REQ_SCR_DLINE is generated for a single click,
a REQ_SCR_DPAGE is generated for a double-click and
a REQ_LAST_ITEM is generated for a triple-click.
If you click at an item inside the display area of the menu:
+.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,
@@ -146,9 +153,11 @@ 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 could not be translated
into a menu request an \fBE_REQUEST_DENIED\fR is returned.
@@ -188,7 +197,7 @@ The menu driver could not process the request.
The header file \fB<menu.h>\fR automatically includes the header files
@@ -198,3 +207,9 @@ Version 7 or BSD versions. The support for mouse events is ncurses specific.
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: