usr/src/man/man3curses/menu_driver.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH MENU_DRIVER 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 menu_driver \- command processor for the menus subsystem
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lmenu\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  14 #include <menu.h>
  15
  16 \fBint\fR \fBmenu_driver\fR(\fBMENU *\fR\fImenu\fR, \fBint\fR \fIc\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 \fBmenu_driver()\fR is the workhorse of the \fBmenus\fR subsystem. It checks to
  23 determine whether the character \fIc\fR is a menu request or data. If \fIc\fR
  24 is a request, the menu driver executes the request and reports the result. If
  25 \fIc\fR is data (a printable \fBASCII\fR character), it enters the data into
  26 the pattern buffer and tries to find a matching item. If no match is found, the
  27 menu driver deletes  the character from the pattern buffer and returns
  28 \fBE_NO_MATCH\fR. If the character is not recognized, the menu driver assumes
  29 it is an application-defined command and returns \fBE_UNKNOWN_COMMAND\fR.
  30 .sp
  31 .LP
  32 Menu driver requests:
  33 .sp
  34 .ne 2
  35 .na
  36 \fBREQ_LEFT_ITEM\fR
  37 .ad
  38 .RS 21n
  39 Move left to an item.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fBREQ_RIGHT_ITEM\fR
  46 .ad
  47 .RS 21n
  48 Move right to an item
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fBREQ_UP_ITEM\fR
  55 .ad
  56 .RS 21n
  57 Move up to an item.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fBREQ_DOWN_ITEM\fR
  64 .ad
  65 .RS 21n
  66 Move down to an item.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fBREQ_SCR_ULINE\fR
  73 .ad
  74 .RS 21n
  75 Scroll up a line.
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fBREQ_SCR_DLINE\fR
  82 .ad
  83 .RS 21n
  84 Scroll down a line.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fBREQ_SCR_DPAGE\fR
  91 .ad
  92 .RS 21n
  93 Scroll up a page.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fBREQ_SCR_UPAGE\fR
 100 .ad
 101 .RS 21n
 102 Scroll down a page.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fBREQ_FIRST_ITEM\fR
 109 .ad
 110 .RS 21n
 111 Move to the first item.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fBREQ_LAST_ITEM\fR
 118 .ad
 119 .RS 21n
 120 Move to the last item.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fBREQ_NEXT_ITEM\fR
 127 .ad
 128 .RS 21n
 129 Move to the next item.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fBREQ_PREV_ITEM\fR
 136 .ad
 137 .RS 21n
 138 Move to the previous item.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fBREQ_TOGGLE_ITEM\fR
 145 .ad
 146 .RS 21n
 147 Select/de-select an item.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fBREQ_CLEAR_PATTERN\fR
 154 .ad
 155 .RS 21n
 156 Clear the menu pattern buffer.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fBREQ_BACK_PATTERN\fR
 163 .ad
 164 .RS 21n
 165 Delete the previous character from pattern buffer.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fBREQ_NEXT_MATCH\fR
 172 .ad
 173 .RS 21n
 174 Move the next matching item.
 175 .RE
 176
 177 .sp
 178 .ne 2
 179 .na
 180 \fBREQ_PREV_MATCH\fR
 181 .ad
 182 .RS 21n
 183 Move to the previous matching item.
 184 .RE
 185
 186 .SH RETURN VALUES
 187 .sp
 188 .LP
 189 \fBmenu_driver()\fR returns one of the following:
 190 .sp
 191 .ne 2
 192 .na
 193 \fBE_OK\fR
 194 .ad
 195 .RS 21n
 196 The routine returned successfully.
 197 .RE
 198
 199 .sp
 200 .ne 2
 201 .na
 202 \fBE_SYSTEM_ERROR\fR
 203 .ad
 204 .RS 21n
 205 System error.
 206 .RE
 207
 208 .sp
 209 .ne 2
 210 .na
 211 \fBE_BAD_ARGUMENT\fR
 212 .ad
 213 .RS 21n
 214 An incorrect argument was passed to the routine.
 215 .RE
 216
 217 .sp
 218 .ne 2
 219 .na
 220 \fBE_BAD_STATE\fR
 221 .ad
 222 .RS 21n
 223 The routine was called from an initialization or termination function.
 224 .RE
 225
 226 .sp
 227 .ne 2
 228 .na
 229 \fBE_NOT_POSTED\fR
 230 .ad
 231 .RS 21n
 232 The menu has not been posted.
 233 .RE
 234
 235 .sp
 236 .ne 2
 237 .na
 238 \fBE_UNKNOWN_COMMAND\fR
 239 .ad
 240 .RS 21n
 241 An unknown request was passed to the menu driver.
 242 .RE
 243
 244 .sp
 245 .ne 2
 246 .na
 247 \fBE_NO_MATCH\fR
 248 .ad
 249 .RS 21n
 250 The character failed to match.
 251 .RE
 252
 253 .sp
 254 .ne 2
 255 .na
 256 \fBE_NOT_SELECTABLE\fR
 257 .ad
 258 .RS 21n
 259 The item cannot be selected.
 260 .RE
 261
 262 .sp
 263 .ne 2
 264 .na
 265 \fBE_REQUEST_DENIED\fR
 266 .ad
 267 .RS 21n
 268 The menu driver could not process the request.
 269 .RE
 270
 271 .SH ATTRIBUTES
 272 .sp
 273 .LP
 274 See \fBattributes\fR(5) for descriptions of the following attributes:
 275 .sp
 276
 277 .sp
 278 .TS
 279 box;
 280 c | c
 281 l | l .
 282 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 283 _
 284 MT-Level        Unsafe
 285 .TE
 286
 287 .SH SEE ALSO
 288 .sp
 289 .LP
 290 \fBcurses\fR(3CURSES), \fBmenus\fR(3CURSES), \fBattributes\fR(5)
 291 .SH NOTES
 292 .sp
 293 .LP
 294 Application-defined commands should be defined relative to (greater than)
 295 \fBMAX_COMMAND\fR, the maximum value of a request listed above.
 296 .sp
 297 .LP
 298 The header \fB<menu.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 299 \fB<curses.h>\fR\&.