mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-27 11:55:06 +00:00
79 lines
3.6 KiB
Plaintext
79 lines
3.6 KiB
Plaintext
'\" t
|
|
.\"***************************************************************************
|
|
.\" Copyright (c) 1998-2007,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_opts.3x,v 1.11 2010/12/04 18:40:45 tom Exp $
|
|
.TH mitem_opts 3X ""
|
|
.SH NAME
|
|
\fBmitem_opts\fR \- set and get menu item options
|
|
.SH SYNOPSIS
|
|
\fB#include <menu.h>\fR
|
|
.br
|
|
int set_item_opts(ITEM *item, Item_Options opts);
|
|
.br
|
|
int item_opts_on(ITEM *item, Item_Options opts);
|
|
.br
|
|
int item_opts_off(ITEM *item, Item_Options opts);
|
|
.br
|
|
Item_Options item_opts(const ITEM *item);
|
|
.br
|
|
.SH DESCRIPTION
|
|
The function \fBset_item_opts\fR sets all the given item's option bits (menu
|
|
option bits may be logically-OR'ed together).
|
|
.PP
|
|
The function \fBitem_opts_on\fR turns on the given option bits, and leaves
|
|
others alone.
|
|
.PP
|
|
The function \fBitem_opts_off\fR turns off the given option bits, and leaves
|
|
others alone.
|
|
.PP
|
|
The function \fBitem_opts\fR returns the item's current option bits.
|
|
.PP
|
|
There is only one defined option bit mask, \fBO_SELECTABLE\fR. When this is
|
|
on, the item may be selected during menu processing. This option defaults
|
|
to on.
|
|
.SH RETURN VALUE
|
|
Except for \fBitem_opts\fR, each routine 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).
|
|
.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.
|