usr/src/man/man3curses/menu_item_value.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_ITEM_VALUE 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 menu_item_value, set_item_value, item_value \- set and get menus item values
  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 \fBset_item_value\fR(\fBITEM *\fR\fIitem\fR, \fBint\fR \fIbool\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBitem_value\fR(\fBITEM *\fR\fIitem\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 Unlike single-valued menus, multi-valued menus enable the end-user to select
  28 one or more items from a menu. \fBset_item_value()\fR sets the selected value
  29 of the \fIitem\fR \(em \fBTRUE\fR (selected) or \fBFALSE\fR (not selected).
  30 \fBset_item_value()\fR may be used only with multi-valued menus. To make a menu
  31 multi-valued, use \fBset_menu_opts\fR or \fBmenu_opts_off()\fR to turn off the
  32 option \fBO_ONEVALUE\fR. (See \fBmenu_opts\fR(3CURSES)).
  33 .sp
  34 .LP
  35 \fBitem_value()\fR returns the select value of \fIitem\fR, either \fBTRUE\fR
  36 (selected) or \fBFALSE\fR (unselected).
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 \fBset_item_value()\fR returns one of the following:
  41 .sp
  42 .ne 2
  43 .na
  44 \fBE_OK\fR
  45 .ad
  46 .RS 20n
  47 The routine returned successfully.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fBE_SYSTEM_ERROR\fR
  54 .ad
  55 .RS 20n
  56 System error.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fBE_REQUEST_DENIED\fR
  63 .ad
  64 .RS 20n
  65 The menu driver could not process the request.
  66 .RE
  67
  68 .SH ATTRIBUTES
  69 .sp
  70 .LP
  71 See \fBattributes\fR(5) for descriptions of the following attributes:
  72 .sp
  73
  74 .sp
  75 .TS
  76 box;
  77 c | c
  78 l | l .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 MT-Level        Unsafe
  82 .TE
  83
  84 .SH SEE ALSO
  85 .sp
  86 .LP
  87 \fBcurses\fR(3CURSES), \fBmenus\fR(3CURSES), \fBmenu_opts\fR(3CURSES),
  88 \fBattributes\fR(5)
  89 .SH NOTES
  90 .sp
  91 .LP
  92 The header \fB<menu.h>\fR automatically includes the headers  \fB<eti.h>\fR and
  93 \fB<curses.h>\fR\&.