lib/libmenu/menu_opts.3

   1 .\"     $NetBSD: menu_opts.3,v 1.8 2003/04/16 13:35:11 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1999
   4 .\"     Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
   5 .\"
   6 .\" This code is donated to The NetBSD Foundation by the author.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. The name of the Author may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior written
  18 .\"    permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd September 10, 1999
  33 .Dt MENU_OPTS 3
  34 .Os
  35 .Sh NAME
  36 .Nm menu_opts ,
  37 .Nm menu_opts_off ,
  38 .Nm menu_opts_on ,
  39 .Nm set_menu_opts
  40 .Nd get or modify options for a menu
  41 .Sh LIBRARY
  42 .Lb libmenu
  43 .Sh SYNOPSIS
  44 .In menu.h
  45 .Ft OPTIONS
  46 .Fn menu_opts "MENU *menu"
  47 .Ft int
  48 .Fn menu_opts_off "MENU *menu" "OPTIONS opts"
  49 .Ft int
  50 .Fn menu_opts_on "MENU *menu" "OPTIONS opts"
  51 .Ft int
  52 .Fn set_menu_opts "MENU *menu" "OPTIONS opts"
  53 .Sh DESCRIPTION
  54 The
  55 .Fn menu_opts
  56 function returns the current options set for the menu given.
  57 The
  58 .Fn menu_opts_off
  59 function turns off the menu options given by the opts parameter for
  60 the menu.
  61 The
  62 .Fn menu_opts_on
  63 function turns on the menu options given by the opts parameter for the
  64 menu passed.
  65 The
  66 .Fn set_menu_opts
  67 sets the menu options to the value given in opts.
  68 .Sh RETURN VALUES
  69 The functions return one of the following error values:
  70 .Pp
  71 .Bl -tag -width E_BAD_ARGUMENT -compact
  72 .It Er E_OK
  73 The function was successful.
  74 .It Er E_BAD_ARGUMENT
  75 One or more of the arguments passed to the function was incorrect.
  76 .It Er E_POSTED
  77 The menu is already posted.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr curses 3 ,
  81 .Xr menus 3
  82 .Sh NOTES
  83 The header
  84 .Pa \*[Lt]menu.h\*[Gt]
  85 automatically includes both
  86 .Pa \*[Lt]curses.h\*[Gt]
  87 and
  88 .Pa \*[Lt]eti.h\*[Gt] .