doc/html/man/menu_opts.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   5   * Copyright 1998-2015,2016 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: menu_opts.3x,v 1.17 2020/02/02 23:34:34 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>menu_opts 3x</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">menu_opts 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>                                                    <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>set_menu_opts</STRONG>,  <STRONG>menu_opts_on</STRONG>,  <STRONG>menu_opts_off</STRONG>,  <STRONG>menu_opts</STRONG>  - set and get
  52        menu options
  53
  54
  55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  57        int set_menu_opts(MENU *menu, Menu_Options opts);
  58        int menu_opts_on(MENU *menu, Menu_Options opts);
  59        int menu_opts_off(MENU *menu, Menu_Options opts);
  60        Menu_Options menu_opts(const MENU *menu);
  61
  62
  63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64        The function <STRONG>set_menu_opts</STRONG> sets all the given menu's option bits  (menu
  65        option bits may be logically-OR'ed together).
  66
  67        The  function  <STRONG>menu_opts_on</STRONG>  turns on the given option bits, and leaves
  68        others alone.
  69
  70        The function <STRONG>menu_opts_off</STRONG> turns off the given option bits, and  leaves
  71        others alone.
  72
  73        The function <STRONG>menu_opts</STRONG> returns the menu's current option bits.
  74
  75        The following options are defined (all are on by default):
  76
  77        O_ONEVALUE
  78             Only one item can be selected for this menu.
  79
  80        O_SHOWDESC
  81             Display the item descriptions when the menu is posted.
  82
  83        O_ROWMAJOR
  84             Display the menu in row-major order.
  85
  86        O_IGNORECASE
  87             Ignore the case when pattern-matching.
  88
  89        O_SHOWMATCH
  90             Move the cursor to within the item name while pattern-matching.
  91
  92        O_NONCYCLIC
  93             Don't  wrap  around  next-item  and previous-item, requests to the
  94             other end of the menu.
  95
  96        O_MOUSE_MENU
  97             If user clicks with the mouse and it does not  fall  on  the  cur-
  98             rently active menu, push <STRONG>KEY_MOUSE</STRONG> and the <STRONG>MEVENT</STRONG> data back on the
  99             queue to allow processing in another part of the calling program.
 100
 101
 102 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 103        Except for <STRONG>menu_opts</STRONG>, each routine returns one of the following:
 104
 105        <STRONG>E_OK</STRONG> The routine succeeded.
 106
 107        <STRONG>E_SYSTEM_ERROR</STRONG>
 108             System error occurred (see <STRONG>errno(3)</STRONG>).
 109
 110        <STRONG>E_POSTED</STRONG>
 111             The menu is already posted.
 112
 113
 114 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 115        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
 116
 117
 118 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 119        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
 120        <STRONG>&lt;curses.h&gt;</STRONG>.
 121
 122
 123 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 124        These  routines  emulate the System V menu library.  They were not sup-
 125        ported on Version 7 or BSD versions.
 126
 127
 128 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 129        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 130        Raymond.
 131
 132
 133
 134                                                                  <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
 135 </PRE>
 136 <div class="nav">
 137 <ul>
 138 <li><a href="#h2-NAME">NAME</a></li>
 139 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 140 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 141 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 142 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 143 <li><a href="#h2-NOTES">NOTES</a></li>
 144 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 145 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 146 </ul>
 147 </div>
 148 </BODY>
 149 </HTML>