man/mitem_opts.3x

   1 '\" t
   2 .TH mitem_opts 3X ""
   3 .SH NAME
   4 \fBmitem_opts\fR - set and get menu item options
   5 .SH SYNOPSIS
   6 \fB#include <menu.h>\fR
   7 .br
   8 int set_item_opts(ITEM *item, OPTIONS opts);
   9 .br
  10 int item_opts_on(ITEM *item, OPTIONS opts);
  11 .br
  12 int item_opts_off(ITEM *item, OPTIONS opts);
  13 .br
  14 OPTIONS item_opts(const ITEM *item);
  15 .br
  16 .SH DESCRIPTION
  17 The function \fBset_item_opts\fR sets all the given item's option bits (menu
  18 option bits may be logically-OR'ed together).
  19
  20 The function \fBitem_opts_on\fR turns on the given option bits, and leaves
  21 others alone.
  22
  23 The function \fBitem_opts_off\fR turns off the given option bits, and leaves
  24 others alone.
  25
  26 The function \fBitem_opts\fR returns the item's current option bits.
  27
  28 There is only one defined option bit mask, \fBO_SELECTABLE\fR.  When this is
  29 on, the item may be selected during menu processing.  This option defaults
  30 to on.
  31 .SH RETURN VALUE
  32 Except for \fBitem_opts\fR, each routine returns one of the following:
  33 .TP 5
  34 \fBE_OK\fR
  35 The routine succeeded.
  36 .TP 5
  37 \fBE_SYSTEM_ERROR\fR
  38 System error occurred (see \fBerrno\fR).
  39 .SH SEE ALSO
  40 \fBcurses\fR(3X), \fBmenu\fR(3X).
  41 .SH NOTES
  42 The header file \fB<menu.h>\fR automatically includes the header file
  43 \fB<curses.h>\fR.
  44 .SH PORTABILITY
  45 These routines emulate the System V menu library.  They were not supported on
  46 Version 7 or BSD versions.
  47 .SH AUTHORS
  48 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  49 S. Raymond.
  50 .\"#
  51 .\"# The following sets edit modes for GNU EMACS
  52 .\"# Local Variables:
  53 .\"# mode:nroff
  54 .\"# fill-column:79
  55 .\"# End: