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