ncurses 5.7 - patch 20110108
[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-2007,2010 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.11 2010/12/04 18:40:45 tom 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 <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>
50 <H2>NAME</H2><PRE>
51        <STRONG>mitem_opts</STRONG> - set and get menu item options
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        int set_item_opts(ITEM *item, Item_Options opts);
58        int item_opts_on(ITEM *item, Item_Options opts);
59        int item_opts_off(ITEM *item, Item_Options opts);
60        Item_Options item_opts(const ITEM *item);
61
62
63 </PRE>
64 <H2>DESCRIPTION</H2><PRE>
65        The  function  <STRONG>set_item_opts</STRONG>  sets  all  the  given item's
66        option bits  (menu  option  bits  may  be  logically-OR'ed
67        together).
68
69        The  function <STRONG>item_opts_on</STRONG> turns on the given option bits,
70        and leaves others alone.
71
72        The function <STRONG>item_opts_off</STRONG>  turns  off  the  given  option
73        bits, and leaves others alone.
74
75        The  function  <STRONG>item_opts</STRONG> returns the item's current option
76        bits.
77
78        There is only one defined option bit  mask,  <STRONG>O_SELECTABLE</STRONG>.
79        When this is on, the item may be selected during menu pro-
80        cessing.  This option defaults to on.
81
82
83 </PRE>
84 <H2>RETURN VALUE</H2><PRE>
85        Except for <STRONG>item_opts</STRONG>, each routine returns one of the fol-
86        lowing:
87
88        <STRONG>E_OK</STRONG> The routine succeeded.
89
90        <STRONG>E_SYSTEM_ERROR</STRONG>
91             System error occurred (see <STRONG>errno</STRONG>).
92
93
94 </PRE>
95 <H2>SEE ALSO</H2><PRE>
96        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
97
98
99 </PRE>
100 <H2>NOTES</H2><PRE>
101        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
102        file <STRONG>&lt;curses.h&gt;</STRONG>.
103
104
105 </PRE>
106 <H2>PORTABILITY</H2><PRE>
107        These routines emulate the System V  menu  library.   They
108        were not supported on Version 7 or BSD versions.
109
110
111 </PRE>
112 <H2>AUTHORS</H2><PRE>
113        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
114        curses by Eric S. Raymond.
115
116
117
118                                                          <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
119 </PRE>
120 <HR>
121 <ADDRESS>
122 Man(1) output converted with
123 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
124 </ADDRESS>
125 </BODY>
126 </HTML>