diff options
author | Haibo Huang <hhb@google.com> | 2020-11-11 14:24:25 -0800 |
---|---|---|
committer | Haibo Huang <hhb@google.com> | 2020-11-19 21:26:25 +0000 |
commit | 34428ddf7f4f6a0af2285038ea1c9d9fcb108de9 (patch) | |
tree | 54b99fc45d474e7c00bc6d24ccefadc44829984e /man/mitem_value.3x | |
parent | bdbe628af37efefa7dfedd7bc0d734f9d308c11c (diff) | |
download | ncurses-34428ddf7f4f6a0af2285038ea1c9d9fcb108de9.tar.gz |
Initial commit for ncurses 6.2llvm-r450784llvm-r416183
Change-Id: I3c20f7e4763d8f66148d3867eb2d0611027fbdf1
Diffstat (limited to 'man/mitem_value.3x')
-rw-r--r-- | man/mitem_value.3x | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/man/mitem_value.3x b/man/mitem_value.3x new file mode 100644 index 0000000..ddbc0f5 --- /dev/null +++ b/man/mitem_value.3x @@ -0,0 +1,73 @@ +.\"*************************************************************************** +.\" Copyright 2018-2019,2020 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.3x,v 1.14 2020/02/02 23:34:34 tom Exp $ +.TH mitem_value 3X "" +.SH NAME +\fBset_item_value\fP, +\fBitem_value\fP \- set and get menu item values +.SH SYNOPSIS +\fB#include <menu.h>\fR +.br +int set_item_value(ITEM *item, bool value); +.br +bool item_value(const ITEM *item); +.br +.SH DESCRIPTION +If you turn off the menu option \fBO_ONEVALUE\fR (e.g., with +\fBset_menu_opts\fR or \fBmenu_opts_off\fR; see \fBmenu_opts\fR(3X)), 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\fR to select the +given menu item (second argument \fBTRUE\fR) or deselect it (second argument +\fBFALSE\fR). +.SH RETURN VALUE +The function \fBset_item_value\fR returns one of the following: +.TP 5 +.B E_OK +The routine succeeded. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). +.TP 5 +.B E_REQUEST_DENIED +The menu driver could not process the request. +.SH SEE ALSO +\fBcurses\fR(3X), \fBmenu\fR(3X). +.SH NOTES +The header file \fB<menu.h>\fR automatically includes the header file +\fB<curses.h>\fR. +.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. |