X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmenu_driver.3x.html;h=98b5de815740d314686cba0e722483ca7728952e;hp=f2b6c16c715f83cde939fcd9b4883a6f7cd6db46;hb=f344f8539c1543f8cd65a5bb142dbaf23b9421d2;hpb=f86cbeb5f9bd96ab041d34039c35749a14965039 diff --git a/doc/html/man/menu_driver.3x.html b/doc/html/man/menu_driver.3x.html index f2b6c16c..98b5de81 100644 --- a/doc/html/man/menu_driver.3x.html +++ b/doc/html/man/menu_driver.3x.html @@ -1,7 +1,6 @@ - + + + menu_driver 3x -

menu_driver 3x

-
+

menu_driver 3x

-
 menu_driver(3x)                                         menu_driver(3x)
 
 
 
 
-
-

NAME

+

NAME

        menu_driver - command-processing loop of the menu system
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <menu.h>
        int menu_driver(MENU *menu, int c);
 
 
-
-

DESCRIPTION

+

DESCRIPTION

        Once a menu has been posted (displayed), you should funnel
        input events to it through menu_driver.  This routine  has
        three major input cases:
@@ -65,7 +62,7 @@
        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.
+           returned by wgetch(3x).
 
        o   The input is a printable character.  Printable charac-
            ters  (which  must  be  positive,  less  than 256) are
@@ -119,8 +116,8 @@
             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.
@@ -128,20 +125,21 @@
        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
+
+

MOUSE HANDLING

+       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:
@@ -160,37 +158,37 @@
 
        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:
 
        o   the menu cursor is positioned to that item.
 
-       o   If  you double-click an item a REQ_TOGGLE_ITEM is gen-
+       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
+           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.
 
-       o   If  a translation into a request was done, menu_driver
+       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
+
+

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.
 
 
-
-

RETURN VALUE

+

RETURN VALUE

        menu_driver return one of the following error codes:
 
        E_OK The routine succeeded.
@@ -199,7 +197,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
@@ -219,37 +217,45 @@
             The menu driver could not process the request.
 
 
-
-

SEE ALSO

-       curses(3x), menu(3x), getch(3x).
+

SEE ALSO

+       curses(3x), menu(3x), getch(3x).
 
 
-
-

NOTES

+

NOTES

        The header file <menu.h> automatically includes the header
        files <curses.h>.
 
 
-
-

PORTABILITY

-       These routines emulate the System V  menu  library.   They
-       were  not supported on Version 7 or BSD versions. The sup-
+

PORTABILITY

+       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
+

AUTHORS

+       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
        curses by Eric S. Raymond.
 
 
 
                                                         menu_driver(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +