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

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 1998-2015,2016 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: menu_opts.3x,v 1.35 2024/03/16 15:35:01 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>menu_opts 3x 2024-03-16 ncurses 6.4 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">menu_opts 3x 2024-03-16 ncurses 6.4 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>                    Library calls                   <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>set_menu_opts</STRONG>,  <STRONG>menu_opts_on</STRONG>,  <STRONG>menu_opts_off</STRONG>,  <STRONG>menu_opts</STRONG>  - set and get
  51        menu options
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>set_menu_opts(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  58        <STRONG>Menu_Options</STRONG> <STRONG>menu_opts(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
  59
  60        <STRONG>int</STRONG> <STRONG>menu_opts_on(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  61        <STRONG>int</STRONG> <STRONG>menu_opts_off(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>Menu_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  62
  63
  64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  65        The function <STRONG>set_menu_opts</STRONG> sets all the given menu's option bits  (menu
  66        option bits may be logically-OR'ed together).
  67
  68        The  function  <STRONG>menu_opts_on</STRONG>  turns on the given option bits, and leaves
  69        others alone.
  70
  71        The function <STRONG>menu_opts_off</STRONG> turns off the given option bits, and  leaves
  72        others alone.
  73
  74        The function <STRONG>menu_opts</STRONG> returns the menu's current option bits.
  75
  76        The following options are defined (all are on by default):
  77
  78        O_ONEVALUE
  79             Only one item can be selected for this menu.
  80
  81        O_SHOWDESC
  82             Display the item descriptions when the menu is posted.
  83
  84        O_ROWMAJOR
  85             Display the menu in row-major order.
  86
  87        O_IGNORECASE
  88             Ignore the case when pattern-matching.
  89
  90        O_SHOWMATCH
  91             Move the cursor to within the item name while pattern-matching.
  92
  93        O_NONCYCLIC
  94             Don't  wrap  around  next-item  and previous-item, requests to the
  95             other end of the menu.
  96
  97        O_MOUSE_MENU
  98             If user clicks with  the  mouse  and  it  does  not  fall  on  the
  99             currently  active menu, push <STRONG>KEY_MOUSE</STRONG> and the <STRONG>MEVENT</STRONG> data back on
 100             the queue to allow processing  in  another  part  of  the  calling
 101             program.
 102
 103
 104 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 105        Except for <STRONG>menu_opts</STRONG>, each routine returns one of the following:
 106
 107        <STRONG>E_OK</STRONG> The routine succeeded.
 108
 109        <STRONG>E_SYSTEM_ERROR</STRONG>
 110             System error occurred (see <STRONG>errno(3)</STRONG>).
 111
 112        <STRONG>E_POSTED</STRONG>
 113             The menu is already posted.
 114
 115
 116 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 117        These  routines  emulate  the  System  V  menu  library.  They were not
 118        supported on Version 7 or BSD versions.
 119
 120
 121 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 122        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 123        Raymond.
 124
 125
 126 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 127        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
 128
 129
 130
 131 ncurses 6.4                       2024-03-16                     <STRONG><A HREF="menu_opts.3x.html">menu_opts(3x)</A></STRONG>
 132 </PRE>
 133 <div class="nav">
 134 <ul>
 135 <li><a href="#h2-NAME">NAME</a></li>
 136 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 137 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 138 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 139 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 140 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 141 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 142 </ul>
 143 </div>
 144 </BODY>
 145 </HTML>