summaryrefslogtreecommitdiff
path: root/lib/libmenu/mitem_opts.3
diff options
context:
space:
mode:
authorNicholas Marriott <nicm@cvs.openbsd.org>2010-01-12 23:22:15 +0000
committerNicholas Marriott <nicm@cvs.openbsd.org>2010-01-12 23:22:15 +0000
commit6ee254699bf787d78835419be2b3241fb037d444 (patch)
tree07fe67dab517e4990f344fe2c00e65cef4d25b81 /lib/libmenu/mitem_opts.3
parent0b62f5dc36fc7203a74cdc812c4234ae188fdfd2 (diff)
Update to ncurses 5.7, with local changes reapplied.
This is around eight years worth of changes (previously we were around ncurses 5.2), too many to list - many bug fixes and also a few new functions. A major bump for libcurses, libpanel, libform and libmenu. ok deraadt
Diffstat (limited to 'lib/libmenu/mitem_opts.3')
-rw-r--r--lib/libmenu/mitem_opts.326
1 files changed, 13 insertions, 13 deletions
diff --git a/lib/libmenu/mitem_opts.3 b/lib/libmenu/mitem_opts.3
index 714937a0ea7..0dfc691d84d 100644
--- a/lib/libmenu/mitem_opts.3
+++ b/lib/libmenu/mitem_opts.3
@@ -1,8 +1,8 @@
'\" t
-.\" $OpenBSD: mitem_opts.3,v 1.5 1999/05/12 13:26:49 aaron Exp $
+.\" $OpenBSD: mitem_opts.3,v 1.6 2010/01/12 23:22:08 nicm Exp $
.\"
.\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc. *
+.\" Copyright (c) 1998-2006,2007 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 *
@@ -29,43 +29,43 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $From: mitem_opts.3x,v 1.6 1998/11/29 01:12:37 Rick.Ohnemus Exp $
+.\" $Id: mitem_opts.3,v 1.6 2010/01/12 23:22:08 nicm Exp $
.TH mitem_opts 3 ""
.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, 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(3), \fBmenu\fR(3).