X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_value.3x;h=0677301f083373e9294296febc21dab65b553b8f;hb=da409f83dde1caedbb9c84acaf5943275e60e0e0;hp=a18a014cc3228d5646abdb77ab49eb6f7c712805;hpb=661078ddbde3ce0f3b06e95642fbb9b5fef7dca1;p=ncurses.git diff --git a/man/mitem_value.3x b/man/mitem_value.3x index a18a014c..0677301f 100644 --- a/man/mitem_value.3x +++ b/man/mitem_value.3x @@ -1,48 +1,73 @@ -.'" $Id: mitem_value.3x,v 1.3 1997/12/06 22:07:49 tom Exp $ +.\"*************************************************************************** +.\" Copyright 2018-2021,2022 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.18 2022/02/12 20:02:20 tom Exp $ .TH mitem_value 3X "" .SH NAME -\fBmitem_value\fR - set and get menu item values +\fBset_item_value\fP, +\fBitem_value\fP \- set and get menu item values .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_item_value(ITEM *\fIitem\fB, bool \fIvalue\fB);\fR .br -int set_item_value(ITEM *item, bool value); -.br -bool item_value(const ITEM *item); +\fBbool item_value(const ITEM *\fIitem\fB);\fR .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 +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(3X)), the menu becomes multi-valued; that is, more than one item may simultaneously be selected. - -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). +.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\fR returns one of the following: +The function \fBset_item_value\fP returns one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fP(3)). .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). +\fBcurses\fP(3X), \fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +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. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.