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