lib/libncurses/man/menu_opts.3

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998 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: menu_opts.3x,v 1.7 1998/11/29 01:10:21 Rick.Ohnemus Exp $
  31 .\" $DragonFly: src/lib/libncurses/man/menu_opts.3,v 1.1 2005/03/12 19:13:54 eirikn Exp $
  32 .TH menu_opts 3X ""
  33 .SH NAME
  34 \fBmenu_opts\fR - set and get menu options
  35 .SH SYNOPSIS
  36 \fB#include <menu.h>\fR
  37 .br
  38 int set_menu_opts(MENU *menu, OPTIONS opts);
  39 .br
  40 int menu_opts_on(MENU *menu, OPTIONS opts);
  41 .br
  42 int menu_opts_off(MENU *menu, OPTIONS opts);
  43 .br
  44 OPTIONS menu_opts(const MENU *menu);
  45 .br
  46 .SH DESCRIPTION
  47 The function \fBset_menu_opts\fR sets all the given menu's option bits (menu
  48 option bits may be logically-OR'ed together).
  49
  50 The function \fBmenu_opts_on\fR turns on the given option bits, and leaves
  51 others alone.
  52
  53 The function \fBmenu_opts_off\fR turns off the given option bits, and leaves
  54 others alone.
  55
  56 The function \fBmenu_opts\fR returns the menu's current option bits.
  57
  58 The following options are defined (all are on by default):
  59 .TP 5
  60 O_ONEVALUE
  61 Only one item can be selected for this menu.
  62 .TP 5
  63 O_SHOWDESC
  64 Display the item descriptions when the menu is posted.
  65 .TP 5
  66 O_ROWMAJOR
  67 Display the menu in row-major order.
  68 .TP 5
  69 O_IGNORECASE
  70 Ignore the case when pattern-matching.
  71 .TP 5
  72 O_SHOWMATCH
  73 Move the cursor to within the item name while pattern-matching.
  74 .TP 5
  75 O_NONCYCLIC
  76 Don't wrap around next-item and previous-item,
  77 requests to the other end of the menu.
  78 .SH RETURN VALUE
  79 Except for \fBmenu_opts\fR, each routine returns one of the following:
  80 .TP 5
  81 \fBE_OK\fR
  82 The routine succeeded.
  83 .TP 5
  84 \fBE_SYSTEM_ERROR\fR
  85 System error occurred (see \fBerrno\fR).
  86 .TP 5
  87 \fBE_POSTED\fR
  88 The menu is already posted.
  89 .SH SEE ALSO
  90 \fBcurses\fR(3X), \fBmenu\fR(3X).
  91 .SH NOTES
  92 The header file \fB<menu.h>\fR automatically includes the header file
  93 \fB<curses.h>\fR.
  94 .SH PORTABILITY
  95 These routines emulate the System V menu library.  They were not supported on
  96 Version 7 or BSD versions.
  97 .SH AUTHORS
  98 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  99 S. Raymond.
 100 .\"#
 101 .\"# The following sets edit modes for GNU EMACS
 102 .\"# Local Variables:
 103 .\"# mode:nroff
 104 .\"# fill-column:79
 105 .\"# End: