X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_opts.3x;h=0c14c252f441ee26f7101ac9621d80fa4bf3f55a;hb=159cd0555e0efc14be66c9c3a1548f58908b6a1d;hp=27459433a4b59671b77a9a37c6745c454875a273;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/mitem_opts.3x b/man/mitem_opts.3x index 27459433..0c14c252 100644 --- a/man/mitem_opts.3x +++ b/man/mitem_opts.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" 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 * @@ -28,53 +27,48 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_opts.3x,v 1.15 2020/02/02 23:34:34 tom Exp $ -.TH mitem_opts 3X "" +.\" $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 \fBset_item_opts\fP, \fBitem_opts_on\fP, \fBitem_opts_off\fP, -\fBitem_opts\fR \- set and get menu item options +\fBitem_opts\fP \- +set and get menu item options .SH SYNOPSIS -\fB#include \fR -.br -int set_item_opts(ITEM *item, Item_Options opts); -.br -int item_opts_on(ITEM *item, Item_Options opts); -.br -int item_opts_off(ITEM *item, Item_Options opts); -.br -Item_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). .PP -The function \fBitem_opts_on\fR turns on the given option bits, and leaves +The function \fBitem_opts_on\fP 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 +The function \fBitem_opts_off\fP turns off the given option bits, and leaves others alone. .PP -The function \fBitem_opts\fR returns the item's current option bits. +The function \fBitem_opts\fP returns the item's current option bits. .PP -There is only one defined option bit mask, \fBO_SELECTABLE\fR. When this is +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 .B E_OK The routine succeeded. .TP 5 .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. +System error occurred (see \fBerrno\fP(3)). .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -82,3 +76,6 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%menu\fP(3X)