ncurses 5.1
[ncurses.git] / doc / html / man / mitem_opts.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>mitem_opts</B> - set and get menu item options
9
10
11 </PRE>
12 <H2>SYNOPSIS</H2><PRE>
13        <B>#include</B> <B>&lt;menu.h&gt;</B>
14        int set_item_opts(ITEM *item, OPTIONS opts);
15        int item_opts_on(ITEM *item, OPTIONS opts);
16        int item_opts_off(ITEM *item, OPTIONS opts);
17        OPTIONS item_opts(const ITEM *item);
18
19
20 </PRE>
21 <H2>DESCRIPTION</H2><PRE>
22        The  function  <B>set_item_opts</B>  sets  all  the  given item's
23        option bits  (menu  option  bits  may  be  logically-OR'ed
24        together).
25
26        The  function <B>item_opts_on</B> turns on the given option bits,
27        and leaves others alone.
28
29        The function <B>item_opts_off</B>  turns  off  the  given  option
30        bits, and leaves others alone.
31
32        The  function  <B>item_opts</B> returns the item's current option
33        bits.
34
35        There is only one defined option bit  mask,  <B>O_SELECTABLE</B>.
36        When this is on, the item may be selected during menu pro-
37        cessing.  This option defaults to on.
38
39
40 </PRE>
41 <H2>RETURN VALUE</H2><PRE>
42        Except for <B>item_opts</B>, each routine returns one of the fol-
43        lowing:
44
45        <B>E_OK</B> The routine succeeded.
46
47        <B>E_SYSTEM_ERROR</B>
48             System error occurred (see <B>errno</B>).
49
50
51 </PRE>
52 <H2>SEE ALSO</H2><PRE>
53        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
54
55
56 </PRE>
57 <H2>NOTES</H2><PRE>
58        The header file <B>&lt;menu.h&gt;</B> automatically includes the header
59        file <B>&lt;curses.h&gt;</B>.
60
61
62 </PRE>
63 <H2>PORTABILITY</H2><PRE>
64        These routines emulate the System V  menu  library.   They
65        were not supported on Version 7 or BSD versions.
66
67
68 </PRE>
69 <H2>AUTHORS</H2><PRE>
70        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
71        curses by Eric S. Raymond.
72
73
74
75 </PRE>
76 <HR>
77 <ADDRESS>
78 Man(1) output converted with
79 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
80 </ADDRESS>
81 </BODY>
82 </HTML>