doc/html/man/mitem_opts.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2020,2021 Thomas E. Dickey                                *
   5   * Copyright 1998-2010,2015 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: mitem_opts.3x,v 1.18 2021/12/25 21:49:32 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>mitem_opts 3x</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">mitem_opts 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>                                                  <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>set_item_opts</STRONG>,  <STRONG>item_opts_on</STRONG>,  <STRONG>item_opts_off</STRONG>,  <STRONG>item_opts</STRONG>  - set and get
  52        menu item 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
  58        <STRONG>int</STRONG> <STRONG>set_item_opts(ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>,</STRONG> <STRONG>Item_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  59        <STRONG>Item_Options</STRONG> <STRONG>item_opts(const</STRONG> <STRONG>ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>);</STRONG>
  60
  61        <STRONG>int</STRONG> <STRONG>item_opts_on(ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>,</STRONG> <STRONG>Item_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  62        <STRONG>int</STRONG> <STRONG>item_opts_off(ITEM</STRONG> <STRONG>*</STRONG><EM>item</EM><STRONG>,</STRONG> <STRONG>Item_Options</STRONG> <EM>opts</EM><STRONG>);</STRONG>
  63
  64
  65 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  66        The function <STRONG>set_item_opts</STRONG> sets all the given item's option bits  (menu
  67        option bits may be logically-OR'ed together).
  68
  69        The  function  <STRONG>item_opts_on</STRONG>  turns on the given option bits, and leaves
  70        others alone.
  71
  72        The function <STRONG>item_opts_off</STRONG> turns off the given option bits, and  leaves
  73        others alone.
  74
  75        The function <STRONG>item_opts</STRONG> returns the item's current option bits.
  76
  77        There  is only one defined option bit mask, <STRONG>O_SELECTABLE</STRONG>.  When this is
  78        on, the item may be  selected  during  menu  processing.   This  option
  79        defaults to on.
  80
  81
  82 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  83        Except for <STRONG>item_opts</STRONG>, each routine returns one of the following:
  84
  85        <STRONG>E_OK</STRONG> The routine succeeded.
  86
  87        <STRONG>E_SYSTEM_ERROR</STRONG>
  88             System error occurred (see <STRONG>errno(3)</STRONG>).
  89
  90
  91 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  92        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
  93
  94
  95 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  96        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
  97        <STRONG>&lt;curses.h&gt;</STRONG>.
  98
  99
 100 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 101        These routines emulate the  System  V  menu  library.   They  were  not
 102        supported on Version 7 or BSD versions.
 103
 104
 105 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 106        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 107        Raymond.
 108
 109
 110
 111                                                                 <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
 112 </PRE>
 113 <div class="nav">
 114 <ul>
 115 <li><a href="#h2-NAME">NAME</a></li>
 116 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 117 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 118 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 119 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 120 <li><a href="#h2-NOTES">NOTES</a></li>
 121 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 122 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 123 </ul>
 124 </div>
 125 </BODY>
 126 </HTML>