]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/menu_driver.3x.html
ncurses 5.7 - patch 20110108
[ncurses.git] / doc / html / man / menu_driver.3x.html
index 05c605c81e52532534bceff7524c1758cb311fd6..356a71738e8b6191fdc9efe14a1660c1ed15633f 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
 <!-- 
   ****************************************************************************
-  * Copyright (c) 1998-2007,2008 Free Software Foundation, Inc.              *
+  * Copyright (c) 1998-2008,2010 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            *
@@ -27,7 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: menu_driver.3x,v 1.15 2008/06/21 21:55:30 tom Exp @
+  * @Id: menu_driver.3x,v 1.20 2010/12/04 18:38:55 tom Exp @
 -->
 <HTML>
 <HEAD>
        input events to it through <STRONG>menu_driver</STRONG>.  This routine  has
        three major input cases:
 
-       -  The  input  is  a  form navigation request.  Navigation
-          request codes are constants defined in <STRONG>&lt;form.h&gt;</STRONG>,  which
-          are distinct from the key- and character codes returned
-          by <STRONG>wgetch</STRONG>.
+       <STRONG>o</STRONG>   The  input  is  a form navigation request.  Navigation
+           request codes are constants defined in <STRONG>&lt;form.h&gt;</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.
+       <STRONG>o</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.
+       <STRONG>o</STRONG>   The input is the KEY_MOUSE special key associated with
+           an mouse event.
 
        The menu driver requests are as follows:
 
        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-
+       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,
+       <STRONG>o</STRONG>   a REQ_SCR_ULINE is generated for a single click,
 
-              a REQ_SCR_UPAGE is generated for a double-click and
+       <STRONG>o</STRONG>   a REQ_SCR_UPAGE is generated for a double-click and
 
-              a REQ_FIRST_ITEM is generated for a triple-click.
+       <STRONG>o</STRONG>   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,
+       <STRONG>o</STRONG>   a REQ_SCR_DLINE is generated for a single click,
 
-              a REQ_SCR_DPAGE is generated for a double-click and
+       <STRONG>o</STRONG>   a REQ_SCR_DPAGE is generated for a double-click and
 
-              a REQ_LAST_ITEM is generated for a triple-click.
+       <STRONG>o</STRONG>   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.
+       <STRONG>o</STRONG>   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.
+       <STRONG>o</STRONG>   If you double-click an item a REQ_TOGGLE_ITEM is  gen-
+           erated 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 sig-
+           nal  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.
+       <STRONG>o</STRONG>   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
 
 </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="wgetch.3x.html">wgetch(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="getch.3x.html">getch(3x)</A></STRONG>.
 
 
 </PRE>