<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998-2003,2006 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: menu_driver.3x,v 1.12 2006/11/04 17:13:50 tom Exp @
+ * @Id: menu_driver.3x,v 1.15 2008/06/21 21:55:30 tom Exp @
-->
<HTML>
<HEAD>
<H2>DESCRIPTION</H2><PRE>
Once a menu has been posted (displayed), you should funnel
input events to it through <STRONG>menu_driver</STRONG>. This routine has
- 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.
+ three major input cases:
+
+ - The input is a form navigation request. Navigation
+ request codes are constants defined in <STRONG><form.h></STRONG>, which
+ are distinct from the key- and character codes returned
+ by <STRONG>wgetch</STRONG>.
+
+ - 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.
+
The menu driver requests are as follows:
REQ_LEFT_ITEM
Clear the menu pattern buffer.
REQ_BACK_PATTERN
- Delete the previous character from the pattern
- buffer.
+ Delete the previous character from the pattern buf-
+ fer.
REQ_NEXT_MATCH
Move to the next item matching the pattern match.
REQ_PREV_MATCH
Move to the previous item matching the pattern match.
- If the second argument is a printable ASCII 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, <STRONG>menu_driver</STRONG> returns <STRONG>E_NO_MATCH</STRONG> and deletes the
appended character from the buffer.
If the second argument is one of the above pre-defined
requests, the corresponding action is performed.
+ <STRONG>MOUSE</STRONG> <STRONG>HANDLING</STRONG>
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
- <STRONG>E_UNKNOWN_COMMAND</STRONG> 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, <STRONG>menu_driver</STRONG> 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
+ tion 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:
+
+ - the menu cursor is positioned to that item.
+
+ - If you double-click an item a REQ_TOGGLE_ITEM is
+ generated and <STRONG>E_UNKNOWN_COMMAND</STRONG> 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.
+
+ - If a translation into a request was done,
+ <STRONG>menu_driver</STRONG> 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
<STRONG>E_REQUEST_DENIED</STRONG> 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 <STRONG>E_UNKNOWN_COMMAND</STRONG>. Application-defined commands
- should be defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum
- value of these pre-defined requests.
+ <STRONG>APPLICATION-DEFINED</STRONG> <STRONG>COMMANDS</STRONG>
+ 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
+ <STRONG>E_UNKNOWN_COMMAND</STRONG>. Application-defined commands should be
+ defined relative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of
+ these pre-defined requests.
</PRE>
</PRE>
<H2>SEE ALSO</H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>, <STRONG><A HREF="wgetch.3x.html">wgetch(3x)</A></STRONG>.
</PRE>
projects / ncurses.git / blobdiff