ncurses 5.8 - patch 20110226
[ncurses.git] / doc / html / man / menu_driver.3x.html
index 356a71738e8b6191fdc9efe14a1660c1ed15633f..f2b6c16c715f83cde939fcd9b4883a6f7cd6db46 100644 (file)
             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.
        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, <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
+       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
+       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:
 
        <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
+       If you click at an item inside the  display  area  of  the
        menu:
 
        <STRONG>o</STRONG>   the menu cursor is positioned to that item.
 
-       <STRONG>o</STRONG>   If you double-click an item a REQ_TOGGLE_ITEM is  gen-
+       <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
+           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
+           nal that an application  specific  command  should  be
            executed.
 
-       <STRONG>o</STRONG>   If a translation into a request was done,  <STRONG>menu_driver</STRONG>
+       <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
+       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.
 
    <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
+       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
+       defined relative to  <STRONG>MAX_COMMAND</STRONG>,  the  maximum  value  of
        these pre-defined requests.
 
 
             System error occurred (see <STRONG>errno</STRONG>).
 
        <STRONG>E_BAD_ARGUMENT</STRONG>
-            Routine detected an incorrect or  out-of-range  argu-
+            Routine  detected  an incorrect or out-of-range argu-
             ment.
 
        <STRONG>E_BAD_STATE</STRONG>
 
 </PRE>
 <H2>PORTABILITY</H2><PRE>
-       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.
 
 
 </PRE>
 <H2>AUTHORS</H2><PRE>
-       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
+       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
        curses by Eric S. Raymond.