man/mitem_value.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: mitem_value.3x,v 1.32 2024/03/16 15:35:01 tom Exp $
  31 .TH mitem_value 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
  32 .SH NAME
  33 \fBset_item_value\fP,
  34 \fBitem_value\fP \-
  35 set and get menu item values
  36 .SH SYNOPSIS
  37 .nf
  38 \fB#include <menu.h>
  39 .PP
  40 \fBint set_item_value(ITEM *\fIitem\fP, bool \fIvalue\fP);
  41 \fBbool item_value(const ITEM *\fIitem\fP);
  42 .fi
  43 .SH DESCRIPTION
  44 If you turn off the menu option \fBO_ONEVALUE\fP (e.g., with
  45 \fBset_menu_opts\fP or \fBmenu_opts_off\fP; see \fBmenu_opts\fP(3X)), the menu
  46 becomes multi-valued; that is, more than one item may simultaneously be
  47 selected.
  48 .PP
  49 In a multi_valued menu, you can used \fBset_item_value\fP to select the
  50 given menu item (second argument \fBTRUE\fP) or deselect it (second argument
  51 \fBFALSE\fP).
  52 .SH RETURN VALUE
  53 The function \fBset_item_value\fP returns one of the following:
  54 .TP 5
  55 .B E_OK
  56 The routine succeeded.
  57 .TP 5
  58 .B E_SYSTEM_ERROR
  59 System error occurred (see \fBerrno\fP(3)).
  60 .TP 5
  61 .B E_REQUEST_DENIED
  62 The menu driver could not process the request.
  63 .SH PORTABILITY
  64 These routines emulate the System V menu library.
  65 They were not supported on
  66 Version 7 or BSD versions.
  67 .SH AUTHORS
  68 Juergen Pfeifer.
  69 Manual pages and adaptation for new curses by Eric S. Raymond.
  70 .SH SEE ALSO
  71 \fB\%curses\fP(3X),
  72 \fB\%menu\fP(3X)