lib/libmenu/menu_item_opts.3

   1 .\"     $NetBSD: menu_item_opts.3,v 1.7 2002/10/01 19:26:59 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_ITEM_OPTS 3
  34 .Os
  35 .Sh NAME
  36 .Nm item_opts ,
  37 .Nm item_opts_off ,
  38 .Nm item_opts_on
  39 .Nd get or modify options for an item
  40 .Sh LIBRARY
  41 .Lb libmenu
  42 .Sh SYNOPSIS
  43 .In menu.h
  44 .Ft OPTIONS
  45 .Fn item_opts "ITEM *item"
  46 .Ft int
  47 .Fn item_opts_off "ITEM *item" "OPTIONS opts"
  48 .Ft int
  49 .Fn item_opts_on "ITEM *item" "OPTIONS opts"
  50 .Sh DESCRIPTION
  51 The
  52 .Fn item_opts
  53 function returns the options currently set for the given item.
  54 The
  55 .Fn item_opts_off
  56 function turns off the options passed in
  57 .Fa opts
  58 for the item passed.
  59 The
  60 .Fn item_opts_on
  61 function turns on the options passed in
  62 .Fa opts
  63 for the item given.
  64 .Sh RETURN VALUES
  65 The functions return one of the following error values:
  66 .Pp
  67 .Bl -tag -width E_SYSTEM_ERROR -compact
  68 .It Er E_OK
  69 The function was successful.
  70 .It Er E_SYSTEM_ERROR
  71 There was a system error during the call.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr curses 3 ,
  75 .Xr menus 3
  76 .Sh NOTES
  77 The header
  78 .Pa \*[Lt]menu.h\*[Gt]
  79 automatically includes both
  80 .Pa \*[Lt]curses.h\*[Gt]
  81 and
  82 .Pa \*[Lt]eti.h\*[Gt] .