lib/libmenu/menu_win.3

   1 .\"     $NetBSD: menu_win.3,v 1.9 2002/10/01 19:27:00 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_WIN 3
  34 .Os
  35 .Sh NAME
  36 .Nm menu_sub ,
  37 .Nm menu_win ,
  38 .Nm scale_menu ,
  39 .Nm set_menu_sub ,
  40 .Nm set_menu_win
  41 .Nd sub-menu handling
  42 .Sh LIBRARY
  43 .Lb libmenu
  44 .Sh SYNOPSIS
  45 .In menu.h
  46 .Ft WINDOW *
  47 .Fn menu_sub "MENU *menu"
  48 .Ft WINDOW *
  49 .Fn menu_win "MENU *menu"
  50 .Ft int
  51 .Fn scale_menu "MENU *menu" "int *rows" "int *cols"
  52 .Ft int
  53 .Fn set_menu_sub "MENU *menu" "WINDOW *sub"
  54 .Ft int
  55 .Fn set_menu_win "MENU *menu" "WINDOW *win"
  56 .Sh DESCRIPTION
  57 The
  58 .Fn menu_sub
  59 function returns a pointer to the window that will be used to post a
  60 menu into, this pointer is set by the
  61 .Fn set_menu_sub
  62 function.
  63 The
  64 .Fn menu_win
  65 function returns a pointer to the window in which the menu subwindow
  66 will be created when the menu is posted, this pointer is set by the
  67 .Fn set_menu_win
  68 function.
  69 The
  70 .Fn scale_menu
  71 function calculates the minimum size a window needs to be to hold the
  72 items for a given menu, the parameters rows and cols are set to the
  73 required number of rows and columns respectively.
  74 .Sh RETURN VALUES
  75 The functions return one of the following error values:
  76 .Pp
  77 .Bl -tag -width E_UNKNOWN_COMMAND -compact
  78 .It Er E_OK
  79 The function was successful.
  80 .It Er E_SYSTEM_ERROR
  81 There was a system error during the call.
  82 .It Er E_BAD_ARGUMENT
  83 One or more of the arguments passed to the function was incorrect.
  84 .It Er E_POSTED
  85 The menu is already posted.
  86 .It Er E_CONNECTED
  87 An item was already connected to a menu.
  88 .It Er E_BAD_STATE
  89 The function was called from within an initialization or termination
  90 routine.
  91 .It Er E_NO_ROOM
  92 The menu does not fit within the subwindow.
  93 .It Er E_NOT_POSTED
  94 The menu is not posted
  95 .It Er E_UNKNOWN_COMMAND
  96 The menu driver does not recognize the request passed to it.
  97 .It Er E_NO_MATCH
  98 The character search failed to find a match.
  99 .It Er E_NOT_SELECTABLE
 100 The item could not be selected.
 101 .It Er E_NOT_CONNECTED
 102 The item is not connected to a menu.
 103 .It Er E_REQUEST_DENIED
 104 The menu driver could not process the request.
 105 .El
 106 .Sh SEE ALSO
 107 .Xr curses 3 ,
 108 .Xr menus 3
 109 .Sh NOTES
 110 The header
 111 .Pa \*[Lt]menu.h\*[Gt]
 112 automatically includes both
 113 .Pa \*[Lt]curses.h\*[Gt]
 114 and
 115 .Pa \*[Lt]eti.h\*[Gt] .