Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / refs/heads/android-16 / . / man / mitem_value.3x
blob: daa383dae6bdfe5d7ec2ac5fd97536a70473e70c [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1.\"***************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]2.\" Copyright 2018-2023,2024 Thomas E. Dickey *
3.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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.\"
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]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"
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32.SH NAME
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]33\fBset_item_value\fP,
34\fBitem_value\fP \-
35set and get menu item values
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]36.SH SYNOPSIS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]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
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43.SH DESCRIPTION
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]44If 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
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]46becomes multi-valued; that is, more than one item may simultaneously be
47selected.
48.PP
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]49In a multi_valued menu, you can used \fBset_item_value\fP to select the
50given menu item (second argument \fBTRUE\fP) or deselect it (second argument
51\fBFALSE\fP).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52.SH RETURN VALUE
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]53The function \fBset_item_value\fP returns one of the following:
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]54.TP 5
55.B E_OK
56The routine succeeded.
57.TP 5
58.B E_SYSTEM_ERROR
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]59System error occurred (see \fBerrno\fP(3)).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]60.TP 5
61.B E_REQUEST_DENIED
62The menu driver could not process the request.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]63.SH PORTABILITY
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]64These routines emulate the System V menu library.
65They were not supported on
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]66Version 7 or BSD versions.
67.SH AUTHORS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]68Juergen Pfeifer.
69Manual pages and adaptation for new curses by Eric S. Raymond.
70.SH SEE ALSO
71\fB\%curses\fP(3X),
72\fB\%menu\fP(3X)