ncurses 6.1 - patch 20190121
[ncurses.git] / doc / html / man / mitem_opts.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: mitem_opts.3x,v 1.14 2019/01/20 20:32:23 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>mitem_opts 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">mitem_opts 3x</H1>
43 <PRE>
44 <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>                                                  <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>set_item_opts</STRONG>,  <STRONG>item_opts_on</STRONG>,  <STRONG>item_opts_off</STRONG>,  <STRONG>item_opts</STRONG>  - set and get
51        menu item options
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56        int set_item_opts(ITEM *item, Item_Options opts);
57        int item_opts_on(ITEM *item, Item_Options opts);
58        int item_opts_off(ITEM *item, Item_Options opts);
59        Item_Options item_opts(const ITEM *item);
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The function <STRONG>set_item_opts</STRONG> sets all the given item's option bits  (menu
64        option bits may be logically-OR'ed together).
65
66        The  function  <STRONG>item_opts_on</STRONG>  turns on the given option bits, and leaves
67        others alone.
68
69        The function <STRONG>item_opts_off</STRONG> turns off the given option bits, and  leaves
70        others alone.
71
72        The function <STRONG>item_opts</STRONG> returns the item's current option bits.
73
74        There  is only one defined option bit mask, <STRONG>O_SELECTABLE</STRONG>.  When this is
75        on, the item may be  selected  during  menu  processing.   This  option
76        defaults to on.
77
78
79 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
80        Except for <STRONG>item_opts</STRONG>, each routine returns one of the following:
81
82        <STRONG>E_OK</STRONG> The routine succeeded.
83
84        <STRONG>E_SYSTEM_ERROR</STRONG>
85             System error occurred (see <STRONG>errno(3)</STRONG>).
86
87
88 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
89        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
90
91
92 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
93        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
94        <STRONG>&lt;curses.h&gt;</STRONG>.
95
96
97 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
98        These routines emulate the System V menu library.  They were  not  sup-
99        ported on Version 7 or BSD versions.
100
101
102 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
103        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
104        Raymond.
105
106
107
108                                                                 <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
109 </PRE>
110 <div class="nav">
111 <ul>
112 <li><a href="#h2-NAME">NAME</a></li>
113 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
114 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
115 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
116 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
117 <li><a href="#h2-NOTES">NOTES</a></li>
118 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
119 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
120 </ul>
121 </div>
122 </BODY>
123 </HTML>