ncurses 6.0 - patch 20170304

[ncurses.git] / man / mitem_opts.3x

diff --git a/man/mitem_opts.3x b/man/mitem_opts.3x
index c430d9b783f8b4641fae85278099a66a5a12361e..2ac6c43c75f8ec091175b1975689bf211d56e2aa 100644 (file)
--- a/man/mitem_opts.3x
+++ b/man/mitem_opts.3x
@@ -1,40 +1,72 @@
 '\" t
 '\" t

+.\"***************************************************************************
+.\" Copyright (c) 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.12 2015/12/05 23:42:45 tom Exp $

 .TH mitem_opts 3X ""
 .SH NAME
 .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 <menu.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <menu.h>\fR
 .br

-int set_item_opts(ITEM *item, OPTIONS opts);
+int set_item_opts(ITEM *item, Item_Options opts);

 .br
 .br

-int item_opts_on(ITEM *item, OPTIONS opts);
+int item_opts_on(ITEM *item, Item_Options opts);

 .br
 .br

-int item_opts_off(ITEM *item, OPTIONS opts);
+int item_opts_off(ITEM *item, Item_Options opts);

 .br
 .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).
 .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.
 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_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
 to on.
 .SH RETURN VALUE
 Except for \fBitem_opts\fR, each routine returns one of the following:
 .TP 5
 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

-\fBE_OK\fR
+.B E_OK

 The routine succeeded.
 .TP 5
 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).
 System error occurred (see \fBerrno\fR).
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBmenu\fR(3X).


@@ -47,9 +79,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .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: