lib/libmenu/menu_cursor.3

   1 .\"     $NetBSD: menu_cursor.3,v 1.8 2002/10/01 19:26:58 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_CURSOR 3
  34 .Os
  35 .Sh NAME
  36 .Nm pos_menu_cursor
  37 .Nd position cursor in menu window
  38 .Sh LIBRARY
  39 .Lb libmenu
  40 .Sh SYNOPSIS
  41 .In menu.h
  42 .Ft int
  43 .Fn pos_menu_cursor "MENU *menu"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn pos_menu_cursor
  47 function positions the cursor in the menu window.
  48 This function can be called after other curses calls to restore the cursor
  49 to its correct position in the menu.
  50 .Sh RETURN VALUES
  51 The functions return one of the following error values:
  52 .Pp
  53 .Bl -tag -width E_UNKNOWN_COMMAND -compact
  54 .It Er E_OK
  55 The function was successful.
  56 .It Er E_SYSTEM_ERROR
  57 There was a system error during the call.
  58 .It Er E_BAD_ARGUMENT
  59 One or more of the arguments passed to the function was incorrect.
  60 .It Er E_POSTED
  61 The menu is already posted.
  62 .It Er E_CONNECTED
  63 An item was already connected to a menu.
  64 .It Er E_BAD_STATE
  65 The function was called from within an initialization or termination
  66 routine.
  67 .It Er E_NO_ROOM
  68 The menu does not fit within the subwindow.
  69 .It Er E_NOT_POSTED
  70 The menu is not posted.
  71 .It Er E_UNKNOWN_COMMAND
  72 The menu driver does not recognize the request passed to it.
  73 .It Er E_NO_MATCH
  74 The character search failed to find a match.
  75 .It Er E_NOT_SELECTABLE
  76 The item could not be selected.
  77 .It Er E_NOT_CONNECTED
  78 The item is not connected to a menu.
  79 .It Er E_REQUEST_DENIED
  80 The menu driver could not process the request.
  81 .El
  82 .Sh SEE ALSO
  83 .Xr curses 3 ,
  84 .Xr menus 3
  85 .Sh NOTES
  86 The header
  87 .Pa \*[Lt]menu.h\*[Gt]
  88 automatically includes both
  89 .Pa \*[Lt]curses.h\*[Gt]
  90 and
  91 .Pa \*[Lt]eti.h\*[Gt] .