X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_driver.3x.html;h=f2b6c16c715f83cde939fcd9b4883a6f7cd6db46;hp=c5fe1f7276be0f853dd63f2e15318771e9e51231;hb=f86cbeb5f9bd96ab041d34039c35749a14965039;hpb=f9d358b4f3cf9b44727a0ee5c08f8ca6ae4e3821
diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html
index c5fe1f72..f2b6c16c 100644
--- a/doc/html/man/menu_driver.3x.html
+++ b/doc/html/man/menu_driver.3x.html
@@ -27,7 +27,7 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: menu_driver.3x,v 1.16 2010/01/30 21:29:04 tom Exp @
+ * @Id: menu_driver.3x,v 1.20 2010/12/04 18:38:55 tom Exp @
-->
@@ -62,17 +62,17 @@
input events to it through menu_driver. This routine has
three major input cases:
- - The input is a form navigation request. Navigation
- request codes are constants defined in <form.h>, which
- are distinct from the key- and character codes returned
- by wgetch.
+ o The input is a form navigation request. Navigation
+ request codes are constants defined in <form.h>, which
+ are distinct from the key- and character codes
+ returned by wgetch.
- - The input is a printable character. Printable charac-
- ters (which must be positive, less than 256) are
- checked according to the program's locale settings.
+ o The input is a printable character. Printable charac-
+ ters (which must be positive, less than 256) are
+ checked according to the program's locale settings.
- - The input is the KEY_MOUSE special key associated with
- an mouse event.
+ o The input is the KEY_MOUSE special key associated with
+ an mouse event.
The menu driver requests are as follows:
@@ -119,8 +119,8 @@
Clear the menu pattern buffer.
REQ_BACK_PATTERN
- Delete the previous character from the pattern buf-
- fer.
+ Delete the previous character from the pattern
+ buffer.
REQ_NEXT_MATCH
Move to the next item matching the pattern match.
@@ -128,64 +128,64 @@
REQ_PREV_MATCH
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
+ 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, 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.
MOUSE HANDLING
- If the second argument is the KEY_MOUSE special key, the
+ 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-
+ 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 for a single click,
+ o a REQ_SCR_ULINE is generated for a single click,
- a REQ_SCR_UPAGE is generated for a double-click and
+ o a REQ_SCR_UPAGE is generated for a double-click and
- a REQ_FIRST_ITEM is generated for a triple-click.
+ o 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,
+ o a REQ_SCR_DLINE is generated for a single click,
- a REQ_SCR_DPAGE is generated for a double-click and
+ o a REQ_SCR_DPAGE is generated for a double-click and
- a REQ_LAST_ITEM is generated for a triple-click.
+ o a REQ_LAST_ITEM is generated for a triple-click.
- If you click at an item inside the display area of the
+ If you click at an item inside the display area of the
menu:
- - the menu cursor is positioned to that item.
+ o the menu cursor is positioned to that item.
- - If you double-click 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 is exactly the purpose
- of this return value to signal that an applica-
- tion specific command should be executed.
+ o If you double-click an item a REQ_TOGGLE_ITEM is gen-
+ erated 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 is exactly the purpose of this return value to sig-
+ nal that an application specific command should be
+ executed.
- - If a translation into a request was done,
- menu_driver returns the result of this request.
+ o 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
- could not be translated into a menu request an
+ If you clicked outside the user window or the mouse event
+ could not be translated into a menu request an
E_REQUEST_DENIED is returned.
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
+ 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
+ defined relative to MAX_COMMAND, the maximum value of
these pre-defined requests.
@@ -199,7 +199,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
@@ -221,7 +221,7 @@
SEE ALSO
- curses(3x), menu(3x), wgetch(3x).
+ curses(3x), menu(3x), getch(3x).
@@ -232,14 +232,14 @@
PORTABILITY
- These routines emulate the System V menu library. They
- were not supported on Version 7 or BSD versions. The sup-
+ 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.
AUTHORS
- Juergen Pfeifer. Manual pages and adaptation for new
+ Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.