]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/mitem_opts.3x
ncurses 6.4 - patch 20230917
[ncurses.git] / man / mitem_opts.3x
index b7aaff69af1ca2c8b0c8631d44088f692c7f01ca..36ac3062f02889bf6b0b4c6f7ea2d9b2d87e988b 100644 (file)
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
+.\" 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  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: mitem_opts.3x,v 1.14 2019/01/20 20:32:23 tom Exp $
-.TH mitem_opts 3X ""
+.\" $Id: mitem_opts.3x,v 1.25 2023/09/16 23:38:39 tom Exp $
+.TH mitem_opts 3X 2023-09-16 "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 <menu.h>\fR
+\fB#include <menu.h>\fP
+.sp
+\fBint set_item_opts(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\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);
+\fBItem_Options item_opts(const ITEM *\fIitem\fB);\fR
+.sp
+\fBint item_opts_on(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR
 .br
+\fBint item_opts_off(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR
 .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)).
+System error occurred (see \fBerrno\fP(3)).
 .SH SEE ALSO
-\fBcurses\fR(3X), \fBmenu\fR(3X).
+\fBcurses\fP(3X), \fBmenu\fP(3X).
 .SH NOTES
-The header file \fB<menu.h>\fR automatically includes the header file
-\fB<curses.h>\fR.
+The header file \fB<menu.h>\fP automatically includes the header file
+\fB<curses.h>\fP.
 .SH PORTABILITY
 These routines emulate the System V menu library.
 They were not supported on