75 lines
3.6 KiB
Groff
75 lines
3.6 KiB
Groff
.\" $OpenBSD: mitem_value.3,v 1.5 2023/10/17 09:52:10 nicm Exp $
|
|
.\"
|
|
.\"***************************************************************************
|
|
.\" Copyright 2018-2022,2023 Thomas E. Dickey *
|
|
.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. *
|
|
.\" *
|
|
.\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|
.\" copy of this software and associated documentation files (the *
|
|
.\" "Software"), to deal in the Software without restriction, including *
|
|
.\" without limitation the rights to use, copy, modify, merge, publish, *
|
|
.\" distribute, distribute with modifications, sublicense, and/or sell *
|
|
.\" copies of the Software, and to permit persons to whom the Software is *
|
|
.\" furnished to do so, subject to the following conditions: *
|
|
.\" *
|
|
.\" The above copyright notice and this permission notice shall be included *
|
|
.\" in all copies or substantial portions of the Software. *
|
|
.\" *
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
.\" *
|
|
.\" Except as contained in this notice, the name(s) of the above copyright *
|
|
.\" holders shall not be used in advertising or otherwise to promote the *
|
|
.\" sale, use or other dealings in this Software without prior written *
|
|
.\" authorization. *
|
|
.\"***************************************************************************
|
|
.\"
|
|
.\" $Id: mitem_value.3,v 1.5 2023/10/17 09:52:10 nicm Exp $
|
|
.TH mitem_value 3 2023-07-01 "ncurses 6.4" "Library calls"
|
|
.SH NAME
|
|
\fBset_item_value\fP,
|
|
\fBitem_value\fP \- set and get menu item values
|
|
.SH SYNOPSIS
|
|
\fB#include <menu.h>\fP
|
|
.sp
|
|
\fBint set_item_value(ITEM *\fIitem\fB, bool \fIvalue\fB);\fR
|
|
.br
|
|
\fBbool item_value(const ITEM *\fIitem\fB);\fR
|
|
.SH DESCRIPTION
|
|
If you turn off the menu option \fBO_ONEVALUE\fP (e.g., with
|
|
\fBset_menu_opts\fP or \fBmenu_opts_off\fP; see \fBmenu_opts\fP(3)), the menu
|
|
becomes multi-valued; that is, more than one item may simultaneously be
|
|
selected.
|
|
.PP
|
|
In a multi_valued menu, you can used \fBset_item_value\fP to select the
|
|
given menu item (second argument \fBTRUE\fP) or deselect it (second argument
|
|
\fBFALSE\fP).
|
|
.SH RETURN VALUE
|
|
The function \fBset_item_value\fP returns one of the following:
|
|
.TP 5
|
|
.B E_OK
|
|
The routine succeeded.
|
|
.TP 5
|
|
.B E_SYSTEM_ERROR
|
|
System error occurred (see \fBerrno\fP(3)).
|
|
.TP 5
|
|
.B E_REQUEST_DENIED
|
|
The menu driver could not process the request.
|
|
.SH SEE ALSO
|
|
\fBcurses\fP(3), \fBmenu\fP(3).
|
|
.SH NOTES
|
|
The header file \fB<menu.h>\fP automatically includes the header file
|
|
\fB<curses.h>\fP.
|
|
.SH PORTABILITY
|
|
These routines emulate the System V menu library.
|
|
They were not supported on
|
|
Version 7 or BSD versions.
|
|
.SH AUTHORS
|
|
Juergen Pfeifer.
|
|
Manual pages and adaptation for new curses by Eric S. Raymond.
|