<HTML>
<BODY>
<PRE>
- <STRONG>menu_driver</STRONG> - command-processing loop of the menu system
+<!-- Manpage converted by man2html 3.0.1 -->
+
+</PRE>
+<H2>NAME</H2><PRE>
+ <B>menu_driver</B> - command-processing loop of the menu system
</PRE>
<H2>SYNOPSIS</H2><PRE>
- <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
+ <B>#include</B> <B><menu.h></B>
int menu_driver(MENU *menu, int c);
</PRE>
<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
+ input events to it through <B>menu_driver</B>. 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.
REQ_TOGGLE_ITEM
Select/deselect an item.
+
+ REQ_CLEAR_PATTERN
Clear the menu pattern buffer.
REQ_BACK_PATTERN
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
- such match, <STRONG>menu_driver</STRONG> returns <STRONG>E_NO_MATCH</STRONG> and deletes the
+ such match, <B>menu_driver</B> returns <B>E_NO_MATCH</B> and deletes the
appended character from the buffer.
If the second argument is one of the above pre-defined
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
+ <B>E_UNKNOWN_COMMAND</B> 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
+ a request was done, <B>menu_driver</B> 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
- <STRONG>E_REQUEST_DENIED</STRONG> is returned.
+ <B>E_REQUEST_DENIED</B> 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
+ returns <B>E_UNKNOWN_COMMAND</B>. Application-defined commands
+ should be defined relative to <B>MAX_COMMAND</B>, the maximum
value of these pre-defined requests.
- <STRONG>menu_driver</STRONG> return one of the following error codes:
- <STRONG>E_OK</STRONG> The routine succeeded.
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
+</PRE>
+<H2>RETURN VALUE</H2><PRE>
+ <B>menu_driver</B> return one of the following error codes:
- <STRONG>E_BAD_ARGUMENT</STRONG>
+ <B>E_OK</B> The routine succeeded.
+
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno</B>).
+
+ <B>E_BAD_ARGUMENT</B>
Routine detected an incorrect or out-of-range argu-
ment.
- <STRONG>E_BAD_STATE</STRONG>
+ <B>E_BAD_STATE</B>
Routine was called from an initialization or termina-
tion function.
- <STRONG>E_NOT_POSTED</STRONG>
+ <B>E_NOT_POSTED</B>
The menu has not been posted.
- <STRONG>E_UNKNOWN_COMMAND</STRONG>
+ <B>E_UNKNOWN_COMMAND</B>
The menu driver code saw an unknown request code.
- <STRONG>E_NO_MATCH</STRONG>
+ <B>E_NO_MATCH</B>
Character failed to match.
- <STRONG>E_REQUEST_DENIED</STRONG>
+ <B>E_REQUEST_DENIED</B>
The menu driver could not process the request.
</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>.
+ <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
</PRE>
<H2>NOTES</H2><PRE>
- The header file <STRONG><menu.h></STRONG> automatically includes the header
- files <STRONG><curses.h></STRONG>.
+ The header file <B><menu.h></B> automatically includes the header
+ files <B><curses.h></B>.
</PRE>
+
</PRE>
+<HR>
+<ADDRESS>
+Man(1) output converted with
+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
+</ADDRESS>
</BODY>
</HTML>
projects / ncurses.git / blobdiff