ncursesw-morphos/man/mitem_value.3x

49 lines
1.4 KiB
Plaintext
Raw Normal View History

1998-03-01 12:21:12 +08:00
.'" $Id: mitem_value.3x,v 1.3 1997/12/06 22:07:49 tom Exp $
1997-05-15 12:00:00 +08:00
.TH mitem_value 3X ""
.SH NAME
\fBmitem_value\fR - 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
1998-03-01 12:21:12 +08:00
\fBset_menu_opts\fR or \fBmenu_opts_off\fR; see \fBmenu_opts\fR(3X)), the menu
1997-05-15 12:00:00 +08:00
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).
.SH RETURN VALUE
The function \fBset_item_value\fR returns one of the following:
.TP 5
\fBE_OK\fR
The routine succeeded.
.TP 5
\fBE_SYSTEM_ERROR\fR
System error occurred (see \fBerrno\fR).
.TP 5
\fBE_REQUEST_DENIED\fR
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.
.\"#
.\"# The following sets edit modes for GNU EMACS
.\"# Local Variables:
.\"# mode:nroff
.\"# fill-column:79
.\"# End: