doc/html/man/menu_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>menu_opts</B> - set and get menu options
   9
  10
  11 </PRE>
  12 <H2>SYNOPSIS</H2><PRE>
  13        <B>#include</B> <B>&lt;menu.h&gt;</B>
  14        int set_menu_opts(MENU *menu, OPTIONS opts);
  15        int menu_opts_on(MENU *menu, OPTIONS opts);
  16        int menu_opts_off(MENU *menu, OPTIONS opts);
  17        OPTIONS menu_opts(const MENU *menu);
  18
  19
  20 </PRE>
  21 <H2>DESCRIPTION</H2><PRE>
  22        The  function  <B>set_menu_opts</B>  sets  all  the  given menu's
  23        option bits  (menu  option  bits  may  be  logically-OR'ed
  24        together).
  25
  26        The  function <B>menu_opts_on</B> turns on the given option bits,
  27        and leaves others alone.
  28
  29        The function <B>menu_opts_off</B>  turns  off  the  given  option
  30        bits, and leaves others alone.
  31
  32        The  function  <B>menu_opts</B> returns the menu's current option
  33        bits.
  34
  35        The following options are defined (all are on by default):
  36
  37        O_ONEVALUE
  38             Only one item can be selected for this menu.
  39
  40        O_SHOWDESC
  41             Display  the  item  descriptions  when  the  menu  is
  42             posted.
  43
  44        O_ROWMAJOR
  45             Display the menu in row-major order.
  46
  47        O_IGNORECASE
  48             Ignore the case when pattern-matching.
  49
  50        O_SHOWMATCH
  51             Move the cursor to within the item  name  while  pat-
  52             tern-matching.
  53
  54        O_NONCYCLIC
  55             Don't   wrap   around  next-item  and  previous-item,
  56             requests to the other end of the menu.
  57
  58
  59 </PRE>
  60 <H2>RETURN VALUE</H2><PRE>
  61        Except for <B>menu_opts</B>, each routine returns one of the fol-
  62        lowing:
  63
  64        <B>E_OK</B> The routine succeeded.
  65
  66
  67        <B>E_SYSTEM_ERROR</B>
  68             System error occurred (see <B>errno</B>).
  69
  70        <B>E_POSTED</B>
  71             The menu is already posted.
  72
  73
  74 </PRE>
  75 <H2>SEE ALSO</H2><PRE>
  76        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
  77
  78
  79 </PRE>
  80 <H2>NOTES</H2><PRE>
  81        The header file <B>&lt;menu.h&gt;</B> automatically includes the header
  82        file <B>&lt;curses.h&gt;</B>.
  83
  84
  85 </PRE>
  86 <H2>PORTABILITY</H2><PRE>
  87        These routines emulate the System V  menu  library.   They
  88        were not supported on Version 7 or BSD versions.
  89
  90
  91 </PRE>
  92 <H2>AUTHORS</H2><PRE>
  93        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
  94        curses by Eric S. Raymond.
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129 </PRE>
 130 <HR>
 131 <ADDRESS>
 132 Man(1) output converted with
 133 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 134 </ADDRESS>
 135 </BODY>
 136 </HTML>