lib/libmenu/menu_items.3

   1 .\"     $NetBSD: menu_items.3,v 1.8 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_ITEMS 3
  34 .Os
  35 .Sh NAME
  36 .Nm item_count ,
  37 .Nm menu_items ,
  38 .Nm set_menu_items
  39 .Nd attach items to menus or check correspondences
  40 .Sh LIBRARY
  41 .Lb libmenu
  42 .Sh SYNOPSIS
  43 .In menu.h
  44 .Ft int
  45 .Fn item_count "MENU *menu"
  46 .Ft ITEMS **
  47 .Fn menu_items "MENU *menu"
  48 .Ft int
  49 .Fn set_menu_items "MENU *menu" "ITEM **items"
  50 .Sh DESCRIPTION
  51 The
  52 .Fn item_count
  53 .Fa menu
  54 function returns the number of items currently attached to the menu
  55 passed.
  56 The
  57 .Fn menu_items
  58 function returns a pointer to an array of item pointers that represent
  59 the menu items currently attached to the given menu.
  60 Apart from using
  61 .Fn new_menu
  62 (see
  63 .Xr menu_new 3 )
  64 menu items may be attached to a menu by calling
  65 .Fn set_menu_items
  66 any items currently attached to the menu will be detached and the NULL
  67 terminated array of new items will be attached to the menu.
  68 .Sh RETURN VALUES
  69 Any function returning a string pointer will return NULL if an error
  70 occurs.
  71 Functions returning an integer will return one of the following:
  72 .Pp
  73 .Bl -tag -width E_CONNECTED -compact
  74 .It Er E_OK
  75 The function was successful.
  76 .It Er E_POSTED
  77 The menu is already posted.
  78 .It Er E_CONNECTED
  79 An item was already connected to a menu.
  80 .El
  81 .Sh SEE ALSO
  82 .Xr curses 3 ,
  83 .Xr menus 3
  84 .Sh NOTES
  85 The header
  86 .Pa \*[Lt]menu.h\*[Gt]
  87 automatically includes both
  88 .Pa \*[Lt]curses.h\*[Gt]
  89 and
  90 .Pa \*[Lt]eti.h\*[Gt] .