X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmitem_value.3x;h=3dc20f1a3c4ffbde7b43cf3a12bef5ff55f2316e;hp=5817d8d277b6b919517e83ff0d4ae70fb300775e;hb=42259b594b5dabd37fe2bc294051d2db82e873a2;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/mitem_value.3x b/man/mitem_value.3x index 5817d8d2..3dc20f1a 100644 --- a/man/mitem_value.3x +++ b/man/mitem_value.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2002 Free Software Foundation, Inc. * +.\" 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 * @@ -26,36 +27,37 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_value.3x,v 1.6 2002/02/16 22:40:59 tom Exp $ +.\" $Id: mitem_value.3x,v 1.15 2020/10/17 23:53:24 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 +.sp +\fBint set_item_value(ITEM *\fP\fIitem\fP\fB, bool \fP\fIvalue\fP\fB);\fP .br -int set_item_value(ITEM *item, bool value); -.br -bool item_value(const ITEM *item); +\fBbool item_value(const ITEM *\fP\fIitem\fP\fB);\fP .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 -\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\fR(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). @@ -63,14 +65,9 @@ The menu driver could not process the request. The header file \fB\fR automatically includes the header file \fB\fR. .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.