X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmitem_value.3x;h=106c3ff01061b0275f075abdaefef8266987628e;hp=7738767bfceb2cb9485692c6404ca0d2683b5b96;hb=d448186ac240901c6976dc74c260f052d3ed53e4;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c diff --git a/man/mitem_value.3x b/man/mitem_value.3x index 7738767b..106c3ff0 100644 --- a/man/mitem_value.3x +++ b/man/mitem_value.3x @@ -1,7 +1,35 @@ -'\" t +.\"*************************************************************************** +.\" Copyright (c) 1998-2006,2010 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.9 2010/07/31 16:08:48 tom Exp $ .TH mitem_value 3X "" .SH NAME -\fBmitem_value\fR - set and get menu item values +\fBmitem_value\fR \- set and get menu item values .SH SYNOPSIS \fB#include \fR .br @@ -11,23 +39,23 @@ 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 +\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 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR +.B E_SYSTEM_ERROR System error occurred (see \fBerrno\fR). .TP 5 -\fBE_REQUEST_DENIED\fR +.B E_REQUEST_DENIED The menu driver could not process the request. .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X).