ncurses 5.7 - patch 20100828
[ncurses.git] / man / mitem_opts.3x
index 99e4e5ea7e99eae2dab7be80d769d0891fc230d8..33895768175aafff51545a6e12ccde41721742db 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: mitem_opts.3x,v 1.6 1998/11/29 01:12:37 Rick.Ohnemus Exp $
+.\" $Id: mitem_opts.3x,v 1.10 2010/07/31 16:08:48 tom Exp $
 .TH mitem_opts 3X ""
 .SH NAME
-\fBmitem_opts\fR - set and get menu item options
+\fBmitem_opts\fR \- set and get menu item options
 .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
-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.
-
+.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
-\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).