X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_opts.3x;h=0c14c252f441ee26f7101ac9621d80fa4bf3f55a;hb=5fa28d9ac15ff11842cdd1375df3bf3ce1112cb7;hp=c430d9b783f8b4641fae85278099a66a5a12361e;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c;p=ncurses.git diff --git a/man/mitem_opts.3x b/man/mitem_opts.3x index c430d9b7..0c14c252 100644 --- a/man/mitem_opts.3x +++ b/man/mitem_opts.3x @@ -1,55 +1,81 @@ -'\" t -.TH mitem_opts 3X "" +.\"*************************************************************************** +.\" Copyright 2018-2022,2023 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_opts.3x,v 1.31 2023/11/25 13:58:47 tom Exp $ +.TH mitem_opts 3X 2023-11-25 "ncurses 6.4" "Library calls" .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\fP \- +set and get menu item options .SH SYNOPSIS -\fB#include \fR -.br -int set_item_opts(ITEM *item, OPTIONS opts); -.br -int item_opts_on(ITEM *item, OPTIONS opts); -.br -int item_opts_off(ITEM *item, OPTIONS opts); -.br -OPTIONS item_opts(const ITEM *item); -.br +.nf +\fB#include +.PP +\fBint set_item_opts(ITEM *\fIitem\fP, Item_Options \fIopts\fP); +\fBItem_Options item_opts(const ITEM *\fIitem\fP); +.PP +\fBint item_opts_on(ITEM *\fIitem\fP, Item_Options \fIopts\fP); +\fBint item_opts_off(ITEM *\fIitem\fP, Item_Options \fIopts\fP); +.fi .SH DESCRIPTION -The function \fBset_item_opts\fR sets all the given item's option bits (menu +The function \fBset_item_opts\fP sets all the given item's option bits (menu option bits may be logically-OR'ed together). - -The function \fBitem_opts_on\fR turns on the given option bits, and leaves +.PP +The function \fBitem_opts_on\fP turns on the given option bits, and leaves others alone. - -The function \fBitem_opts_off\fR turns off the given option bits, and leaves +.PP +The function \fBitem_opts_off\fP turns off the given option bits, and leaves others alone. - -The function \fBitem_opts\fR returns the item's current option bits. - -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 +.PP +The function \fBitem_opts\fP returns the item's current option bits. +.PP +There is only one defined option bit mask, \fBO_SELECTABLE\fP. 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: +Except for \fBitem_opts\fP, each routine 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). -.SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). -.SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fP(3)). .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. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X)