X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=Ada95%2Fhtml%2Fman%2Fmenu_driver.3x.html;fp=Ada95%2Fhtml%2Fmenu_driver.3x.html;h=40c11f8ab57234010a3585efd072073ef9b93e2d;hp=53babc7794bed2697222d04012976ba62cc6afda;hb=0eb88fc5281804773e2a0c7a488a4452463535ce;hpb=661078ddbde3ce0f3b06e95642fbb9b5fef7dca1
diff --git a/Ada95/html/menu_driver.3x.html b/Ada95/html/man/menu_driver.3x.html
similarity index 50%
rename from Ada95/html/menu_driver.3x.html
rename to Ada95/html/man/menu_driver.3x.html
index 53babc77..40c11f8a 100644
--- a/Ada95/html/menu_driver.3x.html
+++ b/Ada95/html/man/menu_driver.3x.html
@@ -1,12 +1,12 @@
-
+
menu_driver - command-processing loop of the menu system
SYNOPSIS
- #include <menu.h>
+ #include
int menu_driver(MENU *menu, int c);
@@ -14,9 +14,10 @@
DESCRIPTION
Once a menu has been posted (displayed), you should funnel
input events to it through menu_driver. This routine has
- two major input cases; either the input is a menu naviga-
- tion request or it's a printable ASCII character. The
- menu driver requests are as follows:
+ three major input cases; either the input is a menu navi-
+ gation request, it's a printable ASCII character or it is
+ the KEY_MOUSE special key associated with an mouse event.
+ The menu driver requests are as follows:
REQ_LEFT_ITEM
Move left to an item.
@@ -56,11 +57,10 @@
REQ_TOGGLE_ITEM
Select/deselect an item.
-
Clear the menu pattern buffer.
REQ_BACK_PATTERN
- Delete the previous character from the pattern
+ Delete the previous character from the pattern
buffer.
REQ_NEXT_MATCH
@@ -75,19 +75,40 @@
such match, menu_driver returns E_NO_MATCH and deletes the
appended character from the buffer.
- If the second argument is one of the above pre-defined
+ If the second argument is one of the above pre-defined
requests, the corresponding action is performed.
- If the second argument is neither printable ASCII nor one
- of the above pre-defined menu requests, the drive assumes
- it is an application-specific command and returns
- E_UNKNOWN_COMMAND. Application-defined commands should be
- defined relative to MAX_COMMAND, the maximum value of
- these pre-defined requests.
-
+ 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 area or the decora-
+ tion window) are handled. If you click above the display
+ region of the menu, a REQ_SCR_ULINE is generated, if you
+ doubleclick a REQ_SCR_UPAGE is generated and if you
+ tripleclick a REQ_FIRST_ITEM is generated. If you click
+ below the display region of the menu, a REQ_SCR_DLINE is
+ generated, if you doubleclick a REQ_SCR_DPAGE is generated
+ and if you tripleclick a REQ_LAST_ITEM is generated. If
+ you click at an item inside the display area of the menu,
+ the menu cursor is positioned to that item. If you double-
+ click at an item a REQ_TOGGLE_ITEM is generated and
+ E_UNKNOWN_COMMAND is returned. This return value makes
+ sense, because a double click usually means that an item-
+ specific action should be returned. It's exactly the pur-
+ pose of this return value to signal that an application
+ specific command should be executed. If a translation into
+ a request was done, menu_driver returns the result of this
+ request. If you clicked outside the user window or the
+ mouse event couldn't be translated into a menu request an
+ E_REQUEST_DENIED is returned.
+
+ If the second argument is neither printable ASCII nor one
+ of the above pre-defined menu requests or KEY_MOUSE, the
+ drive assumes it is an application-specific command and
+ returns E_UNKNOWN_COMMAND. Application-defined commands
+ should be defined relative to MAX_COMMAND, the maximum
+ value of these pre-defined requests.
-
-RETURN VALUE
menu_driver return one of the following error codes:
E_OK The routine succeeded.
@@ -96,7 +117,7 @@
System error occurred (see errno).
E_BAD_ARGUMENT
- Routine detected an incorrect or out-of-range argu-
+ Routine detected an incorrect or out-of-range argu-
ment.
E_BAD_STATE
@@ -111,6 +132,8 @@
E_NO_MATCH
Character failed to match.
+
+ E_REQUEST_DENIED
The menu driver could not process the request.
@@ -121,14 +144,15 @@
NOTES
- The header file <menu.h> automatically includes the header
- files <curses.h>.
+ The header file automatically includes the header
+ files .
PORTABILITY
- These routines emulate the System V menu library. They
- were not supported on Version 7 or BSD versions.
+ These routines emulate the System V menu library. They
+ were not supported on Version 7 or BSD versions. The sup-
+ port for mouse events is ncurses specific.
@@ -145,32 +169,6 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-