X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_opts.3x;h=105f9de97a42322252805634b23f9d7bec398422;hb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045;hp=99e4e5ea7e99eae2dab7be80d769d0891fc230d8;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;p=ncurses.git diff --git a/man/mitem_opts.3x b/man/mitem_opts.3x index 99e4e5ea..105f9de9 100644 --- a/man/mitem_opts.3x +++ b/man/mitem_opts.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 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 * @@ -27,58 +28,57 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_opts.3x,v 1.6 1998/11/29 01:12:37 Rick.Ohnemus Exp $ +.\" $Id: mitem_opts.3x,v 1.16 2020/10/17 23:52:26 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 +.sp +\fBint set_item_opts(ITEM *\fP\fIitem\fP\fB, Item_Options \fP\fIopts\fP\fB);\fP .br -int set_item_opts(ITEM *item, OPTIONS opts); +\fBItem_Options item_opts(const ITEM *\fP\fIitem\fP\fB);\fP +.sp +\fBint item_opts_on(ITEM *\fP\fIitem\fP\fB, Item_Options \fP\fIopts\fP\fB);\fP .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); +\fBint item_opts_off(ITEM *\fP\fIitem\fP\fB, Item_Options \fP\fIopts\fP\fB);\fP .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 +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 -System error occurred (see \fBerrno\fR). +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X). .SH NOTES 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.