lib/libncurses/man/menu_driver.3x

   1 .\"***************************************************************************
   2 .\" Copyright (c) 1998-2010,2017 Free Software Foundation, Inc.              *
   3 .\"                                                                          *
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   5 .\" copy of this software and associated documentation files (the            *
   6 .\" "Software"), to deal in the Software without restriction, including      *
   7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
   9 .\" copies of the Software, and to permit persons to whom the Software is    *
  10 .\" furnished to do so, subject to the following conditions:                 *
  11 .\"                                                                          *
  12 .\" The above copyright notice and this permission notice shall be included  *
  13 .\" in all copies or substantial portions of the Software.                   *
  14 .\"                                                                          *
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22 .\"                                                                          *
  23 .\" Except as contained in this notice, the name(s) of the above copyright   *
  24 .\" holders shall not be used in advertising or otherwise to promote the     *
  25 .\" sale, use or other dealings in this Software without prior written       *
  26 .\" authorization.                                                           *
  27 .\"***************************************************************************
  28 .\"
  29 .\" $Id: menu_driver.3x,v 1.21 2017/01/07 19:25:15 tom Exp $
  30 .TH menu_driver 3X ""
  31 .de bP
  32 .IP \(bu 4
  33 ..
  34 .SH NAME
  35 \fBmenu_driver\fR \- command-processing loop of the menu system
  36 .SH SYNOPSIS
  37 \fB#include <menu.h>\fR
  38 .br
  39 int menu_driver(MENU *menu, int c);
  40 .br
  41 .SH DESCRIPTION
  42 Once a menu has been posted (displayed), you should funnel input events to it
  43 through \fBmenu_driver\fR.  This routine has three major input cases:
  44 .bP
  45 The input is a form navigation request.
  46 Navigation request codes are constants defined in \fB<form.h>\fP,
  47 which are distinct from the key- and character codes returned by \fBwgetch\fP(3X).
  48 .bP
  49 The input is a printable character.
  50 Printable characters (which must be positive, less than 256) are
  51 checked according to the program's locale settings.
  52 .bP
  53 The input is the KEY_MOUSE special key associated with an mouse event.
  54 .PP
  55 The menu driver requests are as follows:
  56 .TP 5
  57 REQ_LEFT_ITEM
  58 Move left to an item.
  59 .TP 5
  60 REQ_RIGHT_ITEM
  61 Move right to an item.
  62 .TP 5
  63 REQ_UP_ITEM
  64 Move up to an item.
  65 .TP 5
  66 REQ_DOWN_ITEM
  67 Move down to an item.
  68 .TP 5
  69 REQ_SCR_ULINE
  70 Scroll up a line.
  71 .TP 5
  72 REQ_SCR_DLINE
  73 Scroll down a line.
  74 .TP 5
  75 REQ_SCR_DPAGE
  76 Scroll down a page.
  77 .TP 5
  78 REQ_SCR_UPAGE
  79 Scroll up a page.
  80 .TP 5
  81 REQ_FIRST_ITEM
  82 Move to the first item.
  83 .TP 5
  84 REQ_LAST_ITEM
  85 Move to the last item.
  86 .TP 5
  87 REQ_NEXT_ITEM
  88 Move to the next item.
  89 .TP 5
  90 REQ_PREV_ITEM
  91 Move to the previous item.
  92 .TP 5
  93 REQ_TOGGLE_ITEM
  94 Select/deselect an item.
  95 .TP 5
  96 REQ_CLEAR_PATTERN
  97 Clear the menu pattern buffer.
  98 .TP 5
  99 REQ_BACK_PATTERN
 100 Delete the previous character from the pattern buffer.
 101 .TP 5
 102 REQ_NEXT_MATCH
 103 Move to the next item matching the pattern match.
 104 .TP 5
 105 REQ_PREV_MATCH
 106 Move to the previous item matching the pattern match.
 107 .PP
 108 If the second argument is a printable character, the code appends
 109 it to the pattern buffer and attempts to move to the next item matching
 110 the new pattern.  If there is no such match, \fBmenu_driver\fR returns
 111 \fBE_NO_MATCH\fR and deletes the appended character from the buffer.
 112 .PP
 113 If the second argument is one of the above pre-defined requests, the
 114 corresponding action is performed.
 115 .SS MOUSE HANDLING
 116 .PP
 117 If the second argument is the KEY_MOUSE special key, the associated
 118 mouse event is translated into one of the above pre-defined requests.
 119 Currently only clicks in the user window (e.g., inside the menu display
 120 area or the decoration window) are handled.
 121 .PP
 122 If you click above the display region of the menu:
 123 .bP
 124 a REQ_SCR_ULINE is generated for a single click,
 125 .bP
 126 a REQ_SCR_UPAGE is generated for a double-click and
 127 .bP
 128 a REQ_FIRST_ITEM is generated for a triple-click.
 129 .PP
 130 If you click below the display region of the menu:
 131 .bP
 132 a REQ_SCR_DLINE is generated for a single click,
 133 .bP
 134 a REQ_SCR_DPAGE is generated for a double-click and
 135 .bP
 136 a REQ_LAST_ITEM is generated for a triple-click.
 137 .PP
 138 If you click at an item inside the display area of the menu:
 139 .bP
 140 the menu cursor is positioned to that item.
 141 .bP
 142 If you double-click an item a REQ_TOGGLE_ITEM
 143 is generated and \fBE_UNKNOWN_COMMAND\fR is returned.
 144 This return value makes sense,
 145 because a double click usually means that an item-specific action should
 146 be returned.
 147 It is exactly the purpose of this return value to signal that an
 148 application specific command should be executed.
 149 .bP
 150 If a translation
 151 into a request was done, \fBmenu_driver\fR returns the result of this request.
 152 .PP
 153 If you clicked outside the user window or the mouse event could not be translated
 154 into a menu request an \fBE_REQUEST_DENIED\fR is returned.
 155 .SS APPLICATION-DEFINED COMMANDS
 156 .PP
 157 If the second argument is neither printable nor one of the above
 158 pre-defined menu requests or KEY_MOUSE, the drive assumes it is an application-specific
 159 command and returns \fBE_UNKNOWN_COMMAND\fR.  Application-defined commands
 160 should be defined relative to \fBMAX_COMMAND\fR, the maximum value of these
 161 pre-defined requests.
 162 .SH RETURN VALUE
 163 \fBmenu_driver\fR return one of the following error codes:
 164 .TP 5
 165 .B E_OK
 166 The routine succeeded.
 167 .TP 5
 168 .B E_SYSTEM_ERROR
 169 System error occurred (see \fBerrno\fR).
 170 .TP 5
 171 .B E_BAD_ARGUMENT
 172 Routine detected an incorrect or out-of-range argument.
 173 .TP 5
 174 .B E_BAD_STATE
 175 Routine was called from an initialization or termination function.
 176 .TP 5
 177 .B E_NOT_POSTED
 178 The menu has not been posted.
 179 .TP 5
 180 .B E_UNKNOWN_COMMAND
 181 The menu driver code saw an unknown request code.
 182 .TP 5
 183 .B E_NO_MATCH
 184 Character failed to match.
 185 .TP 5
 186 .B E_REQUEST_DENIED
 187 The menu driver could not process the request.
 188 .SH SEE ALSO
 189 \fBcurses\fR(3X),
 190 \fBmenu\fR(3X),
 191 \fBgetch\fR(3X).
 192 .SH NOTES
 193 The header file \fB<menu.h>\fR automatically includes the header files
 194 \fB<curses.h>\fR.
 195 .SH PORTABILITY
 196 These routines emulate the System V menu library.  They were not supported on
 197 Version 7 or BSD versions. The support for mouse events is ncurses specific.
 198 .SH AUTHORS
 199 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 200 S. Raymond.