X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmitem_opts.3x;h=37913b6b008af96cf17d9264ff6c319c6af3a8cc;hp=c430d9b783f8b4641fae85278099a66a5a12361e;hb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c diff --git a/man/mitem_opts.3x b/man/mitem_opts.3x index c430d9b7..37913b6b 100644 --- a/man/mitem_opts.3x +++ b/man/mitem_opts.3x @@ -1,40 +1,73 @@ '\" t +.\"*************************************************************************** +.\" Copyright (c) 1998-2015,2018 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.13 2018/07/28 21:34:06 tom Exp $ .TH mitem_opts 3X "" .SH NAME -\fBmitem_opts\fR - set and get menu item options +\fBset_item_opts\fP, +\fBitem_opts_on\fP, +\fBitem_opts_off\fP, +\fBitem_opts\fR \- set and get menu item options .SH SYNOPSIS \fB#include \fR .br -int set_item_opts(ITEM *item, OPTIONS opts); +int set_item_opts(ITEM *item, Item_Options opts); .br -int item_opts_on(ITEM *item, OPTIONS opts); +int item_opts_on(ITEM *item, Item_Options opts); .br -int item_opts_off(ITEM *item, OPTIONS opts); +int item_opts_off(ITEM *item, Item_Options opts); .br -OPTIONS item_opts(const ITEM *item); +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. - -The function \fBitem_opts\fR returns the item's current option bits. - +.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 +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 -\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). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). @@ -42,14 +75,9 @@ System error occurred (see \fBerrno\fR). 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.