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

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