lib/libncurses/man/mitem_opts.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: mitem_opts.3x,v 1.12 2015/12/05 23:42:45 tom Exp $
  31 .TH mitem_opts 3X ""
  32 .SH NAME
  33 \fBset_item_opts\fP,
  34 \fBitem_opts_on\fP,
  35 \fBitem_opts_off\fP,
  36 \fBitem_opts\fR \- set and get menu item options
  37 .SH SYNOPSIS
  38 \fB#include <menu.h>\fR
  39 .br
  40 int set_item_opts(ITEM *item, Item_Options opts);
  41 .br
  42 int item_opts_on(ITEM *item, Item_Options opts);
  43 .br
  44 int item_opts_off(ITEM *item, Item_Options opts);
  45 .br
  46 Item_Options item_opts(const ITEM *item);
  47 .br
  48 .SH DESCRIPTION
  49 The function \fBset_item_opts\fR sets all the given item's option bits (menu
  50 option bits may be logically-OR'ed together).
  51 .PP
  52 The function \fBitem_opts_on\fR turns on the given option bits, and leaves
  53 others alone.
  54 .PP
  55 The function \fBitem_opts_off\fR turns off the given option bits, and leaves
  56 others alone.
  57 .PP
  58 The function \fBitem_opts\fR returns the item's current option bits.
  59 .PP
  60 There is only one defined option bit mask, \fBO_SELECTABLE\fR.  When this is
  61 on, the item may be selected during menu processing.  This option defaults
  62 to on.
  63 .SH RETURN VALUE
  64 Except for \fBitem_opts\fR, each routine returns one of the following:
  65 .TP 5
  66 .B E_OK
  67 The routine succeeded.
  68 .TP 5
  69 .B E_SYSTEM_ERROR
  70 System error occurred (see \fBerrno\fR).
  71 .SH SEE ALSO
  72 \fBcurses\fR(3X), \fBmenu\fR(3X).
  73 .SH NOTES
  74 The header file \fB<menu.h>\fR automatically includes the header file
  75 \fB<curses.h>\fR.
  76 .SH PORTABILITY
  77 These routines emulate the System V menu library.  They were not supported on
  78 Version 7 or BSD versions.
  79 .SH AUTHORS
  80 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  81 S. Raymond.